ivsrealtime/aws.sdk.kotlin.services.ivsrealtime.model/ParticipantToken

ParticipantToken

Object specifying a participant token in a stage.

Important: Treat tokens as opaque; i.e., do not build functionality based on token contents. The format of tokens could change in the future.

Types

Builder

class Builder

Companion

object Companion

Properties

attributes

val attributes: Map<String, String>?

Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

capabilities

val capabilities: List<ParticipantTokenCapability>?

Set of capabilities that the user is allowed to perform in the stage.

duration

val duration: Int?

Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).

expirationTime

val expirationTime: Instant?

ISO 8601 timestamp (returned as a string) for when this token expires.

participantId

val participantId: String?

Unique identifier for this participant token, assigned by IVS.

token

val token: String?

The issued client token, encrypted.

userId

val userId: String?

Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Functions

copy

inline fun copy(block: ParticipantToken.Builder.() -> Unit = {}): ParticipantToken

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String