Class: Aws::Connect::Types::StartChatContactResponse

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::StartChatContactResponse

Defined in:

gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #connection_credentials ⇒ Types::ConnectionCredentials

  The connection credentials for the chat participant.

• #contact_id ⇒ String

  The identifier of this contact within the Connect Customer instance.

• #continued_from_contact_id ⇒ String

  The contactId from which a persistent chat session is started.

• #participant_id ⇒ String

  The identifier for a chat participant.

• #participant_token ⇒ String

  The token used by the chat participant to call [CreateParticipantConnection][1].

• #streaming_id ⇒ String

  The identifier of the streaming configuration enabled with the chat.

• #websocket ⇒ Types::Websocket

  The websocket for the chat participant.

Instance Attribute Details

#connection_credentials ⇒ Types::ConnectionCredentials

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

Returns:

• (Types::ConnectionCredentials)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 35161

class StartChatContactResponse < Struct.new(
  :contact_id,
  :participant_id,
  :participant_token,
  :continued_from_contact_id,
  :connection_credentials,
  :websocket,
  :streaming_id)
  SENSITIVE = []
  include Aws::Structure
end

#contact_id ⇒ String

The identifier of this contact within the Connect Customer instance.

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 35161

class StartChatContactResponse < Struct.new(
  :contact_id,
  :participant_id,
  :participant_token,
  :continued_from_contact_id,
  :connection_credentials,
  :websocket,
  :streaming_id)
  SENSITIVE = []
  include Aws::Structure
end

#continued_from_contact_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 35161

class StartChatContactResponse < Struct.new(
  :contact_id,
  :participant_id,
  :participant_token,
  :continued_from_contact_id,
  :connection_credentials,
  :websocket,
  :streaming_id)
  SENSITIVE = []
  include Aws::Structure
end

#participant_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 35161

class StartChatContactResponse < Struct.new(
  :contact_id,
  :participant_id,
  :participant_token,
  :continued_from_contact_id,
  :connection_credentials,
  :websocket,
  :streaming_id)
  SENSITIVE = []
  include Aws::Structure
end

#participant_token ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 35161

class StartChatContactResponse < Struct.new(
  :contact_id,
  :participant_id,
  :participant_token,
  :continued_from_contact_id,
  :connection_credentials,
  :websocket,
  :streaming_id)
  SENSITIVE = []
  include Aws::Structure
end

#streaming_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 35161

class StartChatContactResponse < Struct.new(
  :contact_id,
  :participant_id,
  :participant_token,
  :continued_from_contact_id,
  :connection_credentials,
  :websocket,
  :streaming_id)
  SENSITIVE = []
  include Aws::Structure
end

#websocket ⇒ Types::Websocket

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

Returns:

• (Types::Websocket)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 35161

class StartChatContactResponse < Struct.new(
  :contact_id,
  :participant_id,
  :participant_token,
  :continued_from_contact_id,
  :connection_credentials,
  :websocket,
  :streaming_id)
  SENSITIVE = []
  include Aws::Structure
end