Session class
Tracks the state of a single screen share session through the initial request, authorization, activty and ending.
Properties
- activated ↔ DateTime?
-
When the session was activated
getter/setter pair
- agent ↔ Agent?
-
Gets the basic information about the support agent in the session, or null if no agent has
joined yet.
getter/setter pair
- code ↔ String
-
The six digit code that can be shared with an agent to allow them to join the screen share.
Note: this is only available for sessions in the "pending" state. Once an agent has joined
the code will be empty as it is no longer valid.
getter/setter pair
- created ↔ DateTime?
-
When the session was created
getter/setter pair
-
customData
↔ Map<
String, String> -
Gets an immutable dictionary representing custom data of the session instance.
getter/setter pair
- ended ↔ DateTime?
-
When the session was ended
getter/setter pair
- endedReason ↔ SessionEndedReason
-
The reason the session ended
getter/setter pair
- expires ↔ DateTime?
-
When the session will expire
getter/setter pair
- fullDevice ↔ FullDeviceState
-
Gets the state of the full device mode.
getter/setter pair
- hasAgent → bool
-
Checks whether an agent has joined the session.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- id ↔ String
-
The ID of a session. You will likely never need to access this.
getter/setter pair
- isActive → bool
-
Tests if the session is in an active state.
no setter
- isAuthorizing → bool
-
Tests if the session is in a authorizing state (waiting for user consent).
no setter
- isEnded → bool
-
Tests if the session is in an ended state (can no longer be used or updated).
no setter
- isPending → bool
-
Tests if the session is in a pending state (waiting for an agent, or device).
no setter
- metrics ↔ SessionMetrics?
-
Gets the network metrics for the session.
getter/setter pair
- remoteControl ↔ RemoteControlState
-
Checks whether the session is allowed to capture screens from outside the app.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- state ↔ SessionState
-
The state of the session. The session states transition as follows:
getter/setter pair
- updated ↔ DateTime?
-
When the session was last updated
getter/setter pair
Methods
-
activate(
) → Future< void> - Transitions a session from pending or authorizing to active, allowing frames to start streaming. In order to activate a session, some conditions must be met:
-
end(
) → Future< void> - Ends a session. Once ended frames will stop streaming and it can no longer be used.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setCapabilities(
List< String> capabilities) → Future<void> - Sets the enabled capabilities for the session
-
setCustomData(
Map< String, String> customData) → Future<void> - Sets custom data on the session instance.
-
setFullDevice(
FullDeviceState state) → Future< void> - Sets the state of the full device mode. Setting this to false when the session is capturing in full device mode will end any active full device capturing mechanisms (e.g. ReplayKit).
-
setRemoteControl(
RemoteControlState state) → Future< void> - Sets the state of remote control
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited