Class: Aws::ChimeSDKMessaging::Types::ChannelMessage

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

Overview

The details of a message in a channel.

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#channel_arn ⇒ String

The ARN of the channel.

Returns:

  • (String) 


641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 641

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

#content ⇒ String

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) 


641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 641

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

#content_type ⇒ String

The content type of the channel message. 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) 


641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 641

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

#created_timestamp ⇒ Time

The time at which the message was created.

Returns:

  • (Time) 


641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 641

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

#last_edited_timestamp ⇒ Time

The time at which a message was edited.

Returns:

  • (Time) 


641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 641

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

#last_updated_timestamp ⇒ Time

The time at which a message was updated.

Returns:

  • (Time) 


641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 641

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

#message_attributes ⇒ Hash<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:



641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 641

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

#message_id ⇒ String

The ID of a message.

Returns:

  • (String) 


641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 641

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

#metadata ⇒ String

The message metadata.

Returns:

  • (String) 


641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 641

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

#persistence ⇒ String

The persistence setting for a channel message.

Returns:

  • (String) 


641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 641

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

#redacted ⇒ Boolean

Hides the content of a message.

Returns:

  • (Boolean) 


641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 641

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

#sender ⇒ Types::Identity

The message sender.

Returns:



641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 641

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

#status ⇒ Types::ChannelMessageStatusStructure

The status of the channel message.

Returns:



641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 641

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

#sub_channel_id ⇒ String

The ID of the SubChannel.

Returns:

  • (String) 


641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 641

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

#target ⇒ Array<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:



641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 641

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

#type ⇒ String

The message type.

Returns:

  • (String) 


641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 641

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