Class OAuth2ErrorResponse

Hierarchy (View Summary)

BaseOAuth2ErrorResponse
- OAuth2ErrorResponse

Index

Constructors

Properties

error errorDescription? errorUri?

Methods

getErrorDescription getErrorUri setErrorDescription setErrorUri toJSON toObject

Constructors

constructor

new OAuth2ErrorResponse(
    error: OAuth2Error,
    errorDescription?: string,
    errorUri?: string,
): OAuth2ErrorResponse
Parameters
- error: OAuth2Error
- OptionalerrorDescription: string
- OptionalerrorUri: string
Returns OAuth2ErrorResponse
Overrides BaseOAuth2ErrorResponse.constructor
- Defined in src/security/oauth2/responses.ts:46

Properties

`Protected`error

error: OAuth2Error

`Protected` `Optional`errorDescription

errorDescription?: string

`Protected` `Optional`errorUri

errorUri?: string

Methods

getErrorDescription

getErrorDescription(): undefined | string
Returns undefined | string
Inherited from BaseOAuth2ErrorResponse.getErrorDescription
- Defined in src/security/oauth2/responses.ts:17

getErrorUri

getErrorUri(): undefined | string
Returns undefined | string
Inherited from BaseOAuth2ErrorResponse.getErrorUri
- Defined in src/security/oauth2/responses.ts:25

setErrorDescription

setErrorDescription(value?: string): BaseOAuth2ErrorResponse
Parameters
- Optionalvalue: string
Returns BaseOAuth2ErrorResponse
Inherited from BaseOAuth2ErrorResponse.setErrorDescription
- Defined in src/security/oauth2/responses.ts:13

setErrorUri

setErrorUri(value?: string): BaseOAuth2ErrorResponse
Parameters
- Optionalvalue: string
Returns BaseOAuth2ErrorResponse
Inherited from BaseOAuth2ErrorResponse.setErrorUri
- Defined in src/security/oauth2/responses.ts:21

toJSON

toJSON(): { error: string; error_description?: string; error_uri?: string }
Returns { error: string; error_description?: string; error_uri?: string }
Inherited from BaseOAuth2ErrorResponse.toJSON
- Defined in src/security/oauth2/responses.ts:37

toObject

toObject(): { error: string; error_description?: string; error_uri?: string }
Returns { error: string; error_description?: string; error_uri?: string }
Inherited from BaseOAuth2ErrorResponse.toObject
- Defined in src/security/oauth2/responses.ts:29