PopClip JavaScript API Reference
    Preparing search index...

    Interface AuthResult

    Object form of the value returned by Extension.auth, for when the extension has more than just the secret to hand back. Returning a bare string is equivalent to returning { secret: theString }.

    interface AuthResult {
        expiresIn?: number;
        label?: string;
        secret: string;
    }
    Index
    expiresIn?: number

    Optional token lifetime in seconds, as reported by the auth server (its expires_in). PopClip records it with the sign-in time; once it elapses the app treats the extension as signed out and prompts the user to sign in again.

    label?: string

    Optional account identifier to display, e.g. an email or username ("Signed in as …").

    secret: string

    The secret to store (e.g. an access token). Saved as the extension's authsecret.