Request parameters for generating connection credentials.

Annotations

• @JsonSerializable()

Constructors

TokenRequestOptions({String? roomName, String? participantName, String? participantIdentity, String? participantMetadata, Map<String, String>? participantAttributes, String? agentName, String? agentMetadata})

const

TokenRequestOptions.fromJson(Map<String, dynamic> json)

factory

Properties

agentMetadata → String?

Metadata passed to the agent job.

final

agentName → String?

Name of the agent to dispatch.

final

hashCode → int

The hash code for this object.

no setteroverride

participantAttributes → Map<String, String>?

Custom attributes for the participant. Useful for storing key-value data like user roles or preferences.

final

participantIdentity → String?

A unique identifier for the participant. Used for permissions and room management.

final

participantMetadata → String?

Custom metadata associated with the participant. Can be used for user profiles or additional context.

final

participantName → String?

The display name for the participant in the room. Optional but recommended for user experience.

final

roomName → String?

The name of the room to connect to. Required for most token generation scenarios.

final

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

toJson() → Map<String, dynamic>

toRequest() → TokenSourceRequest

Converts this options object to a wire-format request.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

override