API Reference > appui-react > Notification > AppNotificationManager

AppNotificationManager Class

The AppNotificationManager class is a subclass of NotificationManager in @itwin/core-frontend. This implementation uses the iTwin.js UI library to display alerts, messages, prompts and tooltips.

Extends

Methods

Name Description
constructor(): AppNotificationManager    
_showToolTip(el: HTMLElement, message: string | HTMLElement, pt?: Readonly<WritableXAndY>, options?: ToolTipOptions): void Protected Show a ToolTip window.  
clearToolTip(): void Clear the ToolTip if it is currently open.  
closeInputFieldMessage(): void Hide a InputField message.  
closePointerMessage(): void Hides the Pointer 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.  
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 prompt to the user.  
outputPromptByKey(key: string): void Output a prompt, given an i18n 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): void Update message position created with Pointer.  

Inherited methods

Name Inherited from Description
displayInputFieldMessage(inputField: HTMLElement, severity: MessageSeverity, briefMessage: string | HTMLElement, detailedMessage?: string | HTMLElement): void NotificationManager Displays an input field notification message.
displayMessage(severity: MessageSeverity, briefMessage: string | HTMLElement, detailedMessage?: string | HTMLElement, messageType?: DisplayMessageType): void NotificationManager Displays a notification message.
openToolTip(htmlElement: HTMLElement, message: string | HTMLElement, location?: Readonly<WritableXAndY>, options?: ToolTipOptions): void NotificationManager Show a tooltip window.

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.  

Inherited properties

Name Type Inherited from Description
toolTipLocation Readonly Point2d NotificationManager  

Defined in

Last Updated: 30 November, 2023