Class SessionAccountsLoginApi

java.lang.Object

com.github.copilot.generated.rpc.SessionAccountsLoginApi

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

API methods for the accounts.login namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<AuthLoginStep>	advance(SessionAccountsLoginAdvanceParams params)	Advance an in-flight login flow, optionally fulfilling an input-required step, and return the next step.
CompletableFuture<SessionAccountsLoginBeginResult>	begin(SessionAccountsLoginBeginParams params)	Begin an interactive login flow for a provider kind (dispatch is kind-only) and return its opaque flow id and first step.
CompletableFuture<Void>	cancel(SessionAccountsLoginCancelParams params)	Cancel an in-flight login flow and release its resources.

Methods inherited from class Object

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

Method Details

begin

@CopilotExperimental
public CompletableFuture<SessionAccountsLoginBeginResult> begin(SessionAccountsLoginBeginParams params)

Begin an interactive login flow for a provider kind (dispatch is kind-only) and return its opaque flow id and first step.

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

Since:

1.0.0

advance

@CopilotExperimental
public CompletableFuture<AuthLoginStep> advance(SessionAccountsLoginAdvanceParams params)

Advance an in-flight login flow, optionally fulfilling an input-required step, and return the next step.

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

Since:

1.0.0

cancel

@CopilotExperimental
public CompletableFuture<Void> cancel(SessionAccountsLoginCancelParams params)

Cancel an in-flight login flow and release its resources.

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

Since:

1.0.0