Frodo Library - v4.0.0-10
    Preparing search index...

    Type Alias TokenCache

    type TokenCache = {
        flush(): boolean;
        getTokenCachePath(): string;
        hasSaBearerToken(): Promise<boolean>;
        hasToken(tokenType: tokenType): Promise<boolean>;
        hasUserBearerToken(): Promise<boolean>;
        hasUserSessionToken(): Promise<boolean>;
        initTokenCache(): void;
        purge(): TokenCacheInterface;
        readSaBearerToken(): Promise<AccessTokenMetaType>;
        readToken(
            tokenType: tokenType,
        ): Promise<AccessTokenMetaType | UserSessionMetaType>;
        readUserBearerToken(): Promise<AccessTokenMetaType>;
        readUserSessionToken(): Promise<UserSessionMetaType>;
        saveSaBearerToken(token: AccessTokenMetaType): Promise<boolean>;
        saveUserBearerToken(token: AccessTokenMetaType): Promise<boolean>;
        saveUserSessionToken(token: UserSessionMetaType): Promise<boolean>;
    }
    Index

    Methods

    • Flush cache

      Returns boolean

      true if the operation succeeded, false otherwise

    • Get connection profiles file name

      Returns string

      connection profiles file name

    • Check if there are suitable service account bearer tokens in the cache

      Returns Promise<boolean>

      true if tokens found in cache, false otherwise

    • Check if there are suitable tokens in the cache

      Parameters

      Returns Promise<boolean>

      true if tokens found in cache, false otherwise

    • Check if there are suitable user bearer tokens in the cache

      Returns Promise<boolean>

      true if tokens found in cache, false otherwise

    • Check if there are suitable user session tokens in the cache

      Returns Promise<boolean>

      true if tokens found in cache, false otherwise

    • Initialize token cache

      This method is called from app.ts and runs before any of the message handlers are registered. Therefore none of the Console message functions will produce any output.

      Returns void