ivschat_create_chat_token: Creates an encrypted token that is used by a chat participant...

In paws.end.user.computing: 'Amazon Web Services' End User Computing Services

Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room

Description

Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.

See https://www.paws-r-sdk.com/docs/ivschat_create_chat_token/ for full documentation.

Usage

ivschat_create_chat_token(
  attributes = NULL,
  capabilities = NULL,
  roomIdentifier,
  sessionDurationInMinutes = NULL,
  userId
)

Arguments

attributes	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.
capabilities	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).
roomIdentifier	[required] Identifier of the room that the client is trying to access. Currently this must be an ARN.
sessionDurationInMinutes	Session duration (in minutes), after which the session expires. Default: 60 (1 hour).
userId	[required] Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

paws.end.user.computing documentation built on Sept. 12, 2023, 1:17 a.m.