CacheHelpers module

Paquet:

@azure/msal-common

Functions

createAccessTokenEntity(string, string, string, string, string, string, number, number, (input: string) => string, number, AuthenticationScheme, string, string, string, string)	Créer AccessTokenEntity
createIdTokenEntity(string, string, string, string, string)	Créer IdTokenEntity
createRefreshTokenEntity(string, string, string, string, string, string, number)	Créer RefreshTokenEntity
generateAppMetadataKey(AppMetadataEntity)	Générer une clé de cache AppMetadata en fonction du schéma : appmetadata-environment-client_id<><>
generateAuthorityMetadataExpiresAt()	Réinitialiser la valeur exiresAt
isAccessTokenEntity(object)	Valide une entité : vérifie toutes les params attendues
isAppMetadataEntity(string, object)
isAuthorityMetadataEntity(string, object)	Valide une entité : vérifie toutes les params attendues
isAuthorityMetadataExpired(AuthorityMetadataEntity)	Retourne si les données doivent être actualisées ou non
isCredentialEntity(object)
isIdTokenEntity(object)	Valide une entité : vérifie toutes les params attendues
isRefreshTokenEntity(object)	Valide une entité : vérifie toutes les params attendues
isServerTelemetryEntity(string, object)	valide si une entrée de cache donnée est « Télémétrie », analyse la <clé, la valeur>
isThrottlingEntity(string, object)	valide si une entrée de cache donnée est « Limitation », analyse la <clé, la valeur>
updateAuthorityEndpointMetadata(AuthorityMetadataEntity, OpenIdConfigResponse, boolean)
updateCloudDiscoveryMetadata(AuthorityMetadataEntity, CloudDiscoveryMetadata, boolean)

Informations relatives à la fonction

createAccessTokenEntity(string, string, string, string, string, string, number, number, (input: string) => string, number, AuthenticationScheme, string, string, string, string)

Créer AccessTokenEntity

function createAccessTokenEntity(homeAccountId: string, environment: string, accessToken: string, clientId: string, tenantId: string, scopes: string, expiresOn: number, extExpiresOn: number, base64Decode: (input: string) => string, refreshOn?: number, tokenType?: AuthenticationScheme, userAssertionHash?: string, keyId?: string, requestedClaims?: string, requestedClaimsHash?: string): AccessTokenEntity

Paramètres

homeAccountId

string

environment

string

accessToken

string

clientId

string

tenantId

string

scopes

string

expiresOn

number

extExpiresOn

number

base64Decode

(input: string) => string

refreshOn

number

tokenType

AuthenticationScheme

userAssertionHash

string

keyId

string

requestedClaims

string

requestedClaimsHash

string

Retours

AccessTokenEntity

createIdTokenEntity(string, string, string, string, string)

Créer IdTokenEntity

function createIdTokenEntity(homeAccountId: string, environment: string, idToken: string, clientId: string, tenantId: string): IdTokenEntity

Paramètres

homeAccountId

string

environment

string

idToken

string

clientId

string

tenantId

string

Retours

IdTokenEntity

createRefreshTokenEntity(string, string, string, string, string, string, number)

Créer RefreshTokenEntity

function createRefreshTokenEntity(homeAccountId: string, environment: string, refreshToken: string, clientId: string, familyId?: string, userAssertionHash?: string, expiresOn?: number): RefreshTokenEntity

Paramètres

homeAccountId

string

environment

string

refreshToken

string

clientId

string

familyId

string

userAssertionHash

string

expiresOn

number

Retours

RefreshTokenEntity

generateAppMetadataKey(AppMetadataEntity)

Générer une clé de cache AppMetadata en fonction du schéma : appmetadata-environment-client_id<><>

function generateAppMetadataKey(__namedParameters: AppMetadataEntity): string

Paramètres

__namedParameters

AppMetadataEntity

Retours

string

generateAuthorityMetadataExpiresAt()

Réinitialiser la valeur exiresAt

function generateAuthorityMetadataExpiresAt(): number

Retours

number

isAccessTokenEntity(object)

Valide une entité : vérifie toutes les params attendues

function isAccessTokenEntity(entity: object): entity

Paramètres

entity

object

Retours

entity

isAppMetadataEntity(string, object)

function isAppMetadataEntity(key: string, entity: object): boolean

Paramètres

key

string

entity

object

Retours

boolean

isAuthorityMetadataEntity(string, object)

Valide une entité : vérifie toutes les params attendues

function isAuthorityMetadataEntity(key: string, entity: object): boolean

Paramètres

key

string

entity

object

Retours

boolean

isAuthorityMetadataExpired(AuthorityMetadataEntity)

Retourne si les données doivent être actualisées ou non

function isAuthorityMetadataExpired(metadata: AuthorityMetadataEntity): boolean

Paramètres

metadata

AuthorityMetadataEntity

Retours

boolean

isCredentialEntity(object)

function isCredentialEntity(entity: object): entity

Paramètres

entity

object

Retours

entity

isIdTokenEntity(object)

Valide une entité : vérifie toutes les params attendues

function isIdTokenEntity(entity: object): entity

Paramètres

entity

object

Retours

entity

isRefreshTokenEntity(object)

Valide une entité : vérifie toutes les params attendues

function isRefreshTokenEntity(entity: object): entity

Paramètres

entity

object

Retours

entity

isServerTelemetryEntity(string, object)

valide si une entrée de cache donnée est « Télémétrie », analyse la <clé, la valeur>

function isServerTelemetryEntity(key: string, entity?: object): boolean

Paramètres

key

string

entity

object

Retours

boolean

isThrottlingEntity(string, object)

valide si une entrée de cache donnée est « Limitation », analyse la <clé, la valeur>

function isThrottlingEntity(key: string, entity?: object): boolean

Paramètres

key

string

entity

object

Retours

boolean

updateAuthorityEndpointMetadata(AuthorityMetadataEntity, OpenIdConfigResponse, boolean)

function updateAuthorityEndpointMetadata(authorityMetadata: AuthorityMetadataEntity, updatedValues: OpenIdConfigResponse, fromNetwork: boolean)

Paramètres

authorityMetadata

AuthorityMetadataEntity

updatedValues

OpenIdConfigResponse

fromNetwork

boolean

updateCloudDiscoveryMetadata(AuthorityMetadataEntity, CloudDiscoveryMetadata, boolean)

function updateCloudDiscoveryMetadata(authorityMetadata: AuthorityMetadataEntity, updatedValues: CloudDiscoveryMetadata, fromNetwork: boolean)

Paramètres

authorityMetadata

AuthorityMetadataEntity

updatedValues

CloudDiscoveryMetadata

fromNetwork

boolean