Participant

Object describing a participant that has joined a stage.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Application-provided attributes to encode into the 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.

Link copied to clipboard

The participant’s browser.

Link copied to clipboard

The participant’s browser version.

Link copied to clipboard

ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.

Link copied to clipboard

The participant’s Internet Service Provider.

Link copied to clipboard

The participant’s operating system.

Link copied to clipboard

The participant’s operating system version.

Link copied to clipboard

Unique identifier for this participant, assigned by IVS.

Link copied to clipboard

Whether the participant ever published to the stage session.

Link copied to clipboard

The participant’s SDK version.

Link copied to clipboard

Whether the participant is connected to or disconnected from the stage.

Link copied to clipboard

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

Link copied to clipboard
inline fun copy(block: Participant.Builder.() -> Unit = {}): Participant
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String