TokenCache class
Správce mezipaměti tokenů v paměti
Konstruktory
| Token |
Vlastnosti
| persistence |
Metody
| deserialize(string) | Deserializuje JSON do mezipaměti v paměti. Json by měl být ve formátu schématu mezipaměti MSAL. |
| get |
Vrátí přihlášený účet odpovídající homeAccountId. (objekt účtu se vytvoří v době úspěšného přihlášení) nebo null, pokud se nenajde žádný odpovídající účet. |
| get |
Vrátí přihlášený účet odpovídající localAccountId. (objekt účtu se vytvoří v době úspěšného přihlášení) nebo null, pokud se nenajde žádný odpovídající účet. |
| get |
Rozhraní API, které načte všechny účty aktuálně uložené v mezipaměti uživateli |
| get |
Získá snímek mezipaměti ve formátu CacheKVStore. |
| get |
Načte mapu klíč-hodnota mezipaměti. |
| has |
Nastaveno na hodnotu True, pokud se od posledního serializace nebo zápisu DoPersistence změnil stav mezipaměti. |
| overwrite |
Přepíše mezipaměť v paměti s trvalou mezipamětí. |
| remove |
Rozhraní API pro odebrání konkrétního účtu a relevantních dat z mezipaměti |
| serialize() | Serializuje v mezipaměti paměti do FORMÁTU JSON. |
Podrobnosti konstruktoru
TokenCache(NodeStorage, Logger, ICachePlugin)
new TokenCache(storage: NodeStorage, logger: Logger, cachePlugin?: ICachePlugin)
Parametry
- storage
-
NodeStorage
- logger
- Logger
- cachePlugin
- ICachePlugin
Podrobnosti vlastnosti
persistence
Podrobnosti metody
deserialize(string)
Deserializuje JSON do mezipaměti v paměti. Json by měl být ve formátu schématu mezipaměti MSAL.
function deserialize(cache: string)
Parametry
- cache
-
string
Mezipaměť ve formátu objektu blob
getAccountByHomeId(string)
Vrátí přihlášený účet odpovídající homeAccountId. (objekt účtu se vytvoří v době úspěšného přihlášení) nebo null, pokud se nenajde žádný odpovídající účet.
function getAccountByHomeId(homeAccountId: string): Promise<null | AccountInfo>
Parametry
- homeAccountId
-
string
jedinečný identifikátor účtu (uid.utid)
Návraty
Promise<null | AccountInfo>
getAccountByLocalId(string)
Vrátí přihlášený účet odpovídající localAccountId. (objekt účtu se vytvoří v době úspěšného přihlášení) nebo null, pokud se nenajde žádný odpovídající účet.
function getAccountByLocalId(localAccountId: string): Promise<null | AccountInfo>
Parametry
- localAccountId
-
string
jedinečný identifikátor účtu (dílčí/obj, pokud homeAccountId nelze naplnit)
Návraty
Promise<null | AccountInfo>
getAllAccounts(string)
Rozhraní API, které načte všechny účty aktuálně uložené v mezipaměti uživateli
function getAllAccounts(correlationId?: string): Promise<AccountInfo[]>
Parametry
- correlationId
-
string
Návraty
Promise<AccountInfo[]>
getCacheSnapshot()
Získá snímek mezipaměti ve formátu CacheKVStore.
function getCacheSnapshot(): CacheKVStore
Návraty
getKVStore()
hasChanged()
Nastaveno na hodnotu True, pokud se od posledního serializace nebo zápisu DoPersistence změnil stav mezipaměti.
function hasChanged(): boolean
Návraty
boolean
overwriteCache()
Přepíše mezipaměť v paměti s trvalou mezipamětí.
function overwriteCache(): Promise<void>
Návraty
Promise<void>
removeAccount(AccountInfo, string)
Rozhraní API pro odebrání konkrétního účtu a relevantních dat z mezipaměti
function removeAccount(account: AccountInfo, correlationId?: string): Promise<void>
Parametry
- account
- AccountInfo
Informace o účtu předané uživatelem
- correlationId
-
string
Návraty
Promise<void>
serialize()
Serializuje v mezipaměti paměti do FORMÁTU JSON.
function serialize(): string
Návraty
string