ConnectToken class

Constructors

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

Properties

authProvider ↔ String
How the user signed in, as the session token's provider claim names it; copied into Context.AuthProvider. Empty for a session minted before the claim existed.
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
expiresAt ↔ int
Epoch seconds after which the server refuses this token. 0 means no timed expiry, which is only appropriate when the signing process also owns the verifying server and randomizes the secret at startup — the token then dies with the process. Every minted token that leaves the machine sets it.
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
Absolute URL the browser loaded, ikon-* query params stripped; copied into Context.InitialUrl. Empty for every non-browser client. Client-supplied like InitialPath — never authoritative.
getter/setter pair
installId ↔ String
getter/setter pair
isAnonymous ↔ bool
True when the user is anonymous (guest login or no login): a device-scoped identity rather than a real account. Filled by the backend from the user's role; copied into Context.IsAnonymous. AuthSessionId cannot express this — cloud logins (including anonymous ones) always carry a session id, so "has a session" does not mean "has an account".
getter/setter pair
isGlobal ↔ bool
True when the anonymous user is the space's GLOBAL communal identity (the "global" login method) — every global visitor shares one UserId. Always false for device-scoped guests and signed-in users; implies IsAnonymous. Filled by the backend from the minted flavor; copied into Context.IsGlobal.
getter/setter pair
isInternal ↔ bool
getter/setter pair
isSnapshot ↔ bool
True for the build-time snapshot-capture client; copied into Context.IsSnapshot. Identifies the client whose initial UI is baked into boot-snapshot.json. Inert beyond identification in v1.
getter/setter pair
isTouchDevice ↔ bool
getter/setter pair
locale ↔ String
getter/setter pair
opcodeGroupsFromServer ↔ Opcode
getter/setter pair
opcodeGroupsToServer ↔ Opcode
getter/setter pair
parameters ↔ Map<String, String>
Launch parameters. Signed, and NOT part of the removable block below, because the reserved ikon- names here are the minter's to grant: the server reads ikon-shared-session (Context.SharedSessionParameter). The cloud backend signs the app's own parameters as the client sends them, drops every reserved name, and puts ikon-shared-session back only for a developer of the space on their own platform login. A local run's /connect-token signs what it is posted.
getter/setter pair
payloadType ↔ PayloadType
getter/setter pair
productId ↔ String
getter/setter pair
protocolVersion ↔ int
getter/setter pair
receiveAllMessages ↔ bool
getter/setter pair
retiredFields ↔ ConnectTokenRetiredFields?
Retired ledger values captured on read: keys the schema no longer names, kept so code upgrading from an older peer can still reach them. Null when the source carried none.
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. Threaded SDK connect-request -> backend -> ConnectToken -> ikon server -> client Context.
getter/setter pair
sdkType ↔ SdkType
getter/setter pair
snapshotVariant ↔ String
Boot-snapshot variant id the capture client asks the app to render (a skeleton keyed by the BootSnapshot seed rules); empty for route captures and all live clients. Copied into Context.SnapshotVariant. Client-controlled like IsSnapshot — must never gate anything security-relevant.
getter/setter pair
ssoConnectionId ↔ String
The SSO connection the user signed in through, from the session token's ssoConnection claim; copied into Context.SsoConnectionId. Empty unless AuthProvider is sso.
getter/setter pair
styleFormat ↔ StyleFormat
getter/setter pair
supportsCompression ↔ bool
getter/setter pair
testLinkId ↔ String
Set when the session was admitted through a test link the app's makers minted: the link's id and its name. A test-link session is a guest that is also a tester — the feedback button is offered whatever the app's audience setting, and a report it files is tagged with the link. Filled by the backend from the validated link; copied into Context. Empty for every other session.
getter/setter pair
testLinkName ↔ String
getter/setter pair
theme ↔ String
getter/setter pair
timezone ↔ 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