DevRev class
An entry point to the DevRev SDK. The class exposes functions to interact with the DevRev SDK functionality. Certain features might require prior user identification before being called, make sure you have triggered the appropriate identification method before calling the features.
Constructors
- DevRev()
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 Properties
-
areOnDemandSessionsEnabled
→ Future<
bool?> -
A flag that denotes whether the on-demand session enabled.
no setter
-
isConfigured
→ Future<
bool?> -
A flag that denotes whether the SDK is configured.
no setter
-
isMonitoring
→ Future<
bool?> -
A flag that denotes whether the SDK is monitoring.
no setter
-
isRecording
→ Future<
bool?> -
A flag that denotes whether the SDK is recording.
no setter
- isSDKConfigured → bool
-
Checks if the DevRev SDK is configured.
isConfigured isn't returning the correct value in some cases,
so we maintain our own flag to track configuration state.
no setter
-
isUserIdentified
→ Future<
bool?> -
A flag that denotes whether the user is identified.
no setter
Static Methods
-
addSessionProperties(
Map< String, String> properties) → Future<void> - Adds properties to the session. The properties will be sent along any analytic events.
-
captureError(
Object error, String tag) → Future< void> - Captures an error or exception with an exception tag.
-
clearSessionProperties(
) → Future< void> - Clears the session properties.
-
configure(
String appID) → Future< void> - Configures the SDK with the app ID.
-
createSupportConversation(
) → Future< void> - Creates a new support conversation and presents it modally.
-
endTimer(
String name, Map< String, String> properties) → Future<void> - Ends a previously started timer.
-
identifyAnonymousUser(
String userID) → Future< void> - Identifies an anonymous user after the SDK has been configured.
-
identifyUnverifiedUser(
String userID, String? organizationID) → Future< void> - Identifies a non-verified user after the SDK has been configured.
-
identifyVerifiedUser(
String userID, String sessionToken) → Future< void> - Identifies a verified user after the SDK has been configured.
-
logout(
String deviceID) → Future< void> - Logs out the current identified user and resets the session. The process will also unregister the user's device from receiving push notifications, and stop any ongoing session recording.
-
pauseRecording(
) → Future< void> - Pauses the ongoing user recording session.
-
pauseUserInteractionTracking(
) → Future< void> - Pauses user interaction tracking.
-
processAllOnDemandSessions(
) → Future< void> - Processes all on-demand sessions.
-
processPushNotification(
String payload) → Future< void> - Processes the push notification and performs the necessary actions.
-
registerDeviceToken(
String deviceToken, String deviceID) → Future< void> - Registers the device token provided by the native platform for receiving push notifications from DevRev.
-
resumeAllMonitoring(
) → Future< void> - Sets a flag that resumes the session monitoring.
-
resumeRecording(
) → Future< void> - Resumes a paused recording session.
-
resumeUserInteractionTracking(
) → Future< void> - Resumes user interaction tracking.
-
setInAppLinkHandler(
[void handler(String url)?]) → Future< void> - An optional in app links handler for external URLs, deeplinks, etc. in the PLuG support widget.
-
setInScreenTransitioning(
bool value) → Future< void> - Sets the screen transition state of the application.
-
setPrefersSystemTheme(
bool value) → Future< void> - Sets a flag uses the default theme for the support feature.
-
setShouldDismissModalsOnOpenLink(
bool value) → Future< void> - Sets a flag that controls whether the modals should be dismissed after an in-app link is opened.
-
showSupport(
{bool isAnimated = true}) → Future< void> - Presents the support feature modally.
-
startRecording(
) → Future< void> - Starts a user session recording.
-
startTimer(
String name, Map< String, String> properties) → Future<void> - Starts a timer at any point in the app in order to measure time metrics for events such as load or response time.
-
stopAllMonitoring(
) → Future< void> - Sets a flag that stops all session monitoring.
-
stopRecording(
) → Future< void> - Stops an ongoing user recording sessions and uploads the session to the portal.
-
trackEvent(
String name, Map< String, String> properties) → Future<void> - Tracks an event with the given name and properties.
-
trackScreenName(
String screenName) → Future< void> - Manually tracks a screen name for identification.
-
unregisterDevice(
String deviceID) → Future< void> - Unregisters the device from receiving push notifications from DevRev.
-
updateTransitioningState(
bool state) → Future< void> - Updates the current transitioning state if it has changed.
-
updateUser(
Map< String, dynamic> identity) → Future<void> - Updates the user information with the provided identity.