CacheHelpers module

Paquete:

@azure/msal-common

Funciones

createAccessTokenEntity(string, string, string, string, string, string, number, number, (input: string) => string, number, AuthenticationScheme, string, string, string, string)	Creación de AccessTokenEntity
createIdTokenEntity(string, string, string, string, string)	Creación de IdTokenEntity
createRefreshTokenEntity(string, string, string, string, string, string, number)	Creación de RefreshTokenEntity
generateAppMetadataKey(AppMetadataEntity)	Generar clave de caché de AppMetadata según el esquema: appmetadata-environment-client_id<><>
generateAuthorityMetadataExpiresAt()	Restablecer el valor de exiresAt
isAccessTokenEntity(object)	Valida una entidad: comprueba todos los parámetros esperados.
isAppMetadataEntity(string, object)
isAuthorityMetadataEntity(string, object)	Valida una entidad: comprueba todos los parámetros esperados.
isAuthorityMetadataExpired(AuthorityMetadataEntity)	Devuelve si es necesario actualizar o no los datos.
isCredentialEntity(object)
isIdTokenEntity(object)	Valida una entidad: comprueba todos los parámetros esperados.
isRefreshTokenEntity(object)	Valida una entidad: comprueba todos los parámetros esperados.
isServerTelemetryEntity(string, object)	valida si una entrada de caché determinada es "Telemetry", analiza <key,value>
isThrottlingEntity(string, object)	valida si una entrada de caché determinada es "Throttling", analiza <key,value>
updateAuthorityEndpointMetadata(AuthorityMetadataEntity, OpenIdConfigResponse, boolean)
updateCloudDiscoveryMetadata(AuthorityMetadataEntity, CloudDiscoveryMetadata, boolean)

Detalles de la función

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

Creación de 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

Parámetros

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

Devoluciones

AccessTokenEntity

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

Creación de IdTokenEntity

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

Parámetros

homeAccountId

string

environment

string

idToken

string

clientId

string

tenantId

string

Devoluciones

IdTokenEntity

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

Creación de RefreshTokenEntity

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

Parámetros

homeAccountId

string

environment

string

refreshToken

string

clientId

string

familyId

string

userAssertionHash

string

expiresOn

number

Devoluciones

RefreshTokenEntity

generateAppMetadataKey(AppMetadataEntity)

Generar clave de caché de AppMetadata según el esquema: appmetadata-environment-client_id<><>

function generateAppMetadataKey(__namedParameters: AppMetadataEntity): string

Parámetros

__namedParameters

AppMetadataEntity

Devoluciones

string

generateAuthorityMetadataExpiresAt()

Restablecer el valor de exiresAt

function generateAuthorityMetadataExpiresAt(): number

Devoluciones

number

isAccessTokenEntity(object)

Valida una entidad: comprueba todos los parámetros esperados.

function isAccessTokenEntity(entity: object): entity

Parámetros

entity

object

Devoluciones

entity

isAppMetadataEntity(string, object)

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

Parámetros

key

string

entity

object

Devoluciones

boolean

isAuthorityMetadataEntity(string, object)

Valida una entidad: comprueba todos los parámetros esperados.

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

Parámetros

key

string

entity

object

Devoluciones

boolean

isAuthorityMetadataExpired(AuthorityMetadataEntity)

Devuelve si es necesario actualizar o no los datos.

function isAuthorityMetadataExpired(metadata: AuthorityMetadataEntity): boolean

Parámetros

metadata

AuthorityMetadataEntity

Devoluciones

boolean

isCredentialEntity(object)

function isCredentialEntity(entity: object): entity

Parámetros

entity

object

Devoluciones

entity

isIdTokenEntity(object)

Valida una entidad: comprueba todos los parámetros esperados.

function isIdTokenEntity(entity: object): entity

Parámetros

entity

object

Devoluciones

entity

isRefreshTokenEntity(object)

Valida una entidad: comprueba todos los parámetros esperados.

function isRefreshTokenEntity(entity: object): entity

Parámetros

entity

object

Devoluciones

entity

isServerTelemetryEntity(string, object)

valida si una entrada de caché determinada es "Telemetry", analiza <key,value>

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

Parámetros

key

string

entity

object

Devoluciones

boolean

isThrottlingEntity(string, object)

valida si una entrada de caché determinada es "Throttling", analiza <key,value>

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

Parámetros

key

string

entity

object

Devoluciones

boolean

updateAuthorityEndpointMetadata(AuthorityMetadataEntity, OpenIdConfigResponse, boolean)

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

Parámetros

authorityMetadata

AuthorityMetadataEntity

updatedValues

OpenIdConfigResponse

fromNetwork

boolean

updateCloudDiscoveryMetadata(AuthorityMetadataEntity, CloudDiscoveryMetadata, boolean)

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

Parámetros

authorityMetadata

AuthorityMetadataEntity

updatedValues

CloudDiscoveryMetadata

fromNetwork

boolean