Interface CreateChatTokenRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateChatTokenRequest.Builder,CreateChatTokenRequest>, IvschatRequest.Builder, SdkBuilder<CreateChatTokenRequest.Builder,CreateChatTokenRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateChatTokenRequest
@Mutable @NotThreadSafe public static interface CreateChatTokenRequest.Builder extends IvschatRequest.Builder, SdkPojo, CopyableBuilder<CreateChatTokenRequest.Builder,CreateChatTokenRequest>

  • Method Details

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

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

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

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

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

    • overrideConfiguration

      CreateChatTokenRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateChatTokenRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.