Class: Aws::ChimeSDKMessaging::Types::ChannelMessageSummary

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

Overview

Summary of the messages in a ‘Channel`.

Constant Summary collapse

SENSITIVE =
[:content, :metadata, :message_attributes, :content_type]

Instance Attribute Summary collapse

Instance Attribute Details

#contentString

The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to [Processing responses from an AppInstanceBot] in the *Amazon Chime SDK Messaging Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html

Returns:

  • (String)


837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 837

class ChannelMessageSummary < Struct.new(
  :message_id,
  :content,
  :metadata,
  :type,
  :created_timestamp,
  :last_updated_timestamp,
  :last_edited_timestamp,
  :sender,
  :redacted,
  :status,
  :message_attributes,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :message_attributes, :content_type]
  include Aws::Structure
end

#content_typeString

The content type of the channel message listed in the summary. For Amazon Lex V2 bot responses, the content type is ‘application/amz-chime-lex-msgs` for success responses and `application/amz-chime-lex-error` for failure responses. For more information, refer to [Processing responses from an AppInstanceBot] in the *Amazon Chime SDK Messaging Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html

Returns:

  • (String)


837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 837

class ChannelMessageSummary < Struct.new(
  :message_id,
  :content,
  :metadata,
  :type,
  :created_timestamp,
  :last_updated_timestamp,
  :last_edited_timestamp,
  :sender,
  :redacted,
  :status,
  :message_attributes,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :message_attributes, :content_type]
  include Aws::Structure
end

#created_timestampTime

The time at which the message summary was created.

Returns:

  • (Time)


837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 837

class ChannelMessageSummary < Struct.new(
  :message_id,
  :content,
  :metadata,
  :type,
  :created_timestamp,
  :last_updated_timestamp,
  :last_edited_timestamp,
  :sender,
  :redacted,
  :status,
  :message_attributes,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :message_attributes, :content_type]
  include Aws::Structure
end

#last_edited_timestampTime

The time at which a message was last edited.

Returns:

  • (Time)


837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 837

class ChannelMessageSummary < Struct.new(
  :message_id,
  :content,
  :metadata,
  :type,
  :created_timestamp,
  :last_updated_timestamp,
  :last_edited_timestamp,
  :sender,
  :redacted,
  :status,
  :message_attributes,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :message_attributes, :content_type]
  include Aws::Structure
end

#last_updated_timestampTime

The time at which a message was last updated.

Returns:

  • (Time)


837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 837

class ChannelMessageSummary < Struct.new(
  :message_id,
  :content,
  :metadata,
  :type,
  :created_timestamp,
  :last_updated_timestamp,
  :last_edited_timestamp,
  :sender,
  :redacted,
  :status,
  :message_attributes,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :message_attributes, :content_type]
  include Aws::Structure
end

#message_attributesHash<String,Types::MessageAttributeValue>

The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to [Processing responses from an AppInstanceBot] in the *Amazon Chime SDK Messaging Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html

Returns:



837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 837

class ChannelMessageSummary < Struct.new(
  :message_id,
  :content,
  :metadata,
  :type,
  :created_timestamp,
  :last_updated_timestamp,
  :last_edited_timestamp,
  :sender,
  :redacted,
  :status,
  :message_attributes,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :message_attributes, :content_type]
  include Aws::Structure
end

#message_idString

The ID of the message.

Returns:

  • (String)


837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 837

class ChannelMessageSummary < Struct.new(
  :message_id,
  :content,
  :metadata,
  :type,
  :created_timestamp,
  :last_updated_timestamp,
  :last_edited_timestamp,
  :sender,
  :redacted,
  :status,
  :message_attributes,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :message_attributes, :content_type]
  include Aws::Structure
end

#metadataString

The metadata of the message.

Returns:

  • (String)


837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 837

class ChannelMessageSummary < Struct.new(
  :message_id,
  :content,
  :metadata,
  :type,
  :created_timestamp,
  :last_updated_timestamp,
  :last_edited_timestamp,
  :sender,
  :redacted,
  :status,
  :message_attributes,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :message_attributes, :content_type]
  include Aws::Structure
end

#redactedBoolean

Indicates whether a message was redacted.

Returns:

  • (Boolean)


837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 837

class ChannelMessageSummary < Struct.new(
  :message_id,
  :content,
  :metadata,
  :type,
  :created_timestamp,
  :last_updated_timestamp,
  :last_edited_timestamp,
  :sender,
  :redacted,
  :status,
  :message_attributes,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :message_attributes, :content_type]
  include Aws::Structure
end

#senderTypes::Identity

The message sender.

Returns:



837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 837

class ChannelMessageSummary < Struct.new(
  :message_id,
  :content,
  :metadata,
  :type,
  :created_timestamp,
  :last_updated_timestamp,
  :last_edited_timestamp,
  :sender,
  :redacted,
  :status,
  :message_attributes,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :message_attributes, :content_type]
  include Aws::Structure
end

#statusTypes::ChannelMessageStatusStructure

The message status. The status value is ‘SENT` for messages sent to a channel without a channel flow. For channels associated with channel flow, the value determines the processing stage.



837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 837

class ChannelMessageSummary < Struct.new(
  :message_id,
  :content,
  :metadata,
  :type,
  :created_timestamp,
  :last_updated_timestamp,
  :last_edited_timestamp,
  :sender,
  :redacted,
  :status,
  :message_attributes,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :message_attributes, :content_type]
  include Aws::Structure
end

#targetArray<Types::Target>

The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

Returns:



837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 837

class ChannelMessageSummary < Struct.new(
  :message_id,
  :content,
  :metadata,
  :type,
  :created_timestamp,
  :last_updated_timestamp,
  :last_edited_timestamp,
  :sender,
  :redacted,
  :status,
  :message_attributes,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :message_attributes, :content_type]
  include Aws::Structure
end

#typeString

The type of message.

Returns:

  • (String)


837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 837

class ChannelMessageSummary < Struct.new(
  :message_id,
  :content,
  :metadata,
  :type,
  :created_timestamp,
  :last_updated_timestamp,
  :last_edited_timestamp,
  :sender,
  :redacted,
  :status,
  :message_attributes,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :message_attributes, :content_type]
  include Aws::Structure
end