camera.ui Node SDK

Appearance

@camera.ui/sdk / plugin / OAuthDeviceFlowCapable

Interface: OAuthDeviceFlowCapable ​

Defined in: plugin/oauth.ts:93

Implemented by plugins whose IdP supports the RFC 8628 Device Authorization Grant. The plugin polls the IdP internally; the host only polls getOAuthState to mirror progress.

Extends ​

Methods ​

cancelDeviceFlow() ​

cancelDeviceFlow(): Promise<void>

Defined in: plugin/oauth.ts:97

Abort an in-progress device flow.

Returns ​

Promise<void>

disconnect() ​

disconnect(): Promise<void>

Defined in: plugin/oauth.ts:85

Revoke the current grant at the IdP and clear stored tokens.

Returns ​

Promise<void>

Inherited from ​

OAuthCapable.disconnect

getOAuthMetadata() ​

getOAuthMetadata(): Promise<OAuthMetadata>

Defined in: plugin/oauth.ts:81

Return IdP display info, scope descriptions and the implemented flow sub-interfaces.

Returns ​

Promise<OAuthMetadata>

Inherited from ​

OAuthCapable.getOAuthMetadata

getOAuthState() ​

getOAuthState(): Promise<OAuthState>

Defined in: plugin/oauth.ts:83

Return a snapshot of the current lifecycle state; the host polls this to mirror progress.

Returns ​

Promise<OAuthState>

Inherited from ​

OAuthCapable.getOAuthState

startDeviceFlow() ​

startDeviceFlow(scope): Promise<OAuthState>

Defined in: plugin/oauth.ts:95

Request a device code for the given scopes and begin polling; returns the awaiting-user state.

Parameters ​

scope ​

string[]

Returns ​

Promise<OAuthState>