Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface class which implement cache storage functions used by MSAL to perform validity checks, and store tokens.

Hierarchy

Implements

  • ICacheManager

Index

Constructors

constructor

Methods

Abstract clear

  • clear(): Promise<void>

Abstract containsKey

  • containsKey(key: string, type?: string): boolean

generateAuthorityMetadataCacheKey

  • generateAuthorityMetadataCacheKey(authority: string): string
  • returns cache key used for cloud instance metadata

    Parameters

    • authority: string

    Returns string

Abstract getAccessTokenCredential

Abstract getAccount

getAccountsFilteredBy

  • getAccountsFilteredBy(accountFilter?: AccountFilter): Record<string, AccountEntity>
  • retrieve accounts matching all provided filters; if no filter is set, get all accounts not checking for casing as keys are all generated in lower case, remember to convert to lower case if object properties are compared

    Parameters

    • Optional accountFilter: AccountFilter

    Returns Record<string, AccountEntity>

getAllAccounts

Abstract getAppMetadata

getAppMetadataFilteredBy

  • getAppMetadataFilteredBy(filter: AppMetadataFilter): Record<string, AppMetadataEntity>

Abstract getAuthorityMetadata

getAuthorityMetadataByAlias

Abstract getAuthorityMetadataKeys

  • getAuthorityMetadataKeys(): string[]

getCredentialsFilteredBy

  • getCredentialsFilteredBy(filter: CredentialFilter): CredentialCache
  • retrieve credentails matching all provided filters; if no filter is set, get all credentials

    Parameters

    • filter: CredentialFilter

    Returns CredentialCache

Abstract getIdTokenCredential

Abstract getKeys

  • getKeys(): string[]

Abstract getRefreshTokenCredential

Abstract getServerTelemetry

Abstract getThrottlingCache

isAppMetadataFOCI

  • isAppMetadataFOCI(environment: string, clientId: string): boolean

readAccessTokenFromCache

readAccountFromCache

readAppMetadataFromCache

readCacheRecord

readIdTokenFromCache

readRefreshTokenFromCache

removeAccount

  • removeAccount(accountKey: string): Promise<boolean>
  • returns a boolean if the given account is removed

    Parameters

    • accountKey: string

    Returns Promise<boolean>

removeAccountContext

removeAllAccounts

  • removeAllAccounts(): Promise<boolean>

removeAppMetadata

  • removeAppMetadata(): boolean

removeCredential

Abstract removeItem

  • removeItem(key: string, type?: string): boolean

saveCacheRecord

  • saveCacheRecord(cacheRecord: CacheRecord): Promise<void>

Abstract setAccessTokenCredential

Abstract setAccount

Abstract setAppMetadata

Abstract setAuthorityMetadata

Abstract setIdTokenCredential

Abstract setRefreshTokenCredential

Abstract setServerTelemetry

Abstract setThrottlingCache

  • setThrottlingCache(throttlingCacheKey: string, throttlingCache: ThrottlingEntity): void

Abstract updateCredentialCacheKey

Static toObject

  • toObject<T>(obj: T, json: object): T

Generated using TypeDoc