NotificationManager Class
The NotificationManager controls the interaction with the user for prompts, error messages, and alert dialogs. Implementations of the NotificationManager may present the information in different ways. For example, in non-interactive sessions, these messages may be saved to a log file or simply discarded.
extensions
Implements
Methods
| Name | Description | |
|---|---|---|
| constructor(): NotificationManager | ||
| _showToolTip(_htmlElement: HTMLElement, _message: string | HTMLElement, _location?: Readonly<WritableXAndY>, _options?: ToolTipOptions): void Protected | Implement to display a tooltip message at the specified location. | |
| clearToolTip(): void | Clear the tooltip if it is currently open. | |
| closeInputFieldMessage(): void | Close message created with OutputMessageType.InputField. | |
| closePointerMessage(): void | Close message created with OutputMessageType.Pointer. | |
| displayInputFieldMessage(inputField: HTMLElement, severity: MessageSeverity, briefMessage: string | HTMLElement, detailedMessage?: string | HTMLElement): void | Displays an input field notification message. | |
| displayMessage(severity: MessageSeverity, briefMessage: string | HTMLElement, detailedMessage?: string | HTMLElement, messageType?: DisplayMessageType): void | Displays a notification message. | |
| endActivityMessage(_reason: ActivityMessageEndReason): boolean | End an activity message. | |
| openMessageBox(_mbType: MessageBoxType, _message: string | HTMLElement, _icon: MessageBoxIconType): Promise<MessageBoxValue> | Output a MessageBox and wait for response from the user. | |
| openToolTip(htmlElement: HTMLElement, message: string | HTMLElement, location?: Readonly<WritableXAndY>, options?: ToolTipOptions): void | Show a tooltip window. | |
| outputActivityMessage(_messageText: string | HTMLElement, _percentComplete: number): boolean | Output an activity message to the user. | |
| outputMessage(_message: NotifyMessageDetails): void | Output a message and/or alert to the user. | |
| outputPrompt(_prompt: string): void | Output a localized prompt to the user. | |
| outputPromptByKey(key: string): void | Output a prompt, given a localization key. | |
| setToolAssistance(instructions: undefined | ToolAssistanceInstructions): void | Setup tool assistance instructions for a tool. | |
| setupActivityMessage(_details: ActivityMessageDetails): boolean | Set up for activity messages. | |
| updatePointerMessage(_displayPoint: Readonly<WritableXAndY>, _relativePosition: RelativePosition = RelativePosition.TopRight): void | Update message position created with OutputMessageType.Pointer. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| isToolTipOpen Accessor ReadOnly | boolean | Return true if the tooltip is currently open. | |
| isToolTipSupported Accessor ReadOnly | boolean | Return true if _showTooltip has an implementation and will display a tooltip. | |
| toolTipLocation Readonly | Point2d |
Defined in
Last Updated: 30 November, 2023