NotifyMessageDetails Class

Describes a message to be displayed to the user.

Methods

Name Description
constructor(priority: OutputMessagePriority, briefMessage: string | HTMLElement, detailedMessage?: string | HTMLElement, msgType: OutputMessageType = OutputMessageType.Toast, openAlert: OutputMessageAlert = OutputMessageAlert.None): NotifyMessageDetails Constructor  
setInputFieldTypeDetails(inputField: HTMLElement): void Set OutputMessageType.InputField message details.  
setPointerTypeDetails(viewport: HTMLElement, displayPoint: Readonly<WritableXAndY>, relativePosition: RelativePosition = RelativePosition.TopRight): void Set OutputMessageType.Pointer message details.  

Properties

Name Type Description
briefMessage string | HTMLElement A short message that conveys the simplest explanation of the issue.  
detailedMessage string | HTMLElement An optional comprehensive message that explains the issue in detail and potentially offers a solution.  
displayPoint undefined | Point2d    
displayTime BeDuration    
inputField undefined | HTMLElement    
msgType OutputMessageType The type of message.  
openAlert OutputMessageAlert Whether an alert box should be displayed or not, and if so what kind.  
priority OutputMessagePriority The priority this message should be accorded by the NotificationManager.  
relativePosition RelativePosition    
viewport undefined | HTMLElement    

Defined in

Last Updated: 15 March, 2024