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

ParticipantTokenConfiguration

class ParticipantTokenConfiguration

Object specifying a participant token configuration in a stage.

Types

Builder

class Builder

Companion

object Companion

Properties

attributes

val attributes: Map<String, String>?

Application-provided attributes to encode into the corresponding participant token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. 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 corresponding participant token expires. Default: 720 (12 hours).

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: ParticipantTokenConfiguration.Builder.() -> Unit = {}): ParticipantTokenConfiguration

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String