Struct SessionRpcQueue

Source

pub struct SessionRpcQueue<'a> { /* private fields */ }

Expand description

session.queue.* RPCs.

Implementations§

Source §

impl<'a> SessionRpcQueue<'a>

Source

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

Returns the local session’s pending user-facing queued items and steering messages.

Wire method: session.queue.pendingItems.

§Returns

Snapshot of the session’s pending queued items and immediate-steering messages.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

Source

pub async fn move_item( &self, params: QueueMoveItemRequest, ) -> Result<QueueMoveItemResult, Error>

Moves an addressable queued item to a public visible position.

Wire method: session.queue.moveItem.

§Parameters

params - Parameters for moving a queued item by stable id.

§Returns

Result of moving a queued item.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

Source

pub async fn insert_at( &self, params: QueueInsertAtRequest, ) -> Result<QueueInsertAtResult, Error>

Inserts a new queued message at a public visible position.

Wire method: session.queue.insertAt.

§Parameters

params - Parameters for inserting a queued message at a public visible position.

§Returns

Result of inserting a queued message.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

Source

pub async fn remove_at( &self, params: QueueRemoveAtRequest, ) -> Result<QueueRemoveAtResult, Error>

Removes an addressable queued item by its stable id.

Wire method: session.queue.removeAt.

§Parameters

params - Parameters for removing a queued item by stable id.

§Returns

Result of removing a queued item.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

Source

pub async fn update_text( &self, params: QueueUpdateTextRequest, ) -> Result<QueueUpdateTextResult, Error>

Updates the text of an addressable single-message queue item.

Wire method: session.queue.updateText.

§Parameters

params - Parameters for editing a single queued message.

§Returns

Result of editing a queued message.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

Source

pub async fn duplicate_at( &self, params: QueueDuplicateAtRequest, ) -> Result<QueueDuplicateAtResult, Error>

Duplicates an addressable queued item immediately after its source.

Wire method: session.queue.duplicateAt.

§Parameters

params - Parameters for duplicating a queued item.

§Returns

Result of duplicating a queued item.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

Source

pub async fn set_drain_paused( &self, params: QueueSetDrainPausedRequest, ) -> Result<(), Error>

Acquires or releases the queued-lane drain pause.

Wire method: session.queue.setDrainPaused.

§Parameters

params - Parameters for acquiring or releasing the queued-lane drain pause. Acquisition is exclusive and non-idempotent: paused: true against an already-paused session fails with queue_already_paused. The pause is never released automatically — it is not tied to the caller’s lifetime, so a client that exits without sending paused: false leaves the lane frozen. Release is unowned: paused: false clears the pause for any caller, including one that never acquired it.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

Source

pub async fn send_now( &self, params: QueueSendNowRequest, ) -> Result<QueueSendNowResult, Error>

Moves an addressable queued message into the live turn’s steering lane.

Wire method: session.queue.sendNow.

§Parameters

params - Parameters for steering a queued message into a live turn.

§Returns

Result of trying to steer a queued message into a live turn.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

Source

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

Removes the most recently queued user-facing item (LIFO).

Wire method: session.queue.removeMostRecent.

§Returns

Indicates whether a user-facing pending item was removed.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

Source

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

Clears all pending queued items on the local session.

Wire method: session.queue.clear.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.