post_notification#

omni.kit.notification_manager.post_notification(
text,
hide_after_timeout=True,
duration=3,
status=1,
button_infos=[],
)#

Post notification. If viewport is visible, it will be docked to the right-bottom of viewport. Otherwise, it will be docked to main window.

Parameters:

text (str) – The notification text.

Keyword Arguments:

  • hide_after_timeout (bool) – If the notification will hide after duration. If it’s False, and button_details are not provided, it will display a default dismiss button.

  • duration (int) – The duration (in seconds) after which the notification will be hidden. This duration only works if hide_after_timeout is True.

  • status (NotificationStatus) – The notification type. By default, NotificationStatus.INFO as information.

  • button_infos ([NotificationButtonInfo]) – Array of buttons.

Returns:

Notification handler.

Examples

>>> import omni.kit.notification_manager as nm
>>> ok_button = nm.NotificationButtonInfo("OK", on_complete=None)
>>> cancel_button = nm.NotificationButtonInfo("CANCEL", on_complete=None)
>>> notification = nm.post_notification(
            "Notification Example",
            hide_after_timeout=False,
            duration=0,
            status=nm.NotificationStatus.WARNING,
            button_infos=[ok_button, cancel_button]
        )
On this page