ReactNotifyMessageDetails Class

Describes a message to be displayed to the user and adds support for React components in messages.

Methods

Name Description
constructor(priority: OutputMessagePriority, briefMessage: MessageType, detailedMessage?: MessageType, msgType: OutputMessageType = OutputMessageType.Toast, openAlert: OutputMessageAlert = OutputMessageAlert.None): ReactNotifyMessageDetails 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 MessageType    
detailedMessage undefined | MessageType    
displayPoint Accessor ReadOnly undefined | Point2d Point for a Pointer message  
displayTime Accessor BeDuration Amount of time a Toast message is displayed  
inputField Accessor ReadOnly undefined | HTMLElement Anchor input field for an Input Field message  
msgType OutputMessageType    
openAlert OutputMessageAlert    
priority OutputMessagePriority    
relativePosition Accessor ReadOnly RelativePosition Relative position for a Pointer message  
viewport Accessor ReadOnly undefined | HTMLElement Anchor viewport for a Pointer message  

Defined in

Last Updated: 30 November, 2023