TokenCache class

インメモリ トークン キャッシュ マネージャー

プロパティ

persistence

メソッド

deserialize(string)

JSON をメモリ内キャッシュに逆シリアル化します。 JSON は MSAL キャッシュ スキーマ形式にする必要があります

getAccountByHomeId(string)

homeAccountId と一致するサインインしているアカウントを返します。 (ログインが成功した時点でアカウント オブジェクトが作成されます)、一致するアカウントが見つからない場合は null

getAccountByLocalId(string)

localAccountId と一致するサインインしているアカウントを返します。 (ログインが成功した時点でアカウント オブジェクトが作成されます)、一致するアカウントが見つからない場合は null

getAllAccounts(string)

現在キャッシュ内にあるすべてのアカウントをユーザーに取得する API

getCacheSnapshot()

CacheKVStore 形式のキャッシュ スナップショットを取得します

getKVStore()

キャッシュ キーと値のマップをフェッチします

hasChanged()

最後にシリアル化または writeToPersistence が呼び出されてからキャッシュの状態が変更された場合は true に設定します

overwriteCache()

メモリ内キャッシュを永続キャッシュで上書きします

removeAccount(AccountInfo, string)

キャッシュから特定のアカウントと関連データを削除する API

serialize()

メモリ キャッシュ内の JSON へのシリアル化

コンストラクターの詳細

TokenCache(NodeStorage, Logger, ICachePlugin)

new TokenCache(storage: NodeStorage, logger: Logger, cachePlugin?: ICachePlugin)

パラメーター

storage

NodeStorage

logger
Logger
cachePlugin
ICachePlugin

プロパティの詳細

persistence

persistence: ICachePlugin

プロパティ値

メソッドの詳細

deserialize(string)

JSON をメモリ内キャッシュに逆シリアル化します。 JSON は MSAL キャッシュ スキーマ形式にする必要があります

function deserialize(cache: string)

パラメーター

cache

string

BLOB 形式のキャッシュ

getAccountByHomeId(string)

homeAccountId と一致するサインインしているアカウントを返します。 (ログインが成功した時点でアカウント オブジェクトが作成されます)、一致するアカウントが見つからない場合は null

function getAccountByHomeId(homeAccountId: string): Promise<null | AccountInfo>

パラメーター

homeAccountId

string

アカウントの一意識別子 (uid.utid)

返品

Promise<null | AccountInfo>

getAccountByLocalId(string)

localAccountId と一致するサインインしているアカウントを返します。 (ログインが成功した時点でアカウント オブジェクトが作成されます)、一致するアカウントが見つからない場合は null

function getAccountByLocalId(localAccountId: string): Promise<null | AccountInfo>

パラメーター

localAccountId

string

アカウントの一意識別子 (homeAccountId を設定できない場合は sub/obj)

返品

Promise<null | AccountInfo>

getAllAccounts(string)

現在キャッシュ内にあるすべてのアカウントをユーザーに取得する API

function getAllAccounts(correlationId?: string): Promise<AccountInfo[]>

パラメーター

correlationId

string

返品

Promise<AccountInfo[]>

getCacheSnapshot()

CacheKVStore 形式のキャッシュ スナップショットを取得します

function getCacheSnapshot(): CacheKVStore

返品

getKVStore()

キャッシュ キーと値のマップをフェッチします

function getKVStore(): CacheKVStore

返品

hasChanged()

最後にシリアル化または writeToPersistence が呼び出されてからキャッシュの状態が変更された場合は true に設定します

function hasChanged(): boolean

返品

boolean

overwriteCache()

メモリ内キャッシュを永続キャッシュで上書きします

function overwriteCache(): Promise<void>

返品

Promise<void>

removeAccount(AccountInfo, string)

キャッシュから特定のアカウントと関連データを削除する API

function removeAccount(account: AccountInfo, correlationId?: string): Promise<void>

パラメーター

account
AccountInfo

ユーザーによって渡された AccountInfo

correlationId

string

返品

Promise<void>

serialize()

メモリ キャッシュ内の JSON へのシリアル化

function serialize(): string

返品

string