Context class

Constructors

Context({ContextType contextType = ContextType.unknown, UserType userType = UserType.unknown, PayloadType payloadType = PayloadType.unknown, String description = '', String userId = '', String deviceId = '', String productId = '', String versionId = '', String installId = '', String locale = '', int sessionId = -1, bool isInternal = false, bool isSnapshot = false, String snapshotVariant = '', bool isReady = false, bool hasInput = false, String authSessionId = '', bool isAnonymous = false, bool isGlobal = false, String authProvider = '', String ssoConnectionId = '', String testLinkId = '', String testLinkName = '', bool receiveAllMessages = false, int preciseJoinedAt = 0, String userAgent = '', ClientType clientType = ClientType.unknown, String uniqueSessionId = '', Map<String, String> parameters = const {}, SdkType sdkType = SdkType.unknown, int sdkCapability = 0, int viewportWidth = 0, int viewportHeight = 0, String theme = '', String timezone = '', bool isTouchDevice = false, String initialPath = '', String initialUrl = '', StyleFormat styleFormat = StyleFormat.css, bool supportsCompression = true, bool isSoftDisconnected = false, int softDisconnectAt = 0})
Context.fromJson(Map<String, dynamic> json)
factory
Context.fromReader(TeleportObjectReader reader)
factory
Context.fromTeleport(Uint8List data)
factory

Properties

authProvider ↔ String
Copied from ConnectToken.AuthProvider — how the user signed in: google, microsoft, apple, facebook, signicat, email, passkey or sso. Empty for a guest, and for a sign-in that predates the platform recording it, which is not the same as any one method. Signed by the backend, so an app may rely on it, for example to require that its enterprise users came in through their organisation's IdP.
getter/setter pair
authSessionId ↔ String
getter/setter pair
clientType ↔ ClientType
getter/setter pair
contextType ↔ ContextType
getter/setter pair
description ↔ String
getter/setter pair
deviceId ↔ String
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
hasInput ↔ bool
getter/setter pair
initialPath ↔ String
getter/setter pair
initialUrl ↔ String
Copied from ConnectToken.InitialUrl — the absolute URL the browser loaded, so an app can see the host it was reached on (a custom customer domain) and not just the path. A strict superset of InitialPath: same SDK-internal ikon-* query params stripped, everything else kept, so InitialUrl.PathAndQuery reproduces InitialPath. Empty for every non-browser client, so read it as an addition to InitialPath rather than a replacement. Client-controlled like InitialPath — treat it as a hint and re-authorize server-side; it must never gate anything security-relevant on its own.
getter/setter pair
installId ↔ String
getter/setter pair
isAnonymous ↔ bool
Copied from ConnectToken.IsAnonymous — true when the user is anonymous (guest login or no login): a device-scoped identity rather than a real account. The authoritative signal for guest detection; AuthSessionId is a login-session identifier, not an authentication flag.
getter/setter pair
isGlobal ↔ bool
Copied from ConnectToken.IsGlobal — true when this anonymous user is the space's GLOBAL communal identity (the "global" login method), where every global visitor shares one UserId. Always false for device-scoped guests and signed-in users; implies IsAnonymous. Lets an app offer "continue as guest" or per-visitor features only where they make sense.
getter/setter pair
isInternal ↔ bool
getter/setter pair
isReady ↔ bool
getter/setter pair
isSnapshot ↔ bool
Copied from ConnectToken.IsSnapshot — marks the build-time snapshot-capture client.
getter/setter pair
isSoftDisconnected ↔ bool
getter/setter pair
isTouchDevice ↔ bool
getter/setter pair
locale ↔ String
getter/setter pair
parameters ↔ Map<String, String>
getter/setter pair
payloadType ↔ PayloadType
getter/setter pair
preciseJoinedAt ↔ int
getter/setter pair
productId ↔ String
getter/setter pair
receiveAllMessages ↔ bool
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sdkCapability ↔ int
Opaque, monotonically-increasing capability level advertised by the connecting SDK (companion to SdkType). 0 = legacy/unknown. Copied from ConnectToken.SdkCapability when the server builds the client Context.
getter/setter pair
sdkType ↔ SdkType
getter/setter pair
sessionId ↔ int
getter/setter pair
snapshotVariant ↔ String
Copied from ConnectToken.SnapshotVariant — the boot-snapshot variant id the capture client asks the app to render; empty for route captures and all live clients. Client-controlled like IsSnapshot — must never gate anything security-relevant.
getter/setter pair
softDisconnectAt ↔ int
getter/setter pair
ssoConnectionId ↔ String
Copied from ConnectToken.SsoConnectionId — the space's SSO connection the user signed in through; empty unless AuthProvider is sso. What an app compares against the connection it assigned to one of its tenants.
getter/setter pair
styleFormat ↔ StyleFormat
getter/setter pair
supportsCompression ↔ bool
getter/setter pair
testLinkId ↔ String
Copied from ConnectToken.TestLinkId / TestLinkName — set when this session came in through a test link the app's makers minted. A guest that is also a tester: the feedback button is offered whatever the audience setting, and its reports carry the link's name. Empty otherwise.
getter/setter pair
testLinkName ↔ String
getter/setter pair
theme ↔ String
getter/setter pair
timezone ↔ String
getter/setter pair
uniqueSessionId ↔ String
getter/setter pair
userAgent ↔ String
getter/setter pair
userId ↔ String
getter/setter pair
userType ↔ UserType
getter/setter pair
versionId ↔ String
getter/setter pair
viewportHeight ↔ int
getter/setter pair
viewportWidth ↔ int
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited
toTeleport() → Uint8List
writeTo(TeleportObjectWriter scope) → void

Operators

operator ==(Object other) → bool
The equality operator.
inherited