Class SessionQueueApi

java.lang.Object

com.github.copilot.generated.rpc.SessionQueueApi

@Generated("copilot-sdk-codegen")
public final class SessionQueueApi
extends Object

API methods for the queue namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionQueueAppendSteeringResult>	appendSteering(SessionQueueAppendSteeringParams params)	Atomically appends text and attachments to an unchanged, unconsumed local steering message.
CompletableFuture<Void>	clear()	Clears all pending queued items on the local session.
CompletableFuture<SessionQueueDuplicateAtResult>	duplicateAt(SessionQueueDuplicateAtParams params)	Duplicates an addressable queued item immediately after its source.
CompletableFuture<SessionQueueInsertAtResult>	insertAt(SessionQueueInsertAtParams params)	Inserts a new queued message at a public visible position.
CompletableFuture<SessionQueueMoveItemResult>	moveItem(SessionQueueMoveItemParams params)	Moves an addressable queued item to a public visible position.
CompletableFuture<SessionQueuePendingItemsResult>	pendingItems()	Returns the local session's pending user-facing queued items and steering messages.
CompletableFuture<SessionQueueRemoveAtResult>	removeAt(SessionQueueRemoveAtParams params)	Removes an addressable queued item by its stable id.
CompletableFuture<SessionQueueRemoveMostRecentResult>	removeMostRecent()	Removes the most recently queued user-facing item (LIFO).
CompletableFuture<SessionQueueSendNowResult>	sendNow(SessionQueueSendNowParams params)	Moves an addressable queued message into the live turn's steering lane.
CompletableFuture<Void>	setDrainPaused(SessionQueueSetDrainPausedParams params)	Acquires or releases the queued-lane drain pause.
CompletableFuture<SessionQueueUpdateTextResult>	updateText(SessionQueueUpdateTextParams params)	Updates the text of an addressable single-message queue item.
CompletableFuture<SessionQueueWithdrawMessageResult>	withdrawMessage(SessionQueueWithdrawMessageParams params)	Atomically withdraws an unchanged user message of a local session: from the queued or steering lane while unconsumed, or from the running turn it started while the model has not answered it and nothing the user sent after it is pending.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

pendingItems

@CopilotExperimental
public CompletableFuture<SessionQueuePendingItemsResult> pendingItems()

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

Since:

1.0.0

moveItem

@CopilotExperimental
public CompletableFuture<SessionQueueMoveItemResult> moveItem(SessionQueueMoveItemParams params)

Moves an addressable queued item to a public visible position.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

insertAt

@CopilotExperimental
public CompletableFuture<SessionQueueInsertAtResult> insertAt(SessionQueueInsertAtParams params)

Inserts a new queued message at a public visible position.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

removeAt

@CopilotExperimental
public CompletableFuture<SessionQueueRemoveAtResult> removeAt(SessionQueueRemoveAtParams params)

Removes an addressable queued item by its stable id.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

updateText

@CopilotExperimental
public CompletableFuture<SessionQueueUpdateTextResult> updateText(SessionQueueUpdateTextParams params)

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

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

withdrawMessage

@CopilotExperimental
public CompletableFuture<SessionQueueWithdrawMessageResult> withdrawMessage(SessionQueueWithdrawMessageParams params)

Atomically withdraws an unchanged user message of a local session: from the queued or steering lane while unconsumed, or from the running turn it started while the model has not answered it and nothing the user sent after it is pending. Withdrawing from the running turn interrupts that turn and removes its events from history. A client retaining the original draft may restore it only when removed is true.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

appendSteering

@CopilotExperimental
public CompletableFuture<SessionQueueAppendSteeringResult> appendSteering(SessionQueueAppendSteeringParams params)

Atomically appends text and attachments to an unchanged, unconsumed local steering message. Returns updated=false if delivery or withdrawal already claimed the message.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

duplicateAt

@CopilotExperimental
public CompletableFuture<SessionQueueDuplicateAtResult> duplicateAt(SessionQueueDuplicateAtParams params)

Duplicates an addressable queued item immediately after its source.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

setDrainPaused

@CopilotExperimental
public CompletableFuture<Void> setDrainPaused(SessionQueueSetDrainPausedParams params)

Acquires or releases the queued-lane drain pause.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

sendNow

@CopilotExperimental
public CompletableFuture<SessionQueueSendNowResult> sendNow(SessionQueueSendNowParams params)

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

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

removeMostRecent

@CopilotExperimental
public CompletableFuture<SessionQueueRemoveMostRecentResult> removeMostRecent()

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

Since:

1.0.0

clear

@CopilotExperimental
public CompletableFuture<Void> clear()

Clears all pending queued items on the local session.

Since:

1.0.0