TokenCache class

Пакет:

@azure/msal-node

Диспетчер кэша маркеров в памяти

Конструкторы

TokenCache(NodeStorage, Logger, ICachePlugin)

Свойства

persistence

Методы

deserialize(string)	Десериализация JSON в кэш в памяти. JSON должен находиться в формате схемы кэша MSAL
getAccountByHomeId(string)	Возвращает входную учетную запись, соответствующую homeAccountId. (объект учетной записи создается во время успешного входа) или null, если учетная запись не найдена.
getAccountByLocalId(string)	Возвращает вошедшего в систему учетную запись, соответствующую localAccountId. (объект учетной записи создается во время успешного входа) или null, если учетная запись не найдена.
getAllAccounts(string)	API, который извлекает все учетные записи в кэше пользователю
getCacheSnapshot()	Возвращает моментальный снимок кэша в формате CacheKVStore
getKVStore()	Получение карты "ключ-значение кэша"
hasChanged()	Значение true, если состояние кэша изменилось с момента последнего сериализации или записиToPersistence
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

Значение свойства

ICachePlugin

Сведения о методе

deserialize(string)

Десериализация JSON в кэш в памяти. JSON должен находиться в формате схемы кэша MSAL

function deserialize(cache: string)

Параметры

cache

string

Кэш большого двоичного объекта в формате

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

уникальный идентификатор учетной записи (sub/obj, если homeAccountId не может быть заполнен)

Возвращаемое значение

Promise<null | AccountInfo>

getAllAccounts(string)

API, который извлекает все учетные записи в кэше пользователю

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

Параметры

correlationId

string

Возвращаемое значение

Promise<AccountInfo[]>

getCacheSnapshot()

Возвращает моментальный снимок кэша в формате CacheKVStore

function getCacheSnapshot(): CacheKVStore

Возвращаемое значение

CacheKVStore

getKVStore()

Получение карты "ключ-значение кэша"

function getKVStore(): CacheKVStore

Возвращаемое значение

CacheKVStore

hasChanged()

Значение true, если состояние кэша изменилось с момента последнего сериализации или записиToPersistence

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