FS class
Fullstory API
Note that all methods are static. Also note that methods may drop data if called when there is no Fullstory session active.
Constructors
- FS()
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
-
anonymize(
) → Future< void> - If a user ID was previously set via FS.identify(), this will end the session, clear the user ID, and begin a new anonymous session.
-
event(
String name, [Map< String, Object?> properties = const {}]) → Future<void> - Create a custom event that will appear in the event list in playback and can be used in segments, funnels, etc.
-
fsVersion(
) → Future< String?> - Version of the underlying native Fullstory framework, e.g. '1.54.0'
-
getCurrentSession(
) → Future< String?> - Returns the ID of the current Fullstory session.
-
getCurrentSessionURL(
[bool now = false]) → Future< String?> - Returns the URL to view the current Fullstory session.
-
identify(
String uid, [Map< String, Object?> ? userVars]) → Future<void> - Identify a user and associate current and future sessions with that user.
-
log(
{FSLogLevel level = FSLogLevel.info, required String message}) → Future< void> - Log a message that will appear in the Dev Tools > Console section of the Fullstory replay.
-
resetIdleTimer(
) → Future< void> - Reset the idle timer and prevent Fullstory from going into a lower-fidelity mode that conserves power and bandwidth.
-
restart(
) → Future< void> - Start or resume a Fullstory session.
-
setStatusListener(
FSStatusListener? listener) → void - Specify a delegate to be notified of Fullstory session status events.
-
setUserVars(
Map< String, Object?> userVars) → Future<void> - Set arbitrary key/value pairs that are associated with the current user.
-
shutdown(
) → Future< void> - End Fullstory session.