FlutterUxcam class
Properties
hashCode → int
The hash code for this object.
no setter inherited
runtimeType → Type
A representation of the runtime type of the object.
no setter inherited
Methods
noSuchMethod (Invocation invocation → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString ()
→ String
A string representation of this object.
inherited
Static Methods
addScreenNameToIgnore (String screenName → Future <void >
This method is used for adding screen Names to be ignored for occlusion
allowShortBreakForAnotherApp (bool continueSession → Future <void >
This method is used for pausing session when navigating to another app
allowShortBreakForAnotherAppWithDuration (int duration → Future <void >
Pausing Screen Recording by adding Occlusion for screen passing duration
parameter.
applyOcclusion (FlutterUXOcclusion occlusion → Future <bool
This method is used for applying occlusion (or Blur) settings
cancelCurrentSession ()
→ Future <void >
This method is used for cancelling current running session.
configurationForUXCam ()
→ Future <FlutterUxConfig
This call is available only for IOS portion of the SDK so not sure will work on Android.
deletePendingUploads ()
→ Future <void >
This method is used for deleting all the pending Session that is
not uploaded.
getMultiSessionRecord ()
→ Future <bool
This will return value for multiSessionRecord status as boolean
isRecording ()
→ Future <bool
This method is used for verifying if the recording is currently active
logEvent (String logEvent → Future <void >
This method is used for sending event to be logged.
logEventWithProperties (String eventName , Map <String dynamic > properties → Future <void >
This method is used for sending event to be logged.
occludeAllTextFields (bool value → Future <void >
This method is used for hiding all TextFields
occludeAllTextView (bool value → Future <void >
This method is used for hiding TextField
occludeRectWithCoordinates (int x0 , int y0 , int x1 , int y1 → Future <void >
Here the coordinates are the location of the view/enclosing box
x0 - topLeft, y0 - topLeft
x1 - bottomRight, y1 - bottomRight
The Coordinates are similar to normal graph plotting
occludeSensitiveScreen (bool hideScreen → Future <void >
This method is used with parameter to occlude following screen
occludeSensitiveScreenWithoutGesture (bool hideScreen → Future <void >
This method is used with parameter to occlude following screen
and prevent from registering Gestures.
optInOverall ()
→ Future <void >
This method is used for opting in to enable recording at runtime
optInOverallStatus ()
→ Future <bool
This method is used for opting in to enable recording at runtime
This will return boolean for status
optInSchematicRecordingStatus ()
→ Future <bool
This method is same as optIntoSchematicRecordings() but will return boolean
for status.
optIntoSchematicRecordings ()
→ Future <void >
This method is used for opting in to enable video recording at runtime
This call is required for enabling video recording permission in IOS
optIntoVideoRecording ()
→ Future <void >
This method is used for opting in to enable video recording at runtime
optInVideoRecordingStatus ()
→ Future <bool
This method is used for opting in to enable video recording at runtime
This will return boolean for status
optOutOfSchematicRecordings ()
→ Future <void >
This method is specifically for IOS to opt out of video recording
NOTE: This will not work for Android
optOutOfVideoRecording ()
→ Future <void >
This method is used for opting in to disable video recording at runtime
optOutOverall ()
→ Future <void >
This method is used for opting in to disable recording at runtime
pauseScreenRecording ()
→ Future <void >
This method is used for pausing the current session video recording
pendingUploads ()
→ Future <int
This method is used getting number of upload counts
removeAllScreenNamesToIgnore ()
→ Future <void >
This method is used for removing all the registered screenNames that needs
to be ignored.
removeOcclusion (FlutterUXOcclusion occlusion → Future <bool
This method is used for remove occlusion (or Blur) with specified settings
removeScreenNameToIgnore (String screenName → Future <void >
This method is used for removing screen Names to be ignored for occlusion
reportBugEvent (String eventName , [Map <String dynamic > ?properties → Future <void >
This method is used for sending any report as Bug as key value pair
reportExceptionEvent (dynamic exception , StackTrace ?stack → Future <void >
This method is used for sending any report as Bug as key value pair
resumeScreenRecording ()
→ Future <void >
This method is used for resuming the current session video recording
resumeShortBreakForAnotherApp ()
→ Future <void >
This method is used for resuming session after the app navigated back
setAutomaticScreenNameTagging (bool enable → Future <void >
This will tell SDK to automatically Tag Screen or not.
setMultiSessionRecord (bool multiSessionRecord → Future <void >
This method is used to set multiSessionRecord feature
setPushNotificationToken (String token → Future <void >
setSessionProperty (String key , String value → Future <void >
This method is used for setting properties that will be specific to
that session
setUserIdentity (String ?userIdentity → Future <void >
This method is used for setting the UserIdentity that can be
seen as sessions.
setUserProperty (String key , String value → Future <void >
This method is used for setting more user Properties that will be present
and also unique to that user.
startNewSession ()
→ Future <void >
This method is used for starting new session
startWithConfiguration (FlutterUxConfig config → Future <bool
This method is used to as a starting point for configuring and
starting point for setting up UXCam SDK.
startWithKey (String key → Future <bool
Older implementation of starting UXCam SDK
stopApplicationAndUploadData ()
→ Future <void >
stopSessionAndUploadData ()
→ Future <void >
This method is used for stopping the current session
and uploading the data to server
tagScreenName (String screenName → Future <void >
This method is used for tagging Screen with custom names
updateConfiguration (FlutterUxConfig config → Future <bool
This call is available only for IOS portion of the SDK so not sure will work on Android.
uploadPendingSession ()
→ Future <void >
This method is used for performing manual trigger for uploading sessions that
are not uploaded.
urlForCurrentSession ()
→ Future <String ?
This method will return url for current session to be uploaded
urlForCurrentUser ()
→ Future <String ?
This method will return url for current user
