ClientEnvironment class

Constructors

ClientEnvironment({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 = ''})
ClientEnvironment.fromJson(Map<String, dynamic> json)
factory
ClientEnvironment.fromReader(TeleportObjectReader reader)
factory
ClientEnvironment.fromTeleport(Uint8List data)
factory

Properties

clientType ClientType
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
Absolute URL the browser loaded, ikon-* query params stripped; copied into Context.InitialUrl. Empty for every non-browser client.
getter/setter pair
installId String
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
payloadType PayloadType
getter/setter pair
productId String
getter/setter pair
protocolVersion int
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. A client can only misreport this about itself: claiming a level it does not have makes the server send messages it cannot handle.
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
styleFormat StyleFormat
getter/setter pair
supportsCompression bool
getter/setter pair
theme String
getter/setter pair
timezone String
getter/setter pair
userAgent String
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