#[non_exhaustive]pub struct ChannelMessageBuilder { /* private fields */ }
Expand description
A builder for ChannelMessage
.
Implementations§
Source§impl ChannelMessageBuilder
impl ChannelMessageBuilder
Sourcepub fn channel_arn(self, input: impl Into<String>) -> Self
pub fn channel_arn(self, input: impl Into<String>) -> Self
The ARN of the channel.
Sourcepub fn set_channel_arn(self, input: Option<String>) -> Self
pub fn set_channel_arn(self, input: Option<String>) -> Self
The ARN of the channel.
Sourcepub fn get_channel_arn(&self) -> &Option<String>
pub fn get_channel_arn(&self) -> &Option<String>
The ARN of the channel.
Sourcepub fn message_id(self, input: impl Into<String>) -> Self
pub fn message_id(self, input: impl Into<String>) -> Self
The ID of a message.
Sourcepub fn set_message_id(self, input: Option<String>) -> Self
pub fn set_message_id(self, input: Option<String>) -> Self
The ID of a message.
Sourcepub fn get_message_id(&self) -> &Option<String>
pub fn get_message_id(&self) -> &Option<String>
The ID of a message.
Sourcepub fn content(self, input: impl Into<String>) -> Self
pub fn content(self, input: impl Into<String>) -> Self
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 set_content(self, input: Option<String>) -> Self
pub fn set_content(self, input: Option<String>) -> Self
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 get_content(&self) -> &Option<String>
pub fn get_content(&self) -> &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.
Sourcepub fn set_metadata(self, input: Option<String>) -> Self
pub fn set_metadata(self, input: Option<String>) -> Self
The message metadata.
Sourcepub fn get_metadata(&self) -> &Option<String>
pub fn get_metadata(&self) -> &Option<String>
The message metadata.
Sourcepub fn type(self, input: ChannelMessageType) -> Self
pub fn type(self, input: ChannelMessageType) -> Self
The message type.
Sourcepub fn set_type(self, input: Option<ChannelMessageType>) -> Self
pub fn set_type(self, input: Option<ChannelMessageType>) -> Self
The message type.
Sourcepub fn get_type(&self) -> &Option<ChannelMessageType>
pub fn get_type(&self) -> &Option<ChannelMessageType>
The message type.
Sourcepub fn created_timestamp(self, input: DateTime) -> Self
pub fn created_timestamp(self, input: DateTime) -> Self
The time at which the message was created.
Sourcepub fn set_created_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_created_timestamp(self, input: Option<DateTime>) -> Self
The time at which the message was created.
Sourcepub fn get_created_timestamp(&self) -> &Option<DateTime>
pub fn get_created_timestamp(&self) -> &Option<DateTime>
The time at which the message was created.
Sourcepub fn last_edited_timestamp(self, input: DateTime) -> Self
pub fn last_edited_timestamp(self, input: DateTime) -> Self
The time at which a message was edited.
Sourcepub fn set_last_edited_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_last_edited_timestamp(self, input: Option<DateTime>) -> Self
The time at which a message was edited.
Sourcepub fn get_last_edited_timestamp(&self) -> &Option<DateTime>
pub fn get_last_edited_timestamp(&self) -> &Option<DateTime>
The time at which a message was edited.
Sourcepub fn last_updated_timestamp(self, input: DateTime) -> Self
pub fn last_updated_timestamp(self, input: DateTime) -> Self
The time at which a message was updated.
Sourcepub fn set_last_updated_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_last_updated_timestamp(self, input: Option<DateTime>) -> Self
The time at which a message was updated.
Sourcepub fn get_last_updated_timestamp(&self) -> &Option<DateTime>
pub fn get_last_updated_timestamp(&self) -> &Option<DateTime>
The time at which a message was updated.
Sourcepub fn set_sender(self, input: Option<Identity>) -> Self
pub fn set_sender(self, input: Option<Identity>) -> Self
The message sender.
Sourcepub fn get_sender(&self) -> &Option<Identity>
pub fn get_sender(&self) -> &Option<Identity>
The message sender.
Sourcepub fn set_redacted(self, input: Option<bool>) -> Self
pub fn set_redacted(self, input: Option<bool>) -> Self
Hides the content of a message.
Sourcepub fn get_redacted(&self) -> &Option<bool>
pub fn get_redacted(&self) -> &Option<bool>
Hides the content of a message.
Sourcepub fn persistence(self, input: ChannelMessagePersistenceType) -> Self
pub fn persistence(self, input: ChannelMessagePersistenceType) -> Self
The persistence setting for a channel message.
Sourcepub fn set_persistence(
self,
input: Option<ChannelMessagePersistenceType>,
) -> Self
pub fn set_persistence( self, input: Option<ChannelMessagePersistenceType>, ) -> Self
The persistence setting for a channel message.
Sourcepub fn get_persistence(&self) -> &Option<ChannelMessagePersistenceType>
pub fn get_persistence(&self) -> &Option<ChannelMessagePersistenceType>
The persistence setting for a channel message.
Sourcepub fn status(self, input: ChannelMessageStatusStructure) -> Self
pub fn status(self, input: ChannelMessageStatusStructure) -> Self
The status of the channel message.
Sourcepub fn set_status(self, input: Option<ChannelMessageStatusStructure>) -> Self
pub fn set_status(self, input: Option<ChannelMessageStatusStructure>) -> Self
The status of the channel message.
Sourcepub fn get_status(&self) -> &Option<ChannelMessageStatusStructure>
pub fn get_status(&self) -> &Option<ChannelMessageStatusStructure>
The status of the channel message.
Sourcepub fn message_attributes(
self,
k: impl Into<String>,
v: MessageAttributeValue,
) -> Self
pub fn message_attributes( self, k: impl Into<String>, v: MessageAttributeValue, ) -> Self
Adds a key-value pair to message_attributes
.
To override the contents of this collection use set_message_attributes
.
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 set_message_attributes(
self,
input: Option<HashMap<String, MessageAttributeValue>>,
) -> Self
pub fn set_message_attributes( self, input: Option<HashMap<String, MessageAttributeValue>>, ) -> Self
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 get_message_attributes(
&self,
) -> &Option<HashMap<String, MessageAttributeValue>>
pub fn get_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, input: impl Into<String>) -> Self
pub fn sub_channel_id(self, input: impl Into<String>) -> Self
The ID of the SubChannel.
Sourcepub fn set_sub_channel_id(self, input: Option<String>) -> Self
pub fn set_sub_channel_id(self, input: Option<String>) -> Self
The ID of the SubChannel.
Sourcepub fn get_sub_channel_id(&self) -> &Option<String>
pub fn get_sub_channel_id(&self) -> &Option<String>
The ID of the SubChannel.
Sourcepub fn content_type(self, input: impl Into<String>) -> Self
pub fn content_type(self, input: impl Into<String>) -> Self
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 set_content_type(self, input: Option<String>) -> Self
pub fn set_content_type(self, input: Option<String>) -> Self
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 get_content_type(&self) -> &Option<String>
pub fn get_content_type(&self) -> &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.
Sourcepub fn target(self, input: Target) -> Self
pub fn target(self, input: Target) -> Self
Appends an item to target
.
To override the contents of this collection use set_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.
Sourcepub fn set_target(self, input: Option<Vec<Target>>) -> Self
pub fn set_target(self, input: Option<Vec<Target>>) -> Self
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.
Sourcepub fn get_target(&self) -> &Option<Vec<Target>>
pub fn get_target(&self) -> &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.
Sourcepub fn build(self) -> ChannelMessage
pub fn build(self) -> ChannelMessage
Consumes the builder and constructs a ChannelMessage
.
Trait Implementations§
Source§impl Clone for ChannelMessageBuilder
impl Clone for ChannelMessageBuilder
Source§fn clone(&self) -> ChannelMessageBuilder
fn clone(&self) -> ChannelMessageBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ChannelMessageBuilder
impl Debug for ChannelMessageBuilder
Source§impl Default for ChannelMessageBuilder
impl Default for ChannelMessageBuilder
Source§fn default() -> ChannelMessageBuilder
fn default() -> ChannelMessageBuilder
Source§impl PartialEq for ChannelMessageBuilder
impl PartialEq for ChannelMessageBuilder
impl StructuralPartialEq for ChannelMessageBuilder
Auto Trait Implementations§
impl Freeze for ChannelMessageBuilder
impl RefUnwindSafe for ChannelMessageBuilder
impl Send for ChannelMessageBuilder
impl Sync for ChannelMessageBuilder
impl Unpin for ChannelMessageBuilder
impl UnwindSafe for ChannelMessageBuilder
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);