OAuthAPI
Defined in: namespaces.ts:1418
Methods
Section titled “Methods”authorize()
Section titled “authorize()”authorize(
provider,options):Promise<OAuthTokenResult>
Defined in: namespaces.ts:1420
Starts OAuth 2.0 + PKCE flow. Opens system browser.
Parameters
Section titled “Parameters”provider
Section titled “provider”string
options
Section titled “options”Returns
Section titled “Returns”Promise<OAuthTokenResult>
getToken()
Section titled “getToken()”getToken(
provider):Promise<OAuthTokenResult|null>
Defined in: namespaces.ts:1422
Returns stored token, or null if not authorized / expired.
Parameters
Section titled “Parameters”provider
Section titled “provider”string
Returns
Section titled “Returns”Promise<OAuthTokenResult | null>
revoke()
Section titled “revoke()”revoke(
provider):Promise<true>
Defined in: namespaces.ts:1424
Deletes stored tokens and cancels refresh schedule.
Parameters
Section titled “Parameters”provider
Section titled “provider”string
Returns
Section titled “Returns”Promise<true>
isAuthorized()
Section titled “isAuthorized()”isAuthorized(
provider):Promise<boolean>
Defined in: namespaces.ts:1426
Checks if a non-expired token exists.
Parameters
Section titled “Parameters”provider
Section titled “provider”string
Returns
Section titled “Returns”Promise<boolean>
authorizeSecure()
Section titled “authorizeSecure()”authorizeSecure(
provider,options?):Promise<OAuthSecureTokenResult>
Defined in: namespaces.ts:1431
Vault-aware authorize (fn-72). Returns a mode-discriminated result —
"vault" mode keeps the raw token host-side.
Parameters
Section titled “Parameters”provider
Section titled “provider”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<OAuthSecureTokenResult>
getTokenSecure()
Section titled “getTokenSecure()”getTokenSecure(
provider):Promise<OAuthSecureTokenResult|null>
Defined in: namespaces.ts:1433
Vault-aware token read. Null when not authorized / expired.
Parameters
Section titled “Parameters”provider
Section titled “provider”string
Returns
Section titled “Returns”Promise<OAuthSecureTokenResult | null>
buildAuthenticatedRequest()
Section titled “buildAuthenticatedRequest()”buildAuthenticatedRequest(
provider,descriptor):Promise<string>
Defined in: namespaces.ts:1440
Builds a server-held authenticated URLRequest for the provider’s stored
token. Returns a single-use requestId to pass to
network.executeRequest(...). Requires the oauth + network permissions
(NOT vault.* scopes); JS never sees the raw token.
Parameters
Section titled “Parameters”provider
Section titled “provider”string
descriptor
Section titled “descriptor”unknown
Returns
Section titled “Returns”Promise<string>