CacheHelpers module

Пакет:

@azure/msal-common

Функции

createAccessTokenEntity(string, string, string, string, string, string, number, number, (input: string) => string, number, AuthenticationScheme, string, string, string, string)	Создание AccessTokenEntity
createIdTokenEntity(string, string, string, string, string)	Создание IdTokenEntity
createRefreshTokenEntity(string, string, string, string, string, string, number)	Создание RefreshTokenEntity
generateAppMetadataKey(AppMetadataEntity)	Создание ключа кэша AppMetadata в схеме: appmetadata-environment-client_id<><>
generateAuthorityMetadataExpiresAt()	Сброс значения exiresAt
isAccessTokenEntity(object)	Проверяет сущность: проверяет наличие всех ожидаемых парам
isAppMetadataEntity(string, object)
isAuthorityMetadataEntity(string, object)	Проверяет сущность: проверяет наличие всех ожидаемых парам
isAuthorityMetadataExpired(AuthorityMetadataEntity)	Возвращает значение, необходимо ли обновить данные
isCredentialEntity(object)
isIdTokenEntity(object)	Проверяет сущность: проверяет наличие всех ожидаемых парам
isRefreshTokenEntity(object)	Проверяет сущность: проверяет наличие всех ожидаемых парам
isServerTelemetryEntity(string, object)	проверяет, является ли заданная запись кэша "Telemetry", анализирует <ключ, значение>
isThrottlingEntity(string, object)	проверяет, является ли заданная запись кэша "Регулирование", анализирует <ключ, значение>
updateAuthorityEndpointMetadata(AuthorityMetadataEntity, OpenIdConfigResponse, boolean)
updateCloudDiscoveryMetadata(AuthorityMetadataEntity, CloudDiscoveryMetadata, boolean)

Сведения о функции

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

Создание 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

Параметры

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

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

Создание IdTokenEntity

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

Параметры

homeAccountId

string

environment

string

idToken

string

clientId

string

tenantId

string

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

IdTokenEntity

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

Создание RefreshTokenEntity

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

Параметры

homeAccountId

string

environment

string

refreshToken

string

clientId

string

familyId

string

userAssertionHash

string

expiresOn

number

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

RefreshTokenEntity

generateAppMetadataKey(AppMetadataEntity)

Создание ключа кэша AppMetadata в схеме: appmetadata-environment-client_id<><>

function generateAppMetadataKey(__namedParameters: AppMetadataEntity): string

Параметры

__namedParameters

AppMetadataEntity

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

string

generateAuthorityMetadataExpiresAt()

Сброс значения exiresAt

function generateAuthorityMetadataExpiresAt(): number

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

number

isAccessTokenEntity(object)

Проверяет сущность: проверяет наличие всех ожидаемых парам

function isAccessTokenEntity(entity: object): entity

Параметры

entity

object

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

entity

isAppMetadataEntity(string, object)

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

Параметры

key

string

entity

object

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

boolean

isAuthorityMetadataEntity(string, object)

Проверяет сущность: проверяет наличие всех ожидаемых парам

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

Параметры

key

string

entity

object

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

boolean

isAuthorityMetadataExpired(AuthorityMetadataEntity)

Возвращает значение, необходимо ли обновить данные

function isAuthorityMetadataExpired(metadata: AuthorityMetadataEntity): boolean

Параметры

metadata

AuthorityMetadataEntity

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

boolean

isCredentialEntity(object)

function isCredentialEntity(entity: object): entity

Параметры

entity

object

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

entity

isIdTokenEntity(object)

Проверяет сущность: проверяет наличие всех ожидаемых парам

function isIdTokenEntity(entity: object): entity

Параметры

entity

object

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

entity

isRefreshTokenEntity(object)

Проверяет сущность: проверяет наличие всех ожидаемых парам

function isRefreshTokenEntity(entity: object): entity

Параметры

entity

object

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

entity

isServerTelemetryEntity(string, object)

проверяет, является ли заданная запись кэша "Telemetry", анализирует <ключ, значение>

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

Параметры

key

string

entity

object

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

boolean

isThrottlingEntity(string, object)

проверяет, является ли заданная запись кэша "Регулирование", анализирует <ключ, значение>

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

Параметры

key

string

entity

object

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

boolean

updateAuthorityEndpointMetadata(AuthorityMetadataEntity, OpenIdConfigResponse, boolean)

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

Параметры

authorityMetadata

AuthorityMetadataEntity

updatedValues

OpenIdConfigResponse

fromNetwork

boolean

updateCloudDiscoveryMetadata(AuthorityMetadataEntity, CloudDiscoveryMetadata, boolean)

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

Параметры

authorityMetadata

AuthorityMetadataEntity

updatedValues

CloudDiscoveryMetadata

fromNetwork

boolean