Class IDialogMediatorHandler`Abstract`

Defines a system that can handle dialog requests and responses.

Hierarchy (View Summary)

IDialogMediatorHandler
- DialogMediatorHandler

Index

Constructors

Methods

getRegistration hasSubscriber show subscribe

Constructors

constructor

new IDialogMediatorHandler(): IDialogMediatorHandler
Returns IDialogMediatorHandler

Methods

`Abstract`getRegistration

getRegistration<TRequest extends object, TResponse>(
requestType: Constructor<TRequest>,
): DialogRegistration<TRequest, TResponse>
Get the registration for a given request type.
Type Parameters
- TRequest extends object
- TResponse
Parameters
- requestType: Constructor<TRequest>
  Type of request.
Returns DialogRegistration<TRequest, TResponse>
The registration for the request type.
- Defined in dialogs/IDialogMediatorHandler.ts:39

`Abstract`hasSubscriber

hasSubscriber<TRequest extends object>(
requestType: Constructor<TRequest>,
): boolean
Check if there is a subscriber for a given request type.
Type Parameters
- TRequest extends object
Parameters
- requestType: Constructor<TRequest>
  Type of request.
Returns boolean
True if there is a subscriber, false otherwise.
- Defined in dialogs/IDialogMediatorHandler.ts:26

`Abstract`show

show<TRequest extends object, TResponse>(
request: TRequest,
): Promise<DialogResponse<TResponse>>
Show a dialog based on a request.
Type Parameters
- TRequest extends object
- TResponse
Parameters
- request: TRequest
  An instance of the dialog request.
Returns Promise<DialogResponse<TResponse>>
- Defined in dialogs/IDialogMediatorHandler.ts:32

`Abstract`subscribe

subscribe<TRequest extends object, TResponse>(
    requestType: Constructor<TRequest>,
    requester: DialogRequest<TRequest, TResponse>,
    closeDialog: CloseDialog<TResponse>,
): void
Subscribes to a request type.
Type Parameters
- TRequest extends object
- TResponse
Parameters
- requestType: Constructor<TRequest>
  Type of request.
- requester: DialogRequest<TRequest, TResponse>
  The delegate that will be called when a request is made.
- closeDialog: CloseDialog<TResponse>
  The delegate that will be called when dialog is typically closed and response is resolved.
Returns void
- Defined in dialogs/IDialogMediatorHandler.ts:19