Interface GetTokensOptions

Configuration options.

interface GetTokensOptions {
    callbackFactory?: FRCallbackFactory;
    clientId?: string;
    middleware?: RequestMiddleware[];
    realmPath?: string;
    redirectUri?: string;
    scope?: string;
    serverConfig?: ServerConfig;
    tokenStore?: TokenStoreObject | "sessionStorage" | "localStorage";
    tree?: string;
    type?: string;
    oauthThreshold?: number;
    logLevel?: LogLevel;
    logger?: LoggerFunctions<((...msgs) => void), ((...msgs) => void), ((...msgs) => void), ((...msgs) => void)>;
    platformHeader?: boolean;
    prefix?: string;
    forceRenew?: boolean;
    login?: "redirect" | "embedded";
    query?: StringDict<string>;
}

Hierarchy (view full)

Properties

callbackFactory? clientId? middleware? realmPath? redirectUri? scope? serverConfig? tokenStore? tree? type? oauthThreshold? logLevel? logger? platformHeader? prefix? forceRenew? login? query?

Properties

Optional callbackFactory

callbackFactory?: FRCallbackFactory

Optional clientId

clientId?: string

Optional middleware

middleware?: RequestMiddleware[]

Optional realmPath

realmPath?: string

Optional redirectUri

redirectUri?: string

Optional scope

scope?: string

Optional serverConfig

serverConfig?: ServerConfig

Optional tokenStore

tokenStore?: TokenStoreObject | "sessionStorage" | "localStorage"

Optional tree

tree?: string

Optional type

type?: string

Optional oauthThreshold

oauthThreshold?: number

Optional logLevel

logLevel?: LogLevel

Optional logger

logger?: LoggerFunctions<((...msgs) => void), ((...msgs) => void), ((...msgs) => void), ((...msgs) => void)>

Type declaration

    • (...msgs): void

    • Parameters

      • Rest ...msgs: unknown[]

      Returns void

Type declaration

    • (...msgs): void

    • Parameters

      • Rest ...msgs: unknown[]

      Returns void

Type declaration

    • (...msgs): void

    • Parameters

      • Rest ...msgs: unknown[]

      Returns void

Type declaration

    • (...msgs): void

    • Parameters

      • Rest ...msgs: unknown[]

      Returns void

Optional platformHeader

platformHeader?: boolean

Optional prefix

prefix?: string

Optional forceRenew

forceRenew?: boolean

Optional login

login?: "redirect" | "embedded"

Optional query

query?: StringDict<string>

Settings

Member Visibility

Theme

On This Page

callbackFactoryclientIdmiddlewarerealmPathredirectUriscopeserverConfigtokenStoretreetypeoauthThresholdlogLevelloggerplatformHeaderprefixforceRenewloginquery