Class: Aws::IVSRealTime::Types::Participant
- Inherits:
-
Struct
- Object
- Struct
- Aws::IVSRealTime::Types::Participant
- Defined in:
- gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb
Overview
Object describing a participant that has joined a stage.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#attributes ⇒ Hash<String,String>
Application-provided attributes to encode into the token and attach to a stage.
-
#browser_name ⇒ String
The participant’s browser.
-
#browser_version ⇒ String
The participant’s browser version.
-
#first_join_time ⇒ Time
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
-
#isp_name ⇒ String
The participant’s Internet Service Provider.
-
#os_name ⇒ String
The participant’s operating system.
-
#os_version ⇒ String
The participant’s operating system version.
-
#participant_id ⇒ String
Unique identifier for this participant, assigned by IVS.
-
#published ⇒ Boolean
Whether the participant ever published to the stage session.
-
#sdk_version ⇒ String
The participant’s SDK version.
-
#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
#attributes ⇒ Hash<String,String>
Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1314 class Participant < Struct.new( :attributes, :browser_name, :browser_version, :first_join_time, :isp_name, :os_name, :os_version, :participant_id, :published, :sdk_version, :state, :user_id) SENSITIVE = [] include Aws::Structure end |
#browser_name ⇒ String
The participant’s browser.
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1314 class Participant < Struct.new( :attributes, :browser_name, :browser_version, :first_join_time, :isp_name, :os_name, :os_version, :participant_id, :published, :sdk_version, :state, :user_id) SENSITIVE = [] include Aws::Structure end |
#browser_version ⇒ String
The participant’s browser version.
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1314 class Participant < Struct.new( :attributes, :browser_name, :browser_version, :first_join_time, :isp_name, :os_name, :os_version, :participant_id, :published, :sdk_version, :state, :user_id) SENSITIVE = [] include Aws::Structure end |
#first_join_time ⇒ Time
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1314 class Participant < Struct.new( :attributes, :browser_name, :browser_version, :first_join_time, :isp_name, :os_name, :os_version, :participant_id, :published, :sdk_version, :state, :user_id) SENSITIVE = [] include Aws::Structure end |
#isp_name ⇒ String
The participant’s Internet Service Provider.
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1314 class Participant < Struct.new( :attributes, :browser_name, :browser_version, :first_join_time, :isp_name, :os_name, :os_version, :participant_id, :published, :sdk_version, :state, :user_id) SENSITIVE = [] include Aws::Structure end |
#os_name ⇒ String
The participant’s operating system.
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1314 class Participant < Struct.new( :attributes, :browser_name, :browser_version, :first_join_time, :isp_name, :os_name, :os_version, :participant_id, :published, :sdk_version, :state, :user_id) SENSITIVE = [] include Aws::Structure end |
#os_version ⇒ String
The participant’s operating system version.
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1314 class Participant < Struct.new( :attributes, :browser_name, :browser_version, :first_join_time, :isp_name, :os_name, :os_version, :participant_id, :published, :sdk_version, :state, :user_id) SENSITIVE = [] include Aws::Structure end |
#participant_id ⇒ String
Unique identifier for this participant, assigned by IVS.
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1314 class Participant < Struct.new( :attributes, :browser_name, :browser_version, :first_join_time, :isp_name, :os_name, :os_version, :participant_id, :published, :sdk_version, :state, :user_id) SENSITIVE = [] include Aws::Structure end |
#published ⇒ Boolean
Whether the participant ever published to the stage session.
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1314 class Participant < Struct.new( :attributes, :browser_name, :browser_version, :first_join_time, :isp_name, :os_name, :os_version, :participant_id, :published, :sdk_version, :state, :user_id) SENSITIVE = [] include Aws::Structure end |
#sdk_version ⇒ String
The participant’s SDK version.
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1314 class Participant < Struct.new( :attributes, :browser_name, :browser_version, :first_join_time, :isp_name, :os_name, :os_version, :participant_id, :published, :sdk_version, :state, :user_id) SENSITIVE = [] include Aws::Structure end |
#state ⇒ String
Whether the participant is connected to or disconnected from the stage.
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1314 class Participant < Struct.new( :attributes, :browser_name, :browser_version, :first_join_time, :isp_name, :os_name, :os_version, :participant_id, :published, :sdk_version, :state, :user_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.
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1314 class Participant < Struct.new( :attributes, :browser_name, :browser_version, :first_join_time, :isp_name, :os_name, :os_version, :participant_id, :published, :sdk_version, :state, :user_id) SENSITIVE = [] include Aws::Structure end |