Shake class
Interface for using Shake SDK.
Constructors
- Shake()
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
clearMetadata(
) → Future< void> - Clears existing metadata.
-
getDefaultScreen(
) → Future< ShakeScreen> - Get screen top open when Shake is manually invoked.
-
getShakeForm(
) → Future< ShakeForm?> - Gets shake form for the new ticket screen.
-
getShakingThreshold(
) → Future< int?> - Checks what value shaking threshold is set on
-
getShowIntroMessage(
) → Future< bool?> - Checks if intro message is shown on start.
-
insertNetworkRequest(
NetworkRequest networkRequest) → Future< void> - Inserts network request to the activity history.
-
insertNotificationEvent(
NotificationEvent notificationEvent) → Future< void> - Inserts notification event to the activity history.
-
isAutoVideoRecording(
) → Future< bool?> - Checks if automatic video recording is enabled.
-
isConsoleLogsEnabled(
) → Future< bool?> - Checks if console logs are attached to the tickets.
-
isEnableActivityHistory(
) → Future< bool?> - Checks if activity history events are tracked.
-
isEnableBlackBox(
) → Future< bool?> - Checks if black-box is enabled.
-
isInvokeShakeOnScreenshot(
) → Future< bool?> - Checks if screenshot invoking is enabled.
-
isInvokeShakeOnShakeDeviceEvent(
) → Future< bool?> - Checks if shake gesture invoking is enabled.
-
isScreenshotIncluded(
) → Future< bool?> - Checks if screenshot is included in report
-
isSensitiveDataRedactionEnabled(
) → Future< bool?> - Checks if automatic sensitive data redaction is enabled.
-
isShowFloatingReportButton(
) → Future< bool?> - Checks if floating report button is visible.
-
isUserFeedbackEnabled(
) → Future< bool?> - Checks if user feedback is enabled.
-
log(
LogLevel logLevel, String message) → Future< void> - Adds custom log into the activity history.
-
registerUser(
String userId) → Future< void> - Registers new Shake user.
-
setAutoVideoRecording(
bool enabled) → Future< void> - Sets if automatic video recording is enabled.
-
setConsoleLogsEnabled(
bool enabled) → Future< void> - Sets if console logs are attached to the tickets.
-
setDefaultScreen(
ShakeScreen shakeScreen) → Future< void> - Sets screen to open when Shake is manually invoked.
-
setEnableActivityHistory(
bool enabled) → Future< void> - Sets if activity history events are tracked.
-
setEnableBlackBox(
bool enabled) → Future< void> - Sets if black-box is enabled.
-
setHomeActions(
List< ShakeBaseAction> homeActions) → Future<void> - Sets shake home screen subtitle.
-
setHomeSubtitle(
String subtitle) → Future< void> - Sets shake home screen subtitle.
-
setInvokeShakeOnScreenshot(
bool enabled) → Future< void> - Sets if screenshot invoking is enabled.
-
setInvokeShakeOnShakeDeviceEvent(
bool enabled) → Future< void> - Sets if shake gesture invoking is enabled.
-
setMetadata(
String key, String value) → Future< void> - Adds metadata to the new tickets.
-
setNetworkRequestsFilter(
NetworkRequestFilter? filter) → Future< void> - Sets filter for network requests.
-
setNotificationEventsFilter(
NotificationEventFilter? filter) → Future< void> - Sets filter for notification events.
-
setPushNotificationsToken(
String? token) → Future< void> - Sets token used to send push notifications (Only Android).
-
setScreenshotIncluded(
bool enabled) → Future< void> - Sets screenshot included in report
-
setSensitiveDataRedactionEnabled(
bool enabled) → Future< void> - Sets if automatic sensitive data redaction is enabled.
-
setShakeDismissListener(
Function? listener) → void - Sets Shake dismiss event listener.
-
setShakeForm(
ShakeForm? shakeForm) → Future< void> - Sets shake form for the new ticket screen.
-
setShakeOpenListener(
Function? listener) → void - Sets Shake open event listener.
-
setShakeReportData(
List< ShakeFile> shakeFiles) → Future<void> - Sets files which will be attached with a ticket.
-
setShakeSubmitListener(
dynamic listener(String, Map< String, String> )?) → void - Sets Shake submit event listener.
-
setShakeTheme(
ShakeTheme shakeTheme) → Future< void> - Sets shake theme for the Shake UI.
-
setShakingThreshold(
int shakingThreshold) → Future< void> - Sets shaking threshold
-
setShowFloatingReportButton(
bool enabled) → Future< void> - Sets if floating report button is visible.
-
setShowIntroMessage(
bool enabled) → Future< void> - Sets if intro message is shown on start.
-
setTags(
List< String> tags) → Future<void> - Sets ticket tags.
-
setUnreadMessagesListener(
UnreadMessagesListener? listener) → Future< void> - Sets unread chat messages number listener.
-
setUserFeedbackEnabled(
bool enabled) → Future< void> - Sets if user feedback is enabled.
-
show(
[dynamic shakeScreen = ShakeScreen.newTicket]) → Future< void> - Shows Shake screen.
-
showChatNotification(
Map< String, dynamic> data) → Future<void> - Shows Firebase chat notification (Only Android).
-
showNotificationsSettings(
) → Future< void> - Shows notifications settings screen.
-
silentReport(
{ShakeReportConfiguration? configuration, String? description, List< ShakeFile> ? shakeFiles}) → Future<void> - Sends a ticket without showing Shake screen.
-
start(
String clientID, String clientSecret) → Future< void> - Initializes Shake.
-
unregisterUser(
) → Future< void> - Unregister current Shake user.
-
updateUserId(
String userId) → Future< void> - Updates existing Shake user id.
-
updateUserMetadata(
Map< String, String?> metadata) → Future<void> - Updates existing Shake user metadata.