Package software.amazon.awssdk.services.ivschat.model

Interface CreateChatTokenRequest.Builder

    • Method Detail

      • attributes

        CreateChatTokenRequest.Builder attributes​(Map<String,​String> 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • capabilitiesWithStrings

        CreateChatTokenRequest.Builder capabilitiesWithStrings​(Collection<String> 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).

        Parameters:
        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).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • capabilitiesWithStrings

        CreateChatTokenRequest.Builder capabilitiesWithStrings​(String... 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).

        Parameters:
        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).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • capabilities

        CreateChatTokenRequest.Builder capabilities​(Collection<ChatTokenCapability> 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).

        Parameters:
        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).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • capabilities

        CreateChatTokenRequest.Builder capabilities​(ChatTokenCapability... 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).

        Parameters:
        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).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roomIdentifier

        CreateChatTokenRequest.Builder roomIdentifier​(String roomIdentifier)

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

        Parameters:
        roomIdentifier - Identifier of the room that the client is trying to access. Currently this must be an ARN.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sessionDurationInMinutes

        CreateChatTokenRequest.Builder sessionDurationInMinutes​(Integer sessionDurationInMinutes)

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

        Parameters:
        sessionDurationInMinutes - Session duration (in minutes), after which the session expires. Default: 60 (1 hour).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userId

        CreateChatTokenRequest.Builder userId​(String userId)

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

        Parameters:
        userId - Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.
        Returns:
        Returns a reference to this object so that method calls can be chained together.