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    
detailedMessage string | HTMLElement    
displayPoint undefined | Point2d    
displayTime BeDuration    
inputField undefined | HTMLElement    
msgType OutputMessageType    
openAlert OutputMessageAlert    
priority OutputMessagePriority    
relativePosition RelativePosition    
viewport undefined | HTMLElement    

Defined in

Last Updated: 12 June, 2024