Class ProtocolUtils

Class which provides helpers for OAuth 2.0 protocol specific values

Hierarchy

ProtocolUtils

Index

Constructors

constructor

Methods

Constructors

constructor

new ProtocolUtils(): ProtocolUtils

Returns ProtocolUtils

Methods

Static generateLibraryState

generateLibraryState(cryptoObj: ICrypto, meta?: Record<string, string>): string

- Defined in msal-common/src/utils/ProtocolUtils.ts:51
Generates the state value used by the common library.

Parameters
- cryptoObj: ICrypto
- Optional meta: Record<string, string>
Returns string

Static parseRequestState

parseRequestState(cryptoObj: ICrypto, state: string): RequestStateObject

- Defined in msal-common/src/utils/ProtocolUtils.ts:75
Parses the state into the RequestStateObject, which contains the LibraryState info and the state passed by the user.

Parameters
- cryptoObj: ICrypto
- state: string
Returns RequestStateObject

Static setRequestState

setRequestState(cryptoObj: ICrypto, userState?: string, meta?: Record<string, string>): string

- Defined in msal-common/src/utils/ProtocolUtils.ts:41
Appends user state with random guid, or returns random guid.

Parameters
- cryptoObj: ICrypto
- Optional userState: string
- Optional meta: Record<string, string>
Returns string

Generated using TypeDoc