NotifyMessageDetails Class

Describes a message to be displayed to the user.

Methods

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

Properties

Name Type Description
briefMessage ConstructorProperty HTMLElement | string    
detailedMessage ConstructorProperty HTMLElement | string    
displayPoint undefined | Primitives.Point2d    
displayTime BeDuration    
inputField undefined | HTMLElement    
msgType ConstructorProperty OutputMessageType The type of message.  
openAlert ConstructorProperty OutputMessageAlert Whether an alert box should be displayed or not, and if so what kind.  
priority ConstructorProperty OutputMessagePriority The priority this message should be accorded by the NotificationManager.  
relativePosition RelativePosition    
viewport undefined | HTMLElement    

Defined in

Last Updated: 13 June, 2024