Class PromptHandler

Redirects requests based on the OIDC Interaction prompt. Errors in case no match was found.

Hierarchy

InteractionHandler
- PromptHandler

Index

Constructors

constructor

Properties

promptRoutes

Methods

Constructors

constructor

new PromptHandler(promptRoutes: Record<string, InteractionRoute>): PromptHandler

Overrides InteractionHandler.constructor
- Defined in src/identity/interaction/PromptHandler.ts:14
Parameters
- promptRoutes: Record<string, InteractionRoute>
Returns PromptHandler

Properties

Private Readonly promptRoutes

promptRoutes: Record<string, InteractionRoute>

Methods

canHandle

canHandle(__namedParameters: InteractionHandlerInput): Promise<void>

Inherited from InteractionHandler.canHandle
- Defined in src/identity/interaction/InteractionHandler.ts:28
Checks if the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.

Parameters
- __namedParameters: InteractionHandlerInput
Returns Promise<void>

handle

handle(__namedParameters: InteractionHandlerInput): Promise<never>

Overrides InteractionHandler.handle
- Defined in src/identity/interaction/PromptHandler.ts:19
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Parameters
- __namedParameters: InteractionHandlerInput
Returns Promise<never>
A promise resolving when handling is finished.

handleSafe

handleSafe(input: InteractionHandlerInput): Promise<Representation>

Inherited from InteractionHandler.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:34
Helper function that first runs canHandle followed by handle. Throws the error of canHandle if the data cannot be handled, or returns the result of handle otherwise.

Parameters
- input: InteractionHandlerInput
  
  Input data that will be handled if it can be handled.
Returns Promise<Representation>
A promise resolving if the input can be handled, rejecting with an Error if not.