omni.kit.notification_manager: Notification Manager Extension¶

Changelog

Notification Manager¶

class omni.kit.notification_manager.NotificationButtonInfo(text, on_complete=None)¶

Bases: object

property handler¶

property text¶

class omni.kit.notification_manager.NotificationInfo(text, hide_after_timeout=True, duration=3, status=1, button_infos=[])¶

Bases: object

property button_infos¶

property duration¶

property hide_after_timeout¶

property status¶

property text¶

class omni.kit.notification_manager.NotificationManager¶

Bases: object

on_shutdown()¶

on_startup()¶

post_notification(notification_info: omni.kit.notification_manager.notification_info.NotificationInfo)¶

remove_notification(notification: omni.kit.notification_manager.manager.Notification)¶

class omni.kit.notification_manager.NotificationManagerExtension¶

Bases: omni.ext._extensions.IExt

on_shutdown()¶

on_startup()¶

post_notification(notification_info: omni.kit.notification_manager.notification_info.NotificationInfo)¶

class omni.kit.notification_manager.NotificationStatus¶

Bases: object

INFO = 1¶

WARNING = (0,)¶

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-button of viewport. Otherwise, it will be docked to main window.

Parameters

text (str) – The notification text.
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.
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])