Class AuthorityMetadataEntity

Hierarchy

AuthorityMetadataEntity

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AuthorityMetadataEntity(): AuthorityMetadataEntity

- Defined in msal-common/src/cache/entities/AuthorityMetadataEntity.ts:22
Returns AuthorityMetadataEntity

Properties

aliases

aliases: string[]

aliasesFromNetwork

aliasesFromNetwork: boolean

authorization_endpoint

authorization_endpoint: string

canonical_authority

canonical_authority: string

Optional end_session_endpoint

end_session_endpoint: string

endpointsFromNetwork

endpointsFromNetwork: boolean

expiresAt

expiresAt: number

issuer

issuer: string

preferred_cache

preferred_cache: string

preferred_network

preferred_network: string

token_endpoint

token_endpoint: string

Methods

isExpired

isExpired(): boolean

- Defined in msal-common/src/cache/entities/AuthorityMetadataEntity.ts:71
Returns whether or not the data needs to be refreshed

Returns boolean

resetExpiresAt

resetExpiresAt(): void

- Defined in msal-common/src/cache/entities/AuthorityMetadataEntity.ts:64
Reset the exiresAt value

Returns void

updateCanonicalAuthority

updateCanonicalAuthority(authority: string): void

- Defined in msal-common/src/cache/entities/AuthorityMetadataEntity.ts:57
Save the authority that was used to create this cache entry

Parameters
- authority: string
Returns void

updateCloudDiscoveryMetadata

updateCloudDiscoveryMetadata(metadata: CloudDiscoveryMetadata, fromNetwork: boolean): void

- Defined in msal-common/src/cache/entities/AuthorityMetadataEntity.ts:33
Update the entity with new aliases, preferred_cache and preferred_network values

Parameters
- metadata: CloudDiscoveryMetadata
- fromNetwork: boolean
Returns void

updateEndpointMetadata

updateEndpointMetadata(metadata: OpenIdConfigResponse, fromNetwork: boolean): void

- Defined in msal-common/src/cache/entities/AuthorityMetadataEntity.ts:45
Update the entity with new endpoints

Parameters
- metadata: OpenIdConfigResponse
- fromNetwork: boolean
Returns void

Static isAuthorityMetadataEntity

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

- Defined in msal-common/src/cache/entities/AuthorityMetadataEntity.ts:79
Validates an entity: checks for all expected params

Parameters
- key: string
- entity: object
Returns boolean

Generated using TypeDoc