#[non_exhaustive]pub struct ItemBuilder { /* private fields */ }
Expand description
A builder for Item
.
Implementations§
Source§impl ItemBuilder
impl ItemBuilder
Sourcepub fn absolute_time(self, input: impl Into<String>) -> Self
pub fn absolute_time(self, input: impl Into<String>) -> Self
The time when the message or event was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
Sourcepub fn set_absolute_time(self, input: Option<String>) -> Self
pub fn set_absolute_time(self, input: Option<String>) -> Self
The time when the message or event was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
Sourcepub fn get_absolute_time(&self) -> &Option<String>
pub fn get_absolute_time(&self) -> &Option<String>
The time when the message or event was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
Sourcepub fn set_content(self, input: Option<String>) -> Self
pub fn set_content(self, input: Option<String>) -> Self
The content of the message or event.
Sourcepub fn get_content(&self) -> &Option<String>
pub fn get_content(&self) -> &Option<String>
The content of the message or event.
Sourcepub fn content_type(self, input: impl Into<String>) -> Self
pub fn content_type(self, input: impl Into<String>) -> Self
The type of content of the item.
Sourcepub fn set_content_type(self, input: Option<String>) -> Self
pub fn set_content_type(self, input: Option<String>) -> Self
The type of content of the item.
Sourcepub fn get_content_type(&self) -> &Option<String>
pub fn get_content_type(&self) -> &Option<String>
The type of content of the item.
Sourcepub fn type(self, input: ChatItemType) -> Self
pub fn type(self, input: ChatItemType) -> Self
Type of the item: message or event.
Sourcepub fn set_type(self, input: Option<ChatItemType>) -> Self
pub fn set_type(self, input: Option<ChatItemType>) -> Self
Type of the item: message or event.
Sourcepub fn get_type(&self) -> &Option<ChatItemType>
pub fn get_type(&self) -> &Option<ChatItemType>
Type of the item: message or event.
Sourcepub fn participant_id(self, input: impl Into<String>) -> Self
pub fn participant_id(self, input: impl Into<String>) -> Self
The ID of the sender in the session.
Sourcepub fn set_participant_id(self, input: Option<String>) -> Self
pub fn set_participant_id(self, input: Option<String>) -> Self
The ID of the sender in the session.
Sourcepub fn get_participant_id(&self) -> &Option<String>
pub fn get_participant_id(&self) -> &Option<String>
The ID of the sender in the session.
Sourcepub fn display_name(self, input: impl Into<String>) -> Self
pub fn display_name(self, input: impl Into<String>) -> Self
The chat display name of the sender.
Sourcepub fn set_display_name(self, input: Option<String>) -> Self
pub fn set_display_name(self, input: Option<String>) -> Self
The chat display name of the sender.
Sourcepub fn get_display_name(&self) -> &Option<String>
pub fn get_display_name(&self) -> &Option<String>
The chat display name of the sender.
Sourcepub fn participant_role(self, input: ParticipantRole) -> Self
pub fn participant_role(self, input: ParticipantRole) -> Self
The role of the sender. For example, is it a customer, agent, or system.
Sourcepub fn set_participant_role(self, input: Option<ParticipantRole>) -> Self
pub fn set_participant_role(self, input: Option<ParticipantRole>) -> Self
The role of the sender. For example, is it a customer, agent, or system.
Sourcepub fn get_participant_role(&self) -> &Option<ParticipantRole>
pub fn get_participant_role(&self) -> &Option<ParticipantRole>
The role of the sender. For example, is it a customer, agent, or system.
Sourcepub fn attachments(self, input: AttachmentItem) -> Self
pub fn attachments(self, input: AttachmentItem) -> Self
Appends an item to attachments
.
To override the contents of this collection use set_attachments
.
Provides information about the attachments.
Sourcepub fn set_attachments(self, input: Option<Vec<AttachmentItem>>) -> Self
pub fn set_attachments(self, input: Option<Vec<AttachmentItem>>) -> Self
Provides information about the attachments.
Sourcepub fn get_attachments(&self) -> &Option<Vec<AttachmentItem>>
pub fn get_attachments(&self) -> &Option<Vec<AttachmentItem>>
Provides information about the attachments.
Sourcepub fn message_metadata(self, input: MessageMetadata) -> Self
pub fn message_metadata(self, input: MessageMetadata) -> Self
The metadata related to the message. Currently this supports only information related to message receipts.
Sourcepub fn set_message_metadata(self, input: Option<MessageMetadata>) -> Self
pub fn set_message_metadata(self, input: Option<MessageMetadata>) -> Self
The metadata related to the message. Currently this supports only information related to message receipts.
Sourcepub fn get_message_metadata(&self) -> &Option<MessageMetadata>
pub fn get_message_metadata(&self) -> &Option<MessageMetadata>
The metadata related to the message. Currently this supports only information related to message receipts.
The contactId on which the transcript item was originally sent. This field is only populated for persistent chats when the transcript item is from the past chat session. For more information, see Enable persistent chat.
The contactId on which the transcript item was originally sent. This field is only populated for persistent chats when the transcript item is from the past chat session. For more information, see Enable persistent chat.
The contactId on which the transcript item was originally sent. This field is only populated for persistent chats when the transcript item is from the past chat session. For more information, see Enable persistent chat.
Sourcepub fn contact_id(self, input: impl Into<String>) -> Self
pub fn contact_id(self, input: impl Into<String>) -> Self
The contactId on which the transcript item was originally sent. This field is populated only when the transcript item is from the current chat session.
Sourcepub fn set_contact_id(self, input: Option<String>) -> Self
pub fn set_contact_id(self, input: Option<String>) -> Self
The contactId on which the transcript item was originally sent. This field is populated only when the transcript item is from the current chat session.
Sourcepub fn get_contact_id(&self) -> &Option<String>
pub fn get_contact_id(&self) -> &Option<String>
The contactId on which the transcript item was originally sent. This field is populated only when the transcript item is from the current chat session.
Trait Implementations§
Source§impl Clone for ItemBuilder
impl Clone for ItemBuilder
Source§fn clone(&self) -> ItemBuilder
fn clone(&self) -> ItemBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ItemBuilder
impl Debug for ItemBuilder
Source§impl Default for ItemBuilder
impl Default for ItemBuilder
Source§fn default() -> ItemBuilder
fn default() -> ItemBuilder
Source§impl PartialEq for ItemBuilder
impl PartialEq for ItemBuilder
impl StructuralPartialEq for ItemBuilder
Auto Trait Implementations§
impl Freeze for ItemBuilder
impl RefUnwindSafe for ItemBuilder
impl Send for ItemBuilder
impl Sync for ItemBuilder
impl Unpin for ItemBuilder
impl UnwindSafe for ItemBuilder
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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);