Class: Aws::Connect::Types::ChatEvent

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-connect/types.rb

Overview

Chat integration event containing payload to perform different chat actions such as:

  • Sending a chat message

  • Sending a chat event, such as typing

  • Disconnecting from a chat

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#content ⇒ String

Content of the message or event. This is required when ‘Type` is `MESSAGE` and for certain `ContentTypes` when `Type` is `EVENT`.

  • For allowed message content, see the ‘Content` parameter in the

    SendMessage][1

    topic in the *Amazon Connect Participant Service

    API Reference*.

  • For allowed event content, see the ‘Content` parameter in the

    SendEvent][2

    topic in the *Amazon Connect Participant Service

    API Reference*.

[1]: docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html [2]: docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html

Returns:

  • (String) 


1896
1897
1898
1899
1900
1901
1902
 
# File 'lib/aws-sdk-connect/types.rb', line 1896

class ChatEvent < Struct.new(
  :type,
  :content_type,
  :content)
  SENSITIVE = []
  include Aws::Structure
end

#content_type ⇒ String

Type of content. This is required when ‘Type` is `MESSAGE` or `EVENT`.

  • For allowed message content types, see the ‘ContentType` parameter in the [SendMessage] topic in the *Amazon Connect Participant Service API Reference*.

  • For allowed event content types, see the ‘ContentType` parameter in the [SendEvent] topic in the *Amazon Connect Participant Service API Reference*.

[1]: docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html [2]: docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html

Returns:

  • (String) 


1896
1897
1898
1899
1900
1901
1902
 
# File 'lib/aws-sdk-connect/types.rb', line 1896

class ChatEvent < Struct.new(
  :type,
  :content_type,
  :content)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

Type of chat integration event.

Returns:

  • (String) 


1896
1897
1898
1899
1900
1901
1902
 
# File 'lib/aws-sdk-connect/types.rb', line 1896

class ChatEvent < Struct.new(
  :type,
  :content_type,
  :content)
  SENSITIVE = []
  include Aws::Structure
end