Interface InteractionRoute

Handles the routing behaviour for IDP handlers.

Hierarchy

InteractionRoute

Implemented by

BasicInteractionRoute

Index

Methods

Methods

getControls

getControls(): Record<string, string>

- Defined in src/identity/interaction/routing/InteractionRoute.ts:16
Returns the control fields that should be added to response objects. Keys are control names, values are relative URL paths.

Returns Record<string, string>

handleOperation

handleOperation(operation: Operation, oidcInteraction?: Interaction): Promise<TemplatedInteractionResult<InteractionHandlerResult>>

- Defined in src/identity/interaction/routing/InteractionRoute.ts:32
Handles the given operation.

Parameters
- operation: Operation
  Operation to handle.
- Optional oidcInteraction: Interaction
  Interaction if there is one.
Returns Promise<TemplatedInteractionResult<InteractionHandlerResult>>
InteractionHandlerResult appended with relevant template files.

supportsPath

supportsPath(path: string, prompt?: string): boolean

- Defined in src/identity/interaction/routing/InteractionRoute.ts:23
If this route supports the given path.

Parameters
- path: string
  Relative URL path.
- Optional prompt: string
  Session prompt if there is one.
Returns boolean