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
NotificationBuilderArgs
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', 'NotificationBuilderArgs', 'NotificationExt']

ImplNotificationExt module-attribute

ImplNotificationExt: TypeAlias = Union[App, AppHandle]

The implementors of NotificationExt.

NotificationBuilderArgs

Methods:

Name	Description
__new__	tauri_plugin_notification::NotificationBuilder

__new__

__new__(*, title: Optional[str] = None, body: Optional[str] = None) -> Self

tauri_plugin_notification::NotificationBuilder

Source code in python/pytauri-plugin-notification/src/pytauri_plugin_notification/ffi.py

def __new__(
    cls, /, *, title: Optional[str] = None, body: Optional[str] = None
) -> Self:
    """[tauri_plugin_notification::NotificationBuilder](https://docs.rs/tauri-plugin-notification/latest/tauri_plugin_notification/struct.NotificationBuilder.html)"""
    ...

NotificationBuilder

tauri_plugin_notification::NotificationBuilder

Methods:

Name	Description
show	Consume this builder and show the notification.

show

show(args: 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-plugin-notification/src/pytauri_plugin_notification/ffi.py

def show(self, args: 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-plugin-notification/src/pytauri_plugin_notification/ffi.py

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