Class SessionGitHubAuthApi

java.lang.Object

com.github.copilot.generated.rpc.SessionGitHubAuthApi

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

API methods for the gitHubAuth namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<List<SessionAuthStatus>>	getAllAuthAvailable()	Identifies the target session.
CompletableFuture<Void>	getCurrentAuthInfo()	Identifies the target session.
CompletableFuture<SessionGitHubAuthGetStatusResult>	getStatus()	Identifies the target session.
CompletableFuture<List<AuthValidationError>>	lastAuthErrors()	Identifies the target session.
CompletableFuture<AuthInfo>	login(SessionGitHubAuthLoginParams params)	Internal GitHub login parameters.
CompletableFuture<Void>	logout()	Identifies the target session.
CompletableFuture<Void>	logoutUser(SessionGitHubAuthLogoutUserParams params)	Parameters identifying a GitHub authentication to log out.
CompletableFuture<Void>	refreshCopilotUser()	Identifies the target session.
CompletableFuture<SessionGitHubAuthSetCredentialsResult>	setCredentials(SessionGitHubAuthSetCredentialsParams params)	New auth credentials to install on the session.
CompletableFuture<Void>	switchToAuth(SessionGitHubAuthSwitchToAuthParams params)	Parameters for switching the session's active authentication.

Methods inherited from class Object

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

Method Details

getStatus

@CopilotExperimental
public CompletableFuture<SessionGitHubAuthGetStatusResult> getStatus()

Identifies the target session.

Since:

1.0.0

setCredentials

@CopilotExperimental
public CompletableFuture<SessionGitHubAuthSetCredentialsResult> setCredentials(SessionGitHubAuthSetCredentialsParams params)

New auth credentials to install on the session. Omit to leave credentials unchanged.

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

Since:

1.0.0

getCurrentAuthInfo

@CopilotExperimental
public CompletableFuture<Void> getCurrentAuthInfo()

Identifies the target session.

Since:

1.0.0

getAllAuthAvailable

@CopilotExperimental
public CompletableFuture<List<SessionAuthStatus>> getAllAuthAvailable()

Identifies the target session.

Since:

1.0.0

refreshCopilotUser

@CopilotExperimental
public CompletableFuture<Void> refreshCopilotUser()

Identifies the target session.

Since:

1.0.0

login

@CopilotExperimental
public CompletableFuture<AuthInfo> login(SessionGitHubAuthLoginParams params)

Internal GitHub login parameters.

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

Since:

1.0.0

switchToAuth

@CopilotExperimental
public CompletableFuture<Void> switchToAuth(SessionGitHubAuthSwitchToAuthParams params)

Parameters for switching the session's active authentication.

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

Since:

1.0.0

logout

@CopilotExperimental
public CompletableFuture<Void> logout()

Identifies the target session.

Since:

1.0.0

logoutUser

@CopilotExperimental
public CompletableFuture<Void> logoutUser(SessionGitHubAuthLogoutUserParams params)

Parameters identifying a GitHub authentication to log out.

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

Since:

1.0.0

lastAuthErrors

@CopilotExperimental
public CompletableFuture<List<AuthValidationError>> lastAuthErrors()

Identifies the target session.

Since:

1.0.0