Skip to main content
Interface for OAuth manager implementations.

​
Methods

​
getOAuthFlowState()

getOAuthFlowState(): Promise<
  | null
| OAuthFlowState>;
Gets the OAuth flow state.

​
Returns

Promise< | null | OAuthFlowState>

​
setOAuthFlowState()

setOAuthFlowState(oauthFlowState: OAuthFlowState): Promise<void>;
Sets the OAuth flow state.

​
Parameters

ParameterType
oauthFlowStateOAuthFlowState

​
Returns

Promise<void>

​
addOAuthStateChangeCallback()

addOAuthStateChangeCallback(callback: OnOAuthStateChangeFn): Promise<void>;
Adds a callback to be called when the OAuth state changes.

​
Parameters

ParameterType
callbackOnOAuthStateChangeFn

​
Returns

Promise<void>

​
clearOAuthFlowState()

clearOAuthFlowState(): Promise<void>;
Clears the OAuth flow state.

​
Returns

Promise<void>

​
handleOAuthCode()

handleOAuthCode(url?: string): Promise<void>;
Awaitable method whose promise only resolves when the OAuth manager is ready to be used.

​
Parameters

ParameterType
url?string

​
Returns

Promise<void>