Type alias TokenCache

Type declaration

• flush:function

  • flush(): boolean

  • Flush cache

    Returns boolean

    true if the operation succeeded, false otherwise

• getTokenCachePath:function

  • getTokenCachePath(): string

  • Get connection profiles file name

    Returns string

    connection profiles file name

• hasSaBearerToken:function

  • hasSaBearerToken(): Promise<boolean>

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

    Returns Promise<boolean>

    true if tokens found in cache, false otherwise

• hasToken:function

  • hasToken(tokenType: tokenType): Promise<boolean>

  • Check if there are suitable tokens in the cache

    Parameters

    • tokenType: tokenType

      type of token

    Returns Promise<boolean>

    true if tokens found in cache, false otherwise

• hasUserBearerToken:function

  • hasUserBearerToken(): Promise<boolean>

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

    Returns Promise<boolean>

    true if tokens found in cache, false otherwise

• hasUserSessionToken:function

  • hasUserSessionToken(): Promise<boolean>

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

    Returns Promise<boolean>

    true if tokens found in cache, false otherwise

• initTokenCache:function

  • initTokenCache(): void

  • 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

• purge:function

  • purge(): TokenCacheInterface

  • Purge all expired tokens from cache

    Returns TokenCacheInterface

    purged cache

• readSaBearerToken:function

  • readSaBearerToken(): Promise<AccessTokenMetaType>

  • Read service account bearer token

    Returns Promise<AccessTokenMetaType>

    token or null

• readToken:function

  • readToken(tokenType: tokenType): Promise<AccessTokenMetaType | UserSessionMetaType>

  • Read token

    Parameters

    • tokenType: tokenType

      type of token

    Returns Promise<AccessTokenMetaType | UserSessionMetaType>

    token or null

• readUserBearerToken:function

  • readUserBearerToken(): Promise<AccessTokenMetaType>

  • Read user bearer token

    Returns Promise<AccessTokenMetaType>

    token or null

• readUserSessionToken:function

  • readUserSessionToken(): Promise<UserSessionMetaType>

  • Read user session token

    Returns Promise<UserSessionMetaType>

    token or null

• saveSaBearerToken:function

  • saveSaBearerToken(token: AccessTokenMetaType): Promise<boolean>

  • Save service account bearer token for current connection

    Parameters

    • token: AccessTokenMetaType

    Returns Promise<boolean>

    true if the operation succeeded, false otherwise

• saveUserBearerToken:function

  • saveUserBearerToken(token: AccessTokenMetaType): Promise<boolean>

  • Save user bearer token for current connection

    Parameters

    • token: AccessTokenMetaType

    Returns Promise<boolean>

    true if the operation succeeded, false otherwise

• saveUserSessionToken:function

  • saveUserSessionToken(token: UserSessionMetaType): Promise<boolean>

  • Save user session token for current connection

    Parameters

    • token: UserSessionMetaType

    Returns Promise<boolean>

    true if the operation succeeded, false otherwise