#[non_exhaustive]pub struct ChannelMessage {Show 16 fields
pub channel_arn: Option<String>,
pub message_id: Option<String>,
pub content: Option<String>,
pub metadata: Option<String>,
pub type: Option<ChannelMessageType>,
pub created_timestamp: Option<DateTime>,
pub last_edited_timestamp: Option<DateTime>,
pub last_updated_timestamp: Option<DateTime>,
pub sender: Option<Identity>,
pub redacted: bool,
pub persistence: Option<ChannelMessagePersistenceType>,
pub status: Option<ChannelMessageStatusStructure>,
pub message_attributes: Option<HashMap<String, MessageAttributeValue>>,
pub sub_channel_id: Option<String>,
pub content_type: Option<String>,
pub target: Option<Vec<Target>>,
}
Expand description
The details of a message in a channel.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.channel_arn: Option<String>
The ARN of the channel.
message_id: Option<String>
The ID of a message.
content: Option<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.
metadata: Option<String>
The message metadata.
type: Option<ChannelMessageType>
The message type.
created_timestamp: Option<DateTime>
The time at which the message was created.
last_edited_timestamp: Option<DateTime>
The time at which a message was edited.
last_updated_timestamp: Option<DateTime>
The time at which a message was updated.
sender: Option<Identity>
The message sender.
redacted: bool
Hides the content of a message.
persistence: Option<ChannelMessagePersistenceType>
The persistence setting for a channel message.
status: Option<ChannelMessageStatusStructure>
The status of the channel message.
message_attributes: Option<HashMap<String, 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.
sub_channel_id: Option<String>
The ID of the SubChannel.
content_type: Option<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.
target: Option<Vec<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.
Implementations§
Source§impl ChannelMessage
impl ChannelMessage
Sourcepub fn channel_arn(&self) -> Option<&str>
pub fn channel_arn(&self) -> Option<&str>
The ARN of the channel.
Sourcepub fn message_id(&self) -> Option<&str>
pub fn message_id(&self) -> Option<&str>
The ID of a message.
Sourcepub fn content(&self) -> Option<&str>
pub fn content(&self) -> Option<&str>
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.
Sourcepub fn type(&self) -> Option<&ChannelMessageType>
pub fn type(&self) -> Option<&ChannelMessageType>
The message type.
Sourcepub fn created_timestamp(&self) -> Option<&DateTime>
pub fn created_timestamp(&self) -> Option<&DateTime>
The time at which the message was created.
Sourcepub fn last_edited_timestamp(&self) -> Option<&DateTime>
pub fn last_edited_timestamp(&self) -> Option<&DateTime>
The time at which a message was edited.
Sourcepub fn last_updated_timestamp(&self) -> Option<&DateTime>
pub fn last_updated_timestamp(&self) -> Option<&DateTime>
The time at which a message was updated.
Sourcepub fn persistence(&self) -> Option<&ChannelMessagePersistenceType>
pub fn persistence(&self) -> Option<&ChannelMessagePersistenceType>
The persistence setting for a channel message.
Sourcepub fn status(&self) -> Option<&ChannelMessageStatusStructure>
pub fn status(&self) -> Option<&ChannelMessageStatusStructure>
The status of the channel message.
Sourcepub fn message_attributes(
&self,
) -> Option<&HashMap<String, MessageAttributeValue>>
pub fn message_attributes( &self, ) -> Option<&HashMap<String, 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.
Sourcepub fn sub_channel_id(&self) -> Option<&str>
pub fn sub_channel_id(&self) -> Option<&str>
The ID of the SubChannel.
Sourcepub fn content_type(&self) -> Option<&str>
pub fn content_type(&self) -> Option<&str>
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.
Sourcepub fn target(&self) -> &[Target]
pub fn target(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .target.is_none()
.
Source§impl ChannelMessage
impl ChannelMessage
Sourcepub fn builder() -> ChannelMessageBuilder
pub fn builder() -> ChannelMessageBuilder
Creates a new builder-style object to manufacture ChannelMessage
.
Trait Implementations§
Source§impl Clone for ChannelMessage
impl Clone for ChannelMessage
Source§fn clone(&self) -> ChannelMessage
fn clone(&self) -> ChannelMessage
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ChannelMessage
impl Debug for ChannelMessage
Source§impl PartialEq for ChannelMessage
impl PartialEq for ChannelMessage
impl StructuralPartialEq for ChannelMessage
Auto Trait Implementations§
impl Freeze for ChannelMessage
impl RefUnwindSafe for ChannelMessage
impl Send for ChannelMessage
impl Sync for ChannelMessage
impl Unpin for ChannelMessage
impl UnwindSafe for ChannelMessage
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);