Interface SourceAuth

Implemented by providers declaring auth: 'interactive'.

restore runs at registration and must be silent and non-blocking: no popups, no navigation. signIn may open a popup and must therefore only be called from a user gesture — the host guarantees this.

interface SourceAuth {
    cancelSignIn?(): void;
    getIdentity(ctx: PluginContext): Promise<SourceIdentity | null>;
    restore(ctx: PluginContext): Promise<SourceIdentity | null>;
    signIn(ctx: PluginContext): Promise<SourceIdentity>;
    signOut(ctx: PluginContext): Promise<void>;
}

Index

Methods

cancelSignIn? getIdentity restore signIn signOut

Methods

`Optional`cancelSignIn

cancelSignIn?(): void

Explicitly cancel an interactive attempt, including a COOP-separated popup.

Returns void

getIdentity

getIdentity(ctx: PluginContext): Promise<SourceIdentity | null>
Current identity, or null. Must not perform interactive work.
Parameters
- ctx: PluginContext
Returns Promise<SourceIdentity | null>

restore

restore(ctx: PluginContext): Promise<SourceIdentity | null>
Re-establish a session from cache, silently. Returns null if not signed in.
Parameters
- ctx: PluginContext
Returns Promise<SourceIdentity | null>

signIn(ctx: PluginContext): Promise<SourceIdentity>
Interactive sign-in. Called only from a user gesture.
Parameters
- ctx: PluginContext
Returns Promise<SourceIdentity>

signOut

signOut(ctx: PluginContext): Promise<void>
Parameters
- ctx: PluginContext
Returns Promise<void>