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

Inherits:
Struct
  • Object
show all
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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#first_join_time ⇒ Time

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

Returns:

  • (Time) 


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1905

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

#participant_id ⇒ String

Unique identifier for this participant, assigned by IVS.

Returns:

  • (String) 


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1905

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

#published ⇒ Boolean

Whether the participant ever published to the stage session.

Returns:

  • (Boolean) 


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1905

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

#recording_state ⇒ String

The participant’s recording state.

Returns:

  • (String) 


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1905

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

#state ⇒ String

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

Returns:

  • (String) 


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1905

class ParticipantSummary < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :published,
  :recording_state)
  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) 


1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1905

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