This page describes in detail all the different methods that can be used to invoke the SDK.
By default, the SDK is invoked when a user shakes their device. You don't need to code anything.
But if you want to, you can customize that.
Let's look at an example. You want your users to invoke SDK either when they shake their device, or when they take a screenshot. To do that, set true or false for certain configuration properties:
This method also enables you to change the preferred invocation event on-the-go during runtime. Here’s a list of all available ones below, feel free to use any combination of these.
The default, shaking gesture causes the SDK to pop up.
In case you want to test Shake SDK in Android Emulator, it’s useful to know that emulator’s default shaking gesture is too weak to invoke Shake.
Shaking gesture sensitivity can be fine tuned as shown in the snippet below:
In the above example, threshold is reduced a bit, meaning that Shake is a bit easier to invoke with the shaking gesture.
A valid treshold value range is
1 - 1000, with bigger values representing decreased sensitivity meaning that a stronger
motion gesture is required to invoke Shake.
This invocation event will create the floating button on top of your app's UI which users can clearly see at all times. This button can be dragged to a more suitable position.
In the emulator, you might need to click the button twice if one click doesn’t do it. Also, system interface elements may sometimes get in a way of the button.
Taking a screenshot
The SDK will be invoked when users make a screenshot while using your app.
The only way for any SDK to realize that a screenshot has been captured is to monitor the screenshots directory. Because of that, if you opt for this invocation method, the storage permission will be requested from a user when they launch your app.
Right Edge Pan
Invoke Shake with a one-finger swiping gesture from the right edge of the screen.
The right edge pan gesture won’t work if performed over a ListView or ScrollView. You can use one of the alternative ways to invoke Shake instead.
Invoke through code
You can invoke SDK through code by calling the
Shake.show method anywhere after
show method can also be called with the argument
ShakeScreen which determines the first presented screen in the Shake UI. Default value
When Shake is invoked with the
ShakeScreen.NEW, app screenshot and automatic video recording are automatically attached and visible
in the attached files section of the UI.