#[non_exhaustive]pub struct RuleActionBuilder { /* private fields */ }
Expand description
A builder for RuleAction
.
Implementations§
Source§impl RuleActionBuilder
impl RuleActionBuilder
Sourcepub fn action_type(self, input: ActionType) -> Self
pub fn action_type(self, input: ActionType) -> Self
The type of action that creates a rule.
This field is required.Sourcepub fn set_action_type(self, input: Option<ActionType>) -> Self
pub fn set_action_type(self, input: Option<ActionType>) -> Self
The type of action that creates a rule.
Sourcepub fn get_action_type(&self) -> &Option<ActionType>
pub fn get_action_type(&self) -> &Option<ActionType>
The type of action that creates a rule.
Sourcepub fn task_action(self, input: TaskActionDefinition) -> Self
pub fn task_action(self, input: TaskActionDefinition) -> Self
Information about the task action. This field is required if TriggerEventSource
is one of the following values: OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
Sourcepub fn set_task_action(self, input: Option<TaskActionDefinition>) -> Self
pub fn set_task_action(self, input: Option<TaskActionDefinition>) -> Self
Information about the task action. This field is required if TriggerEventSource
is one of the following values: OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
Sourcepub fn get_task_action(&self) -> &Option<TaskActionDefinition>
pub fn get_task_action(&self) -> &Option<TaskActionDefinition>
Information about the task action. This field is required if TriggerEventSource
is one of the following values: OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
Sourcepub fn event_bridge_action(self, input: EventBridgeActionDefinition) -> Self
pub fn event_bridge_action(self, input: EventBridgeActionDefinition) -> Self
Information about the EventBridge action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
| OnMetricDataUpdate
Sourcepub fn set_event_bridge_action(
self,
input: Option<EventBridgeActionDefinition>,
) -> Self
pub fn set_event_bridge_action( self, input: Option<EventBridgeActionDefinition>, ) -> Self
Information about the EventBridge action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
| OnMetricDataUpdate
Sourcepub fn get_event_bridge_action(&self) -> &Option<EventBridgeActionDefinition>
pub fn get_event_bridge_action(&self) -> &Option<EventBridgeActionDefinition>
Information about the EventBridge action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
| OnMetricDataUpdate
Sourcepub fn assign_contact_category_action(
self,
input: AssignContactCategoryActionDefinition,
) -> Self
pub fn assign_contact_category_action( self, input: AssignContactCategoryActionDefinition, ) -> Self
Information about the contact category action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
Sourcepub fn set_assign_contact_category_action(
self,
input: Option<AssignContactCategoryActionDefinition>,
) -> Self
pub fn set_assign_contact_category_action( self, input: Option<AssignContactCategoryActionDefinition>, ) -> Self
Information about the contact category action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
Sourcepub fn get_assign_contact_category_action(
&self,
) -> &Option<AssignContactCategoryActionDefinition>
pub fn get_assign_contact_category_action( &self, ) -> &Option<AssignContactCategoryActionDefinition>
Information about the contact category action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
Sourcepub fn send_notification_action(
self,
input: SendNotificationActionDefinition,
) -> Self
pub fn send_notification_action( self, input: SendNotificationActionDefinition, ) -> Self
Information about the send notification action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
| OnMetricDataUpdate
Sourcepub fn set_send_notification_action(
self,
input: Option<SendNotificationActionDefinition>,
) -> Self
pub fn set_send_notification_action( self, input: Option<SendNotificationActionDefinition>, ) -> Self
Information about the send notification action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
| OnMetricDataUpdate
Sourcepub fn get_send_notification_action(
&self,
) -> &Option<SendNotificationActionDefinition>
pub fn get_send_notification_action( &self, ) -> &Option<SendNotificationActionDefinition>
Information about the send notification action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
| OnMetricDataUpdate
Sourcepub fn create_case_action(self, input: CreateCaseActionDefinition) -> Self
pub fn create_case_action(self, input: CreateCaseActionDefinition) -> Self
Information about the create case action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnPostChatAnalysisAvailable
.
Sourcepub fn set_create_case_action(
self,
input: Option<CreateCaseActionDefinition>,
) -> Self
pub fn set_create_case_action( self, input: Option<CreateCaseActionDefinition>, ) -> Self
Information about the create case action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnPostChatAnalysisAvailable
.
Sourcepub fn get_create_case_action(&self) -> &Option<CreateCaseActionDefinition>
pub fn get_create_case_action(&self) -> &Option<CreateCaseActionDefinition>
Information about the create case action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnPostChatAnalysisAvailable
.
Sourcepub fn update_case_action(self, input: UpdateCaseActionDefinition) -> Self
pub fn update_case_action(self, input: UpdateCaseActionDefinition) -> Self
Information about the update case action.
Supported only for TriggerEventSource
values: OnCaseCreate
| OnCaseUpdate
.
Sourcepub fn set_update_case_action(
self,
input: Option<UpdateCaseActionDefinition>,
) -> Self
pub fn set_update_case_action( self, input: Option<UpdateCaseActionDefinition>, ) -> Self
Information about the update case action.
Supported only for TriggerEventSource
values: OnCaseCreate
| OnCaseUpdate
.
Sourcepub fn get_update_case_action(&self) -> &Option<UpdateCaseActionDefinition>
pub fn get_update_case_action(&self) -> &Option<UpdateCaseActionDefinition>
Information about the update case action.
Supported only for TriggerEventSource
values: OnCaseCreate
| OnCaseUpdate
.
Sourcepub fn end_associated_tasks_action(
self,
input: EndAssociatedTasksActionDefinition,
) -> Self
pub fn end_associated_tasks_action( self, input: EndAssociatedTasksActionDefinition, ) -> Self
Information about the end associated tasks action.
Supported only for TriggerEventSource
values: OnCaseUpdate
.
Sourcepub fn set_end_associated_tasks_action(
self,
input: Option<EndAssociatedTasksActionDefinition>,
) -> Self
pub fn set_end_associated_tasks_action( self, input: Option<EndAssociatedTasksActionDefinition>, ) -> Self
Information about the end associated tasks action.
Supported only for TriggerEventSource
values: OnCaseUpdate
.
Sourcepub fn get_end_associated_tasks_action(
&self,
) -> &Option<EndAssociatedTasksActionDefinition>
pub fn get_end_associated_tasks_action( &self, ) -> &Option<EndAssociatedTasksActionDefinition>
Information about the end associated tasks action.
Supported only for TriggerEventSource
values: OnCaseUpdate
.
Sourcepub fn submit_auto_evaluation_action(
self,
input: SubmitAutoEvaluationActionDefinition,
) -> Self
pub fn submit_auto_evaluation_action( self, input: SubmitAutoEvaluationActionDefinition, ) -> Self
Information about the submit automated evaluation action.
Sourcepub fn set_submit_auto_evaluation_action(
self,
input: Option<SubmitAutoEvaluationActionDefinition>,
) -> Self
pub fn set_submit_auto_evaluation_action( self, input: Option<SubmitAutoEvaluationActionDefinition>, ) -> Self
Information about the submit automated evaluation action.
Sourcepub fn get_submit_auto_evaluation_action(
&self,
) -> &Option<SubmitAutoEvaluationActionDefinition>
pub fn get_submit_auto_evaluation_action( &self, ) -> &Option<SubmitAutoEvaluationActionDefinition>
Information about the submit automated evaluation action.
Sourcepub fn build(self) -> Result<RuleAction, BuildError>
pub fn build(self) -> Result<RuleAction, BuildError>
Consumes the builder and constructs a RuleAction
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for RuleActionBuilder
impl Clone for RuleActionBuilder
Source§fn clone(&self) -> RuleActionBuilder
fn clone(&self) -> RuleActionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for RuleActionBuilder
impl Debug for RuleActionBuilder
Source§impl Default for RuleActionBuilder
impl Default for RuleActionBuilder
Source§fn default() -> RuleActionBuilder
fn default() -> RuleActionBuilder
Source§impl PartialEq for RuleActionBuilder
impl PartialEq for RuleActionBuilder
impl StructuralPartialEq for RuleActionBuilder
Auto Trait Implementations§
impl Freeze for RuleActionBuilder
impl RefUnwindSafe for RuleActionBuilder
impl Send for RuleActionBuilder
impl Sync for RuleActionBuilder
impl Unpin for RuleActionBuilder
impl UnwindSafe for RuleActionBuilder
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);