#[non_exhaustive]pub struct IntentConfirmationSetting {Show 13 fields
pub prompt_specification: Option<PromptSpecification>,
pub declination_response: Option<ResponseSpecification>,
pub active: Option<bool>,
pub confirmation_response: Option<ResponseSpecification>,
pub confirmation_next_step: Option<DialogState>,
pub confirmation_conditional: Option<ConditionalSpecification>,
pub declination_next_step: Option<DialogState>,
pub declination_conditional: Option<ConditionalSpecification>,
pub failure_response: Option<ResponseSpecification>,
pub failure_next_step: Option<DialogState>,
pub failure_conditional: Option<ConditionalSpecification>,
pub code_hook: Option<DialogCodeHookInvocationSetting>,
pub elicitation_code_hook: Option<ElicitationCodeHookInvocationSetting>,
}
Expand description
Provides a prompt for making sure that the user is ready for the intent to be fulfilled.
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.prompt_specification: Option<PromptSpecification>
Prompts the user to confirm the intent. This question should have a yes or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza
intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.
declination_response: Option<ResponseSpecification>
When the user answers "no" to the question defined in promptSpecification
, Amazon Lex responds with this response to acknowledge that the intent was canceled.
active: Option<bool>
Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active
field isn't specified, the default is true.
confirmation_response: Option<ResponseSpecification>
Specifies a list of message groups that Amazon Lex uses to respond the user input.
confirmation_next_step: Option<DialogState>
Specifies the next step that the bot executes when the customer confirms the intent.
confirmation_conditional: Option<ConditionalSpecification>
A list of conditional branches to evaluate after the intent is closed.
declination_next_step: Option<DialogState>
Specifies the next step that the bot executes when the customer declines the intent.
declination_conditional: Option<ConditionalSpecification>
A list of conditional branches to evaluate after the intent is declined.
failure_response: Option<ResponseSpecification>
Specifies a list of message groups that Amazon Lex uses to respond the user input.
failure_next_step: Option<DialogState>
The next step to take in the conversation if the confirmation step fails.
failure_conditional: Option<ConditionalSpecification>
Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
code_hook: Option<DialogCodeHookInvocationSetting>
The DialogCodeHookInvocationSetting
object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook
.
elicitation_code_hook: Option<ElicitationCodeHookInvocationSetting>
The DialogCodeHookInvocationSetting
used when the code hook is invoked during confirmation prompt retries.
Implementations§
source§impl IntentConfirmationSetting
impl IntentConfirmationSetting
sourcepub fn prompt_specification(&self) -> Option<&PromptSpecification>
pub fn prompt_specification(&self) -> Option<&PromptSpecification>
Prompts the user to confirm the intent. This question should have a yes or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza
intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.
sourcepub fn declination_response(&self) -> Option<&ResponseSpecification>
pub fn declination_response(&self) -> Option<&ResponseSpecification>
When the user answers "no" to the question defined in promptSpecification
, Amazon Lex responds with this response to acknowledge that the intent was canceled.
sourcepub fn active(&self) -> Option<bool>
pub fn active(&self) -> Option<bool>
Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active
field isn't specified, the default is true.
sourcepub fn confirmation_response(&self) -> Option<&ResponseSpecification>
pub fn confirmation_response(&self) -> Option<&ResponseSpecification>
Specifies a list of message groups that Amazon Lex uses to respond the user input.
sourcepub fn confirmation_next_step(&self) -> Option<&DialogState>
pub fn confirmation_next_step(&self) -> Option<&DialogState>
Specifies the next step that the bot executes when the customer confirms the intent.
sourcepub fn confirmation_conditional(&self) -> Option<&ConditionalSpecification>
pub fn confirmation_conditional(&self) -> Option<&ConditionalSpecification>
A list of conditional branches to evaluate after the intent is closed.
sourcepub fn declination_next_step(&self) -> Option<&DialogState>
pub fn declination_next_step(&self) -> Option<&DialogState>
Specifies the next step that the bot executes when the customer declines the intent.
sourcepub fn declination_conditional(&self) -> Option<&ConditionalSpecification>
pub fn declination_conditional(&self) -> Option<&ConditionalSpecification>
A list of conditional branches to evaluate after the intent is declined.
sourcepub fn failure_response(&self) -> Option<&ResponseSpecification>
pub fn failure_response(&self) -> Option<&ResponseSpecification>
Specifies a list of message groups that Amazon Lex uses to respond the user input.
sourcepub fn failure_next_step(&self) -> Option<&DialogState>
pub fn failure_next_step(&self) -> Option<&DialogState>
The next step to take in the conversation if the confirmation step fails.
sourcepub fn failure_conditional(&self) -> Option<&ConditionalSpecification>
pub fn failure_conditional(&self) -> Option<&ConditionalSpecification>
Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
sourcepub fn code_hook(&self) -> Option<&DialogCodeHookInvocationSetting>
pub fn code_hook(&self) -> Option<&DialogCodeHookInvocationSetting>
The DialogCodeHookInvocationSetting
object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook
.
sourcepub fn elicitation_code_hook(
&self,
) -> Option<&ElicitationCodeHookInvocationSetting>
pub fn elicitation_code_hook( &self, ) -> Option<&ElicitationCodeHookInvocationSetting>
The DialogCodeHookInvocationSetting
used when the code hook is invoked during confirmation prompt retries.
source§impl IntentConfirmationSetting
impl IntentConfirmationSetting
sourcepub fn builder() -> IntentConfirmationSettingBuilder
pub fn builder() -> IntentConfirmationSettingBuilder
Creates a new builder-style object to manufacture IntentConfirmationSetting
.
Trait Implementations§
source§impl Clone for IntentConfirmationSetting
impl Clone for IntentConfirmationSetting
source§fn clone(&self) -> IntentConfirmationSetting
fn clone(&self) -> IntentConfirmationSetting
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for IntentConfirmationSetting
impl Debug for IntentConfirmationSetting
impl StructuralPartialEq for IntentConfirmationSetting
Auto Trait Implementations§
impl Freeze for IntentConfirmationSetting
impl RefUnwindSafe for IntentConfirmationSetting
impl Send for IntentConfirmationSetting
impl Sync for IntentConfirmationSetting
impl Unpin for IntentConfirmationSetting
impl UnwindSafe for IntentConfirmationSetting
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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);