Struct InteractionHandle 

pub struct InteractionHandle { /* private fields */ }

Handle to an Interaction, usable for get / cancel / delete / poll operations.

Implementations

impl InteractionHandle

pub fn id(&self) -> &str

Get the interaction ID.

pub async fn get(&self) -> Result<Interaction, Error>

Get the full interaction resource.

pub async fn get_stream( &self, last_event_id: Option<&str>, ) -> Result<InteractionStream, Error>

Get the interaction in streaming mode (can resume from last_event_id).

pub async fn cancel(&self) -> Result<Interaction, Error>

Cancel the interaction (only applicable to background executions).

pub async fn delete(&self) -> Result<(), Error>

Delete the interaction.

pub async fn poll_until_completed( &self, interval: Duration, ) -> Result<Interaction, Error>

Poll until the interaction reaches a terminal state.

Continuously calls get() until the status becomes completed / failed / cancelled / incomplete / budget_exceeded. Suitable for background interactions.

pub fn as_previous_interaction_id(&self) -> &str

Get this interaction’s ID for use as previous_interaction_id in the next turn.

Trait Implementations

impl Clone for InteractionHandle

fn clone(&self) -> InteractionHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.