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

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. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.

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.

participantId

val participantId: String?

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

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.

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