Skip to content

pytauri_plugin_notification.ffi

Original FFI interface module.

Warning

All APIs under this module should not be considered stable. You should use the re-exported APIs under the top-level module.

Classes:

Name Description
NotificationBuilder

tauri_plugin_notification::NotificationBuilder
NotificationExt

tauri_plugin_notification::NotificationExt

Attributes:

Name Type Description
ImplNotificationExt TypeAlias

The implementors of NotificationExt.

__all__ module-attribute 

__all__ = ['ImplNotificationExt', 'NotificationBuilder', 'NotificationExt']

ImplNotificationExt module-attribute 

ImplNotificationExt: TypeAlias = ImplManager

The implementors of NotificationExt.

NotificationBuilder

tauri_plugin_notification::NotificationBuilder

Methods:

Name Description
show

Consume this builder and show the notification.

show 

show(*, id: Optional[int] = None, channel_id: Optional[str] = None, title: Optional[str] = None, body: Optional[str] = None, large_body: Optional[str] = None, summary: Optional[str] = None, action_type_id: Optional[str] = None, group: Optional[str] = None, group_summary: bool = False, sound: Optional[str] = None, inbox_line: Optional[str] = None, icon: Optional[str] = None, large_icon: Optional[str] = None, icon_color: Optional[str] = None, ongoing: bool = False, auto_cancel: bool = False, silent: bool = False) -> None

Consume this builder and show the notification.

FIXME, XXX, TODO:

See: https://github.com/tauri-apps/tauri/issues/3700

On windows, you must install the package via the .msi or nsis, or tauri-plugin-notification will not work.

Tracker issue: https://github.com/tauri-apps/plugins-workspace/issues/2156

Source code in python/pytauri-plugin-notification/src/pytauri_plugin_notification/ffi.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def show(
    self,
    /,
    *,
    id: Optional[int] = None,  # noqa: A002
    channel_id: Optional[str] = None,
    title: Optional[str] = None,
    body: Optional[str] = None,
    large_body: Optional[str] = None,
    summary: Optional[str] = None,
    action_type_id: Optional[str] = None,
    group: Optional[str] = None,
    group_summary: bool = False,
    sound: Optional[str] = None,
    inbox_line: Optional[str] = None,
    icon: Optional[str] = None,
    large_icon: Optional[str] = None,
    icon_color: Optional[str] = None,
    ongoing: bool = False,
    auto_cancel: bool = False,
    silent: bool = False,
) -> None:
    """Consume this builder and show the notification.

    # FIXME, XXX, TODO:

    See: <https://github.com/tauri-apps/tauri/issues/3700>

    On windows, you must install the package via the `.msi` or `nsis`, or `tauri-plugin-notification` will not work.

    Tracker issue: <https://github.com/tauri-apps/plugins-workspace/issues/2156>
    """
    ...

NotificationExt

tauri_plugin_notification::NotificationExt

Methods:

Name Description
builder

Create a new notification builder.

builder staticmethod 

builder(slf: ImplNotificationExt) -> NotificationBuilder

Create a new notification builder.

Source code in python/pytauri-plugin-notification/src/pytauri_plugin_notification/ffi.py 
79
80
81
82
@staticmethod
def builder(slf: "ImplNotificationExt", /) -> NotificationBuilder:
    """Create a new notification builder."""
    ...