Invoke

This page describes in detail all the different methods that can be used to invoke the SDK.

Invoke manually

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 Shake.configuration properties:

AppDelegate.swift
Shake.configuration.isInvokedByShakeDeviceEvent = true
Shake.configuration.isInvokedByScreenshot = true
Shake.start()

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:

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

Shaking

The default, shaking gesture causes the SDK to pop up.

Button

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.

Taking a screenshot

The SDK will be invoked when testers make 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

Invoke Shake with a one-finger swiping gesture from the right edge of the screen.

Invoke through code

You can invoke SDK through code by calling the Shake.show() method anywhere after Shake.start(), optionally adding bug description or attaching files and/or Metadata. Here’s an example:

AppDelegate.swift
let reportData = ShakeReportData(bugDescription: "Broken UI", attachedFiles: [])
Shake.show(reportData: reportData)

All other data, like Activity history or Black box, is automatically included in every user’s bug report — no additional code required.