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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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
Participant’s recording state.
-
#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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1423 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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1423 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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1423 class ParticipantSummary < Struct.new( :participant_id, :user_id, :state, :first_join_time, :published, :recording_state) SENSITIVE = [] include Aws::Structure end |
#recording_state ⇒ String
Participant’s recording state.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1423 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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1423 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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1423 class ParticipantSummary < Struct.new( :participant_id, :user_id, :state, :first_join_time, :published, :recording_state) SENSITIVE = [] include Aws::Structure end |