#[non_exhaustive]pub struct UserDataBuilder { /* private fields */ }
Expand description
A builder for UserData
.
Implementations§
Source§impl UserDataBuilder
impl UserDataBuilder
Sourcepub fn user(self, input: UserReference) -> Self
pub fn user(self, input: UserReference) -> Self
Information about the user for the data that is returned. It contains the resourceId
and ARN of the user.
Sourcepub fn set_user(self, input: Option<UserReference>) -> Self
pub fn set_user(self, input: Option<UserReference>) -> Self
Information about the user for the data that is returned. It contains the resourceId
and ARN of the user.
Sourcepub fn get_user(&self) -> &Option<UserReference>
pub fn get_user(&self) -> &Option<UserReference>
Information about the user for the data that is returned. It contains the resourceId
and ARN of the user.
Sourcepub fn routing_profile(self, input: RoutingProfileReference) -> Self
pub fn routing_profile(self, input: RoutingProfileReference) -> Self
Information about the routing profile that is assigned to the user.
Sourcepub fn set_routing_profile(self, input: Option<RoutingProfileReference>) -> Self
pub fn set_routing_profile(self, input: Option<RoutingProfileReference>) -> Self
Information about the routing profile that is assigned to the user.
Sourcepub fn get_routing_profile(&self) -> &Option<RoutingProfileReference>
pub fn get_routing_profile(&self) -> &Option<RoutingProfileReference>
Information about the routing profile that is assigned to the user.
Sourcepub fn hierarchy_path(self, input: HierarchyPathReference) -> Self
pub fn hierarchy_path(self, input: HierarchyPathReference) -> Self
Contains information about the levels of a hierarchy group assigned to a user.
Sourcepub fn set_hierarchy_path(self, input: Option<HierarchyPathReference>) -> Self
pub fn set_hierarchy_path(self, input: Option<HierarchyPathReference>) -> Self
Contains information about the levels of a hierarchy group assigned to a user.
Sourcepub fn get_hierarchy_path(&self) -> &Option<HierarchyPathReference>
pub fn get_hierarchy_path(&self) -> &Option<HierarchyPathReference>
Contains information about the levels of a hierarchy group assigned to a user.
Sourcepub fn status(self, input: AgentStatusReference) -> Self
pub fn status(self, input: AgentStatusReference) -> Self
The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.
Sourcepub fn set_status(self, input: Option<AgentStatusReference>) -> Self
pub fn set_status(self, input: Option<AgentStatusReference>) -> Self
The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.
Sourcepub fn get_status(&self) -> &Option<AgentStatusReference>
pub fn get_status(&self) -> &Option<AgentStatusReference>
The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.
Sourcepub fn available_slots_by_channel(self, k: Channel, v: i32) -> Self
pub fn available_slots_by_channel(self, k: Channel, v: i32) -> Self
Adds a key-value pair to available_slots_by_channel
.
To override the contents of this collection use set_available_slots_by_channel
.
A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
Sourcepub fn set_available_slots_by_channel(
self,
input: Option<HashMap<Channel, i32>>,
) -> Self
pub fn set_available_slots_by_channel( self, input: Option<HashMap<Channel, i32>>, ) -> Self
A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
Sourcepub fn get_available_slots_by_channel(&self) -> &Option<HashMap<Channel, i32>>
pub fn get_available_slots_by_channel(&self) -> &Option<HashMap<Channel, i32>>
A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
Sourcepub fn max_slots_by_channel(self, k: Channel, v: i32) -> Self
pub fn max_slots_by_channel(self, k: Channel, v: i32) -> Self
Adds a key-value pair to max_slots_by_channel
.
To override the contents of this collection use set_max_slots_by_channel
.
A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile
assigned to the agent.
Sourcepub fn set_max_slots_by_channel(
self,
input: Option<HashMap<Channel, i32>>,
) -> Self
pub fn set_max_slots_by_channel( self, input: Option<HashMap<Channel, i32>>, ) -> Self
A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile
assigned to the agent.
Sourcepub fn get_max_slots_by_channel(&self) -> &Option<HashMap<Channel, i32>>
pub fn get_max_slots_by_channel(&self) -> &Option<HashMap<Channel, i32>>
A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile
assigned to the agent.
Sourcepub fn active_slots_by_channel(self, k: Channel, v: i32) -> Self
pub fn active_slots_by_channel(self, k: Channel, v: i32) -> Self
Adds a key-value pair to active_slots_by_channel
.
To override the contents of this collection use set_active_slots_by_channel
.
A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
Sourcepub fn set_active_slots_by_channel(
self,
input: Option<HashMap<Channel, i32>>,
) -> Self
pub fn set_active_slots_by_channel( self, input: Option<HashMap<Channel, i32>>, ) -> Self
A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
Sourcepub fn get_active_slots_by_channel(&self) -> &Option<HashMap<Channel, i32>>
pub fn get_active_slots_by_channel(&self) -> &Option<HashMap<Channel, i32>>
A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
Sourcepub fn contacts(self, input: AgentContactReference) -> Self
pub fn contacts(self, input: AgentContactReference) -> Self
Appends an item to contacts
.
To override the contents of this collection use set_contacts
.
A list of contact reference information.
Sourcepub fn set_contacts(self, input: Option<Vec<AgentContactReference>>) -> Self
pub fn set_contacts(self, input: Option<Vec<AgentContactReference>>) -> Self
A list of contact reference information.
Sourcepub fn get_contacts(&self) -> &Option<Vec<AgentContactReference>>
pub fn get_contacts(&self) -> &Option<Vec<AgentContactReference>>
A list of contact reference information.
Sourcepub fn next_status(self, input: impl Into<String>) -> Self
pub fn next_status(self, input: impl Into<String>) -> Self
The Next status of the agent.
Sourcepub fn set_next_status(self, input: Option<String>) -> Self
pub fn set_next_status(self, input: Option<String>) -> Self
The Next status of the agent.
Sourcepub fn get_next_status(&self) -> &Option<String>
pub fn get_next_status(&self) -> &Option<String>
The Next status of the agent.
Trait Implementations§
Source§impl Clone for UserDataBuilder
impl Clone for UserDataBuilder
Source§fn clone(&self) -> UserDataBuilder
fn clone(&self) -> UserDataBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for UserDataBuilder
impl Debug for UserDataBuilder
Source§impl Default for UserDataBuilder
impl Default for UserDataBuilder
Source§fn default() -> UserDataBuilder
fn default() -> UserDataBuilder
Source§impl PartialEq for UserDataBuilder
impl PartialEq for UserDataBuilder
impl StructuralPartialEq for UserDataBuilder
Auto Trait Implementations§
impl Freeze for UserDataBuilder
impl RefUnwindSafe for UserDataBuilder
impl Send for UserDataBuilder
impl Sync for UserDataBuilder
impl Unpin for UserDataBuilder
impl UnwindSafe for UserDataBuilder
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);