Class: Aws::IVSRealTime::Types::Event

Inherits:

Struct

• Object
• Struct
• Aws::IVSRealTime::Types::Event

Defined in:

gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb

Overview

An occurrence during a stage session.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #error_code ⇒ String

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

• #event_time ⇒ Time

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

• #name ⇒ String

  The name of the event.

• #participant_id ⇒ String

  Unique identifier for the participant who triggered the event.

• #remote_participant_id ⇒ String

  Unique identifier for the remote participant.

Instance Attribute Details

#error_code ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 689

class Event < Struct.new(
  :name,
  :participant_id,
  :event_time,
  :remote_participant_id,
  :error_code)
  SENSITIVE = []
  include Aws::Structure
end

#event_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 689

class Event < Struct.new(
  :name,
  :participant_id,
  :event_time,
  :remote_participant_id,
  :error_code)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the event.

Returns:

• (String)

# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 689

class Event < Struct.new(
  :name,
  :participant_id,
  :event_time,
  :remote_participant_id,
  :error_code)
  SENSITIVE = []
  include Aws::Structure
end

#participant_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 689

class Event < Struct.new(
  :name,
  :participant_id,
  :event_time,
  :remote_participant_id,
  :error_code)
  SENSITIVE = []
  include Aws::Structure
end

#remote_participant_id ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 689

class Event < Struct.new(
  :name,
  :participant_id,
  :event_time,
  :remote_participant_id,
  :error_code)
  SENSITIVE = []
  include Aws::Structure
end