Class SessionScheduleApi

java.lang.Object

com.github.copilot.generated.rpc.SessionScheduleApi

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

API methods for the schedule namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionScheduleAddResult>	add(SessionScheduleAddParams params)	Register a relative-interval scheduled prompt.
CompletableFuture<SessionScheduleAddAtResult>	addAt(SessionScheduleAddAtParams params)	Register an absolute-time scheduled prompt.
CompletableFuture<SessionScheduleAddCronResult>	addCron(SessionScheduleAddCronParams params)	Register a cron scheduled prompt.
CompletableFuture<SessionScheduleAddSelfPacedResult>	addSelfPaced(SessionScheduleAddSelfPacedParams params)	Register a self-paced scheduled prompt.
CompletableFuture<SessionScheduleHasSelfPacedResult>	hasSelfPaced()	Identifies the target session.
CompletableFuture<Void>	hydrate()	Identifies the target session.
CompletableFuture<SessionScheduleListResult>	list()	Identifies the target session.
CompletableFuture<SessionScheduleRearmSelfPacedResult>	rearmSelfPaced(SessionScheduleRearmSelfPacedParams params)	Re-arm a self-paced scheduled prompt.
CompletableFuture<SessionScheduleStopResult>	stop(SessionScheduleStopParams params)	Identifier of the scheduled prompt to remove.

Methods inherited from class Object

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

Method Details

list

@CopilotExperimental
public CompletableFuture<SessionScheduleListResult> list()

Identifies the target session.

Since:

1.0.0

hydrate

@CopilotExperimental
public CompletableFuture<Void> hydrate()

Identifies the target session.

Since:

1.0.0

hasSelfPaced

@CopilotExperimental
public CompletableFuture<SessionScheduleHasSelfPacedResult> hasSelfPaced()

Identifies the target session.

Since:

1.0.0

add

@CopilotExperimental
public CompletableFuture<SessionScheduleAddResult> add(SessionScheduleAddParams params)

Register a relative-interval scheduled prompt.

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

Since:

1.0.0

addCron

@CopilotExperimental
public CompletableFuture<SessionScheduleAddCronResult> addCron(SessionScheduleAddCronParams params)

Register a cron scheduled prompt.

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

Since:

1.0.0

addAt

@CopilotExperimental
public CompletableFuture<SessionScheduleAddAtResult> addAt(SessionScheduleAddAtParams params)

Register an absolute-time scheduled prompt.

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

Since:

1.0.0

addSelfPaced

@CopilotExperimental
public CompletableFuture<SessionScheduleAddSelfPacedResult> addSelfPaced(SessionScheduleAddSelfPacedParams params)

Register a self-paced scheduled prompt.

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

Since:

1.0.0

rearmSelfPaced

@CopilotExperimental
public CompletableFuture<SessionScheduleRearmSelfPacedResult> rearmSelfPaced(SessionScheduleRearmSelfPacedParams params)

Re-arm a self-paced scheduled prompt.

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

Since:

1.0.0

stop

@CopilotExperimental
public CompletableFuture<SessionScheduleStopResult> stop(SessionScheduleStopParams params)

Identifier of the scheduled prompt to remove.

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

Since:

1.0.0