Class: Aws::IVSRealTime::Types::ParticipantSummary

Inherits:

Struct

• Object
• Struct
• Aws::IVSRealTime::Types::ParticipantSummary

Defined in:

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

Overview

Summary object describing a participant that has joined a stage.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #first_join_time ⇒ Time

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

• #participant_id ⇒ String

  Unique identifier for this participant, assigned by IVS.

• #published ⇒ Boolean

  Whether the participant ever published to the stage session.

• #recording_state ⇒ String

  The participant’s recording state.

• #replication_state ⇒ String

  The participant's replication state.

• #replication_type ⇒ String

  Indicates if the participant has been replicated to another stage or is a replica from another stage.

• #source_session_id ⇒ String

  ID of the session within the source stage, if replicationType is REPLICA.

• #source_stage_arn ⇒ String

  Source stage ARN from which this participant is replicated, if replicationType is REPLICA.

• #state ⇒ String

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

• #user_id ⇒ 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.

Instance Attribute Details

#first_join_time ⇒ Time

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

Returns:

• (Time)

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

class ParticipantSummary < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :published,
  :recording_state,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#participant_id ⇒ String

Unique identifier for this participant, assigned by IVS.

Returns:

• (String)

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

class ParticipantSummary < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :published,
  :recording_state,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#published ⇒ Boolean

Whether the participant ever published to the stage session.

Returns:

• (Boolean)

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

class ParticipantSummary < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :published,
  :recording_state,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#recording_state ⇒ String

The participant’s recording state.

Returns:

• (String)

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

class ParticipantSummary < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :published,
  :recording_state,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#replication_state ⇒ String

The participant's replication state.

Returns:

• (String)

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

class ParticipantSummary < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :published,
  :recording_state,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#replication_type ⇒ String

Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.

Returns:

• (String)

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

class ParticipantSummary < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :published,
  :recording_state,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#source_session_id ⇒ String

ID of the session within the source stage, if replicationType is REPLICA.

Returns:

• (String)

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

class ParticipantSummary < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :published,
  :recording_state,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#source_stage_arn ⇒ String

Source stage ARN from which this participant is replicated, if replicationType is REPLICA.

Returns:

• (String)

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

class ParticipantSummary < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :published,
  :recording_state,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

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

Returns:

• (String)

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

class ParticipantSummary < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :published,
  :recording_state,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

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

class ParticipantSummary < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :published,
  :recording_state,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end