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

Event

class Event

An occurrence during a stage session.

Types

Builder

class Builder

Companion

object Companion

Properties

destinationSessionId

val destinationSessionId: String?

ID of the session within the destination stage. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.

destinationStageArn

val destinationStageArn: String?

ARN of the stage where the participant is replicated. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.

errorCode

val errorCode: EventErrorCode?

If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null.

eventTime

val eventTime: Instant?

ISO 8601 timestamp (returned as a string) for when the event occurred.

name

val name: EventName?

The name of the event.

newToken

val newToken: ExchangedParticipantToken?

Participant token created during TOKEN_EXCHANGED event.

participantId

val participantId: String?

Unique identifier for the participant who triggered the event. This is assigned by IVS.

previousToken

val previousToken: ExchangedParticipantToken?

Source participant token for TOKEN_EXCHANGED event.

remoteParticipantId

val remoteParticipantId: String?

Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.

replica

val replica: Boolean

If true, this indicates the participantId is a replicated participant. If this is a subscribe event, then this flag refers to remoteParticipantId. Default: false.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String