Skip to content

CreateChatTokenRequest

Source code in docs_src/capo_ivschat/types/create_chat_token_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class CreateChatTokenRequest(TypedDict, closed=True):
    room_identifier: "capo_ivschat.types.room_identifier.RoomIdentifier"
    """<p>Identifier of the room that the client is trying to access. Currently this must be an ARN. </p>"""
    user_id: "capo_ivschat.types.user_id.UserID"
    """<p>Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.</p>"""
    capabilities: NotRequired[
        "capo_ivschat.types.chat_token_capabilities.ChatTokenCapabilities"
    ]
    """<p>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).</p>"""
    session_duration_in_minutes: NotRequired[
        "capo_ivschat.types.session_duration_in_minutes.SessionDurationInMinutes"
    ]
    """<p>Session duration (in minutes), after which the session expires. Default: 60 (1 hour).</p>"""
    attributes: NotRequired[
        "capo_ivschat.types.chat_token_attributes.ChatTokenAttributes"
    ]
    """<p>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.</p>"""

attributes instance-attribute 

attributes: NotRequired[ChatTokenAttributes]

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 instance-attribute 

capabilities: NotRequired[ChatTokenCapabilities]

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).

room_identifier instance-attribute 

room_identifier: RoomIdentifier

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

session_duration_in_minutes instance-attribute 

session_duration_in_minutes: NotRequired[SessionDurationInMinutes]

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

user_id instance-attribute 

user_id: UserID

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