Class: Aws::IVSRealTime::Types::ParticipantToken
- Inherits:
-
Struct
- Object
- Struct
- Aws::IVSRealTime::Types::ParticipantToken
- Defined in:
- gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb
Overview
Object specifying a participant token in a stage.
Important: Treat tokens as opaque; i.e., do not build functionality based on token contents. The format of tokens could change in the future.
Constant Summary collapse
- SENSITIVE =
[:token]
Instance Attribute Summary collapse
-
#attributes ⇒ Hash<String,String>
Application-provided attributes to encode into the token and attach to a stage.
-
#capabilities ⇒ Array<String>
Set of capabilities that the user is allowed to perform in the stage.
-
#duration ⇒ Integer
Duration (in minutes), after which the participant token expires.
-
#expiration_time ⇒ Time
ISO 8601 timestamp (returned as a string) for when this token expires.
-
#participant_id ⇒ String
Unique identifier for this participant token, assigned by IVS.
-
#token ⇒ String
The issued client token, encrypted.
-
#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. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1417 class ParticipantToken < Struct.new( :attributes, :capabilities, :duration, :expiration_time, :participant_id, :token, :user_id) SENSITIVE = [:token] include Aws::Structure end |
#capabilities ⇒ Array<String>
Set of capabilities that the user is allowed to perform in the stage.
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1417 class ParticipantToken < Struct.new( :attributes, :capabilities, :duration, :expiration_time, :participant_id, :token, :user_id) SENSITIVE = [:token] include Aws::Structure end |
#duration ⇒ Integer
Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1417 class ParticipantToken < Struct.new( :attributes, :capabilities, :duration, :expiration_time, :participant_id, :token, :user_id) SENSITIVE = [:token] include Aws::Structure end |
#expiration_time ⇒ Time
ISO 8601 timestamp (returned as a string) for when this token expires.
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1417 class ParticipantToken < Struct.new( :attributes, :capabilities, :duration, :expiration_time, :participant_id, :token, :user_id) SENSITIVE = [:token] include Aws::Structure end |
#participant_id ⇒ String
Unique identifier for this participant token, assigned by IVS.
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1417 class ParticipantToken < Struct.new( :attributes, :capabilities, :duration, :expiration_time, :participant_id, :token, :user_id) SENSITIVE = [:token] include Aws::Structure end |
#token ⇒ String
The issued client token, encrypted.
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1417 class ParticipantToken < Struct.new( :attributes, :capabilities, :duration, :expiration_time, :participant_id, :token, :user_id) SENSITIVE = [:token] 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.
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1417 class ParticipantToken < Struct.new( :attributes, :capabilities, :duration, :expiration_time, :participant_id, :token, :user_id) SENSITIVE = [:token] include Aws::Structure end |