Interface StartChatContactResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, ConnectResponse.Builder, CopyableBuilder<StartChatContactResponse.Builder,StartChatContactResponse>, SdkBuilder<StartChatContactResponse.Builder,StartChatContactResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
StartChatContactResponse
@Mutable @NotThreadSafe public static interface StartChatContactResponse.Builder extends ConnectResponse.Builder, SdkPojo, CopyableBuilder<StartChatContactResponse.Builder,StartChatContactResponse>

  • Method Details

    • contactId

      StartChatContactResponse.Builder contactId(String contactId)

      The identifier of this contact within the Connect Customer instance.

      Parameters:
      contactId - The identifier of this contact within the Connect Customer instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • participantId

      StartChatContactResponse.Builder participantId(String participantId)

      The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.

      Parameters:
      participantId - The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • participantToken

      StartChatContactResponse.Builder participantToken(String participantToken)

      The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.

      Parameters:
      participantToken - The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • continuedFromContactId

      StartChatContactResponse.Builder continuedFromContactId(String continuedFromContactId)

      The contactId from which a persistent chat session is started. This field is populated only for persistent chats.

      Parameters:
      continuedFromContactId - The contactId from which a persistent chat session is started. This field is populated only for persistent chats.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connectionCredentials

      StartChatContactResponse.Builder connectionCredentials(ConnectionCredentials connectionCredentials)

      The connection credentials for the chat participant. Returned only when the request includes CONNECTION_CREDENTIALS in ConnectionTypes.

      Parameters:
      connectionCredentials - The connection credentials for the chat participant. Returned only when the request includes CONNECTION_CREDENTIALS in ConnectionTypes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connectionCredentials

      default StartChatContactResponse.Builder connectionCredentials(Consumer<ConnectionCredentials.Builder> connectionCredentials)

      The connection credentials for the chat participant. Returned only when the request includes CONNECTION_CREDENTIALS in ConnectionTypes.

      This is a convenience method that creates an instance of the ConnectionCredentials.Builder avoiding the need to create one manually via ConnectionCredentials.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to connectionCredentials(ConnectionCredentials).

      Parameters:
      connectionCredentials - a consumer that will call methods on ConnectionCredentials.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • websocket

      StartChatContactResponse.Builder websocket(Websocket websocket)

      The websocket for the chat participant. Returned only when the request includes WEBSOCKET in ConnectionTypes.

      Parameters:
      websocket - The websocket for the chat participant. Returned only when the request includes WEBSOCKET in ConnectionTypes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • websocket

      default StartChatContactResponse.Builder websocket(Consumer<Websocket.Builder> websocket)

      The websocket for the chat participant. Returned only when the request includes WEBSOCKET in ConnectionTypes.

      This is a convenience method that creates an instance of the Websocket.Builder avoiding the need to create one manually via Websocket.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to websocket(Websocket).

      Parameters:
      websocket - a consumer that will call methods on Websocket.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamingId

      StartChatContactResponse.Builder streamingId(String streamingId)

      The identifier of the streaming configuration enabled with the chat. Returned only when the request sets ChatStreamingConfiguration. Use this value to call StopContactStreaming.

      Parameters:
      streamingId - The identifier of the streaming configuration enabled with the chat. Returned only when the request sets ChatStreamingConfiguration. Use this value to call StopContactStreaming.
      Returns:
      Returns a reference to this object so that method calls can be chained together.