pytauri_plugins.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
NotificationBuilderArgs	tauri_plugin_notification::NotificationBuilder
NotificationBuilder	tauri_plugin_notification::NotificationBuilder
NotificationExt	tauri_plugin_notification::NotificationExt

Attributes:

Name	Type	Description
ImplNotificationExt	TypeAlias	The implementers of NotificationExt.

__all__ module-attribute

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

ImplNotificationExt module-attribute

ImplNotificationExt: TypeAlias = ImplManager

The implementers of NotificationExt.

NotificationBuilderArgs

Bases: TypedDict

tauri_plugin_notification::NotificationBuilder

Attributes:

Name	Type	Description
id	int
channel_id	str
title	str
body	str
large_body	str
summary	str
action_type_id	str
group	str
group_summary	bool
sound	str
inbox_line	str
icon	str
large_icon	str
icon_color	str
ongoing	bool
auto_cancel	bool
silent	bool

id instance-attribute

id: int

channel_id instance-attribute

channel_id: str

title instance-attribute

title: str

body instance-attribute

body: str

large_body instance-attribute

large_body: str

summary instance-attribute

summary: str

action_type_id instance-attribute

action_type_id: str

group instance-attribute

group: str

group_summary instance-attribute

group_summary: bool

sound instance-attribute

sound: str

inbox_line instance-attribute

inbox_line: str

icon instance-attribute

icon: str

large_icon instance-attribute

large_icon: str

icon_color instance-attribute

icon_color: str

ongoing instance-attribute

ongoing: bool

auto_cancel instance-attribute

auto_cancel: bool

silent instance-attribute

silent: bool

NotificationBuilder

tauri_plugin_notification::NotificationBuilder

Methods:

Name	Description
show	Consume this builder and show the notification.

show

show(**kwargs: Unpack[NotificationBuilderArgs]) -> 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/src/pytauri_plugins/notification/ffi.py

def show(self, /, **kwargs: Unpack[NotificationBuilderArgs]) -> 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/src/pytauri_plugins/notification/ffi.py

@staticmethod
def builder(slf: "ImplNotificationExt", /) -> NotificationBuilder:
    """Create a new notification builder."""
    ...