Struct PlaybackInterruptionEvent

#[non_exhaustive]
pub struct PlaybackInterruptionEvent {
    pub event_reason: Option<PlaybackInterruptionReason>,
    pub caused_by_event_id: Option<String>,
    pub event_id: Option<String>,
}

Event sent from Amazon Lex V2 to indicate to the client application should stop playback of audio. For example, if the client is playing a prompt that asks for the user's telephone number, the user might start to say the phone number before the prompt is complete. Amazon Lex V2 sends this event to the client application to indicate that the user is responding and that Amazon Lex V2 is processing their input.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

event_reason: Option<PlaybackInterruptionReason>

Indicates the type of user input that Amazon Lex V2 detected.

caused_by_event_id: Option<String>

The identifier of the event that contained the audio, DTMF, or text that caused the interruption.

event_id: Option<String>

A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.

Implementations

impl PlaybackInterruptionEvent

pub fn event_reason(&self) -> Option<&PlaybackInterruptionReason>

Indicates the type of user input that Amazon Lex V2 detected.

pub fn caused_by_event_id(&self) -> Option<&str>

The identifier of the event that contained the audio, DTMF, or text that caused the interruption.

pub fn event_id(&self) -> Option<&str>

A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.

impl PlaybackInterruptionEvent

pub fn builder() -> PlaybackInterruptionEventBuilder

Creates a new builder-style object to manufacture PlaybackInterruptionEvent.

Trait Implementations

impl Clone for PlaybackInterruptionEvent

fn clone(&self) -> PlaybackInterruptionEvent

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PlaybackInterruptionEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PlaybackInterruptionEvent

fn eq(&self, other: &PlaybackInterruptionEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PlaybackInterruptionEvent