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:

main.dart
Shake.setInvokeShakeOnShakeDeviceEvent(true);
Shake.setInvokeShakeOnScreenshot(true);
Shake.start('app-api-key');

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:

main.dart
Shake.setInvokeShakeOnShakeDeviceEvent(true);
Shake.setInvokeShakeOnScreenshot(true);
Shake.setShowFloatingReportButton(true);

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

main.dart
import 'package:shake_flutter/shake_flutter.dart';
import 'package:shake_flutter/enums/shake_screen.dart';


Shake.setDefaultScreen(ShakeScreen.newTicket);
Shake.setDefaultScreen(ShakeScreen.home);
Shake.setDefaultScreen(ShakeScreen.chat);

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.

note

If you are testing Shake SDK on your computer, keep in mind that the Android Emulator’s "shaking gesture" is too weak to invoke Shake. You can decrease Shake's threshold as described below, or use another invocation method.

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

main.dart
Shake.setShakingThreshold(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.

note

In the Android Emulator, you might need to click the button twice if one click doesn’t do it. Also, system interface elements may sometimes get in the way of the button.

Taking a screenshot​

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

note

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, storage permission will be requested from a user when they launch 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.

Invoke through code​

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

The show method can be called with the argument ShakeScreen which determines the first presented screen in the Shake UI. The default value is ShakeScreen.newTicket.

main.dart
import 'package:shake_flutter/shake_flutter.dart';
import 'package:shake_flutter/enums/shake_screen.dart';


void onReportProblemPressed() { 
    // Displays Shake with the New Ticket screen.
    Shake.show();
}


const onFeedbackCenterPressed() { 
    // Displays Shake starting at the Home screen.
    Shake.show(ShakeScreen.home);
}


void onStartChatPressed() {
    // Displays Shake empty chat screen.
    Shake.show(ShakeScreen.chat);
}

If an auto screenshot and auto screen recording are enabled, when you call ShakeScreen.newTicket 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.