#[non_exhaustive]pub struct RuleAction {
pub action_type: ActionType,
pub task_action: Option<TaskActionDefinition>,
pub event_bridge_action: Option<EventBridgeActionDefinition>,
pub assign_contact_category_action: Option<AssignContactCategoryActionDefinition>,
pub send_notification_action: Option<SendNotificationActionDefinition>,
pub create_case_action: Option<CreateCaseActionDefinition>,
pub update_case_action: Option<UpdateCaseActionDefinition>,
pub end_associated_tasks_action: Option<EndAssociatedTasksActionDefinition>,
pub submit_auto_evaluation_action: Option<SubmitAutoEvaluationActionDefinition>,
}
Expand description
Information about the action to be performed when a rule is triggered.
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.action_type: ActionType
The type of action that creates a rule.
task_action: Option<TaskActionDefinition>
Information about the task action. This field is required if TriggerEventSource
is one of the following values: OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
event_bridge_action: Option<EventBridgeActionDefinition>
Information about the EventBridge action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
| OnMetricDataUpdate
assign_contact_category_action: Option<AssignContactCategoryActionDefinition>
Information about the contact category action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
send_notification_action: Option<SendNotificationActionDefinition>
Information about the send notification action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
| OnMetricDataUpdate
create_case_action: Option<CreateCaseActionDefinition>
Information about the create case action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnPostChatAnalysisAvailable
.
update_case_action: Option<UpdateCaseActionDefinition>
Information about the update case action.
Supported only for TriggerEventSource
values: OnCaseCreate
| OnCaseUpdate
.
end_associated_tasks_action: Option<EndAssociatedTasksActionDefinition>
Information about the end associated tasks action.
Supported only for TriggerEventSource
values: OnCaseUpdate
.
submit_auto_evaluation_action: Option<SubmitAutoEvaluationActionDefinition>
Information about the submit automated evaluation action.
Implementations§
Source§impl RuleAction
impl RuleAction
Sourcepub fn action_type(&self) -> &ActionType
pub fn action_type(&self) -> &ActionType
The type of action that creates a rule.
Sourcepub fn task_action(&self) -> Option<&TaskActionDefinition>
pub fn 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) -> Option<&EventBridgeActionDefinition>
pub fn 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,
) -> Option<&AssignContactCategoryActionDefinition>
pub fn 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,
) -> Option<&SendNotificationActionDefinition>
pub fn 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) -> Option<&CreateCaseActionDefinition>
pub fn 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) -> Option<&UpdateCaseActionDefinition>
pub fn 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,
) -> Option<&EndAssociatedTasksActionDefinition>
pub fn 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,
) -> Option<&SubmitAutoEvaluationActionDefinition>
pub fn submit_auto_evaluation_action( &self, ) -> Option<&SubmitAutoEvaluationActionDefinition>
Information about the submit automated evaluation action.
Source§impl RuleAction
impl RuleAction
Sourcepub fn builder() -> RuleActionBuilder
pub fn builder() -> RuleActionBuilder
Creates a new builder-style object to manufacture RuleAction
.
Trait Implementations§
Source§impl Clone for RuleAction
impl Clone for RuleAction
Source§fn clone(&self) -> RuleAction
fn clone(&self) -> RuleAction
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for RuleAction
impl Debug for RuleAction
Source§impl PartialEq for RuleAction
impl PartialEq for RuleAction
impl StructuralPartialEq for RuleAction
Auto Trait Implementations§
impl Freeze for RuleAction
impl RefUnwindSafe for RuleAction
impl Send for RuleAction
impl Sync for RuleAction
impl Unpin for RuleAction
impl UnwindSafe for RuleAction
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);