Interface CopilotAuthService

ReadonlyonAuthStateChanged

cancelSignIn

• cancelSignIn(): Promise<void>

  Aborts a sign-in that is still in progress, if any.

  Returns Promise<void>

getAuthState

• getAuthState(): Promise<CopilotAuthState>

  Get the current authentication state.

  Returns Promise<CopilotAuthState>

setClient

• setClient(client: undefined | CopilotAuthServiceClient): void

  Set the client to receive auth state change notifications.

  Parameters

  • client: undefined | CopilotAuthServiceClient

  Returns void

setExecutablePath

• setExecutablePath(path: undefined | string): Promise<void>

  Tells the backend where the Copilot CLI is, as configured by the user.

  The CLI is not shipped with the application and has to be found on the machine hosting the backend, which cannot read the preferences of the user itself.

  Parameters

  • path: undefined | string

    Location of the CLI executable, or undefined to search for it

  Returns Promise<void>

signOut

• signOut(): Promise<void>

  Discards the stored credentials of this application.

  Returns Promise<void>

startSignIn

• startSignIn(enterpriseUrl?: string): Promise<DeviceCodeResponse>

  Starts the sign-in and resolves once the code the user has to enter is known.

  Parameters

  • OptionalenterpriseUrl: string

    Optional GitHub Enterprise domain

  Returns Promise<DeviceCodeResponse>

waitForSignIn

• waitForSignIn(): Promise<boolean>

  Waits for the sign-in started by startSignIn to complete.

  Returns Promise<boolean>

  true if the sign-in succeeded, false if it was denied or expired