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" であるかどうかを検証し、 <key、value を解析します>
isThrottlingEntity(string, object)	は、特定のキャッシュ エントリが "Throttling" であるかどうかを検証し、 <key,value を解析します>
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" であるかどうかを検証し、 <key、value を解析します>

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

パラメーター

key

string

entity

object

返品

boolean

isThrottlingEntity(string, object)

は、特定のキャッシュ エントリが "Throttling" であるかどうかを検証し、 <key,value を解析します>

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