Class: Aws::Ivschat::Types::CreateChatTokenRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:user_id, :attributes]

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ Hash<String,String>

Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.

Returns:

  • (Hash<String,String>) 


87
88
89
90
91
92
93
94
95
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/types.rb', line 87

class CreateChatTokenRequest < Struct.new(
  :room_identifier,
  :user_id,
  :capabilities,
  :session_duration_in_minutes,
  :attributes)
  SENSITIVE = [:user_id, :attributes]
  include Aws::Structure
end

#capabilities ⇒ Array<String>

Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

Returns:

  • (Array<String>) 


87
88
89
90
91
92
93
94
95
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/types.rb', line 87

class CreateChatTokenRequest < Struct.new(
  :room_identifier,
  :user_id,
  :capabilities,
  :session_duration_in_minutes,
  :attributes)
  SENSITIVE = [:user_id, :attributes]
  include Aws::Structure
end

#room_identifier ⇒ String

Identifier of the room that the client is trying to access. Currently this must be an ARN.

Returns:

  • (String) 


87
88
89
90
91
92
93
94
95
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/types.rb', line 87

class CreateChatTokenRequest < Struct.new(
  :room_identifier,
  :user_id,
  :capabilities,
  :session_duration_in_minutes,
  :attributes)
  SENSITIVE = [:user_id, :attributes]
  include Aws::Structure
end

#session_duration_in_minutes ⇒ Integer

Session duration (in minutes), after which the session expires. Default: 60 (1 hour).

Returns:

  • (Integer) 


87
88
89
90
91
92
93
94
95
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/types.rb', line 87

class CreateChatTokenRequest < Struct.new(
  :room_identifier,
  :user_id,
  :capabilities,
  :session_duration_in_minutes,
  :attributes)
  SENSITIVE = [:user_id, :attributes]
  include Aws::Structure
end

#user_id ⇒ String

Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

Returns:

  • (String) 


87
88
89
90
91
92
93
94
95
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/types.rb', line 87

class CreateChatTokenRequest < Struct.new(
  :room_identifier,
  :user_id,
  :capabilities,
  :session_duration_in_minutes,
  :attributes)
  SENSITIVE = [:user_id, :attributes]
  include Aws::Structure
end