Class ServerHostApi

java.lang.Object

com.github.copilot.generated.rpc.ServerHostApi

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

API methods for the host namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	dispose(HostDisposeParams params)	Stops a listener owned by this SDK connection and joins its cleanup without deleting sessions.
CompletableFuture<HostListSessionsResult>	listSessions(HostListSessionsParams params)	Reads the complete advertised live and dormant session catalog of an existing host owned by this connection.
CompletableFuture<HostPublishSessionResult>	publishSession(HostPublishSessionParams params)	Publishes an attached resident session for this listener's lifetime without copying it.
CompletableFuture<HostStartResult>	start(HostStartParams params)	Starts a connection-owned AHP host with explicit localServer and/or githubEnvironment transports as a supervised SDK participant.
CompletableFuture<HostStartResult>	start(HostStartRequest request)	Starts a connection-owned AHP host with explicit localServer and/or githubEnvironment transports as a supervised SDK participant.

Methods inherited from class Object

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

Method Details

publishSession

@CopilotExperimental
public CompletableFuture<HostPublishSessionResult> publishSession(HostPublishSessionParams params)

Publishes an attached resident session for this listener's lifetime without copying it.

Since:

1.0.0

listSessions

@CopilotExperimental
public CompletableFuture<HostListSessionsResult> listSessions(HostListSessionsParams params)

Reads the complete advertised live and dormant session catalog of an existing host owned by this connection. Does not start hosting, subscribe to sessions, or guarantee resumability.

Since:

1.0.0

start

@CopilotExperimental
public CompletableFuture<HostStartResult> start(HostStartParams params)

Starts a connection-owned AHP host with explicit localServer and/or githubEnvironment transports as a supervised SDK participant.

Since:

1.0.0

start

@CopilotExperimental
public CompletableFuture<HostStartResult> start(HostStartRequest request)

Starts a connection-owned AHP host with explicit localServer and/or githubEnvironment transports as a supervised SDK participant.

Accepts the extensible request, including inputs added after the params record.

Since:

1.0.0

dispose

@CopilotExperimental
public CompletableFuture<Void> dispose(HostDisposeParams params)

Stops a listener owned by this SDK connection and joins its cleanup without deleting sessions.

Since:

1.0.0