Skip to main content

Invoke

Decide how you want Shake user feedback to be invoked.

Invoke manually​

By default, Shake user feedback is invoked when a user shakes their device. You don't need to code anything:

Open Shake New ticket screen

But if you want to, you can customize that.

Let's look at an example where you want Shake user feedback to be invoked either when your users shake their device or when they take a screenshot:

AppDelegate.swift
Shake.configuration.isInvokedByShakeDeviceEvent = true
Shake.configuration.isInvokedByScreenshot = true
Shake.start(clientId: "your-api-client-id", clientSecret: "your-api-client-secret")

You can also change the preferred invocation event on-the-fly during runtime. Here’s a list of all available options. Feel free to use any combination of these:

AppDelegate.swift
Shake.configuration.isInvokedByShakeDeviceEvent = true
Shake.configuration.isFloatingReportButtonShown = true
Shake.configuration.isInvokedByScreenshot = true
Shake.configuration.isInvokedByRightEdgePan = true

Also, feel free to change which Shake screen is shown when Shake user feedback is invoked manually:

AppDelegate.swift
Shake.configuration.defaultShowOption = .new
Shake.configuration.defaultShowOption = .home
Shake.configuration.defaultShowOption = .newChat

If you are showing Shake chat screen, make sure that you have registered your app user. Otherwise Shake home screen will be shown.

Shaking gesture​

By default, the shaking gesture opens Shake user feedback.

The shaking threshold can be fine-tuned too. Let's decrease it, for example, so that Shake user feedback is easier to invoke:

AppDelegate.swift
Shake.configuration.shakingThreshold = 400 // Default value is 600.

A valid threshold value range is 1 - 1000. Higher values represent higher thresholds, meaning that a stronger motion gesture will be required to invoke Shake user feedback.

Floating button​

This invocation event creates a floating button on top of your app's UI which your users will be able to see and drag around the screen at all times.

Taking a screenshot​

Shake user feedback will be invoked when your user takes a screenshot while using your app.

note

App Store rejects apps that get in the way of the default screenshot behavior. For that reason, don't use this invocation method in your production releases.

Right edge pan​

Shake user feedback will be invoked with a one-finger swiping gesture from the right edge of the screen.

Invoke through code​

Invoke Shake user feedback through code by calling the Shake.show method anywhere after Shake.start.

The show method can also be called with the argument SHKShowOption which determines the first presented screen in the Shake UI.

SettingsVM.swift
Shake.show(.new)
Shake.show(.home)
Shake.show(.newChat)

If an auto screenshot and auto screen recording are enabled, when you call SHKShowOptionNew they will be automatically attached to a ticket.

If enabled, activity history, black box and all other data are also automatically attached. No additional code is required.

If you are showing Shake chat screen, make sure that you have registered your app user. Otherwise Shake home screen will be shown.