Struct NotificationClient 

pub struct NotificationClient<'a, T: Transport, A: AuthProvider> { /* private fields */ }

Client for interacting with Nextcloud’s Notifications API (v2).

Executes calls through any Transport and applies credentials via an AuthProvider. Both are held by reference, allowing the client to be freely cloned or borrowed across tasks without runtime dispatch or connection pooling overhead.

All endpoints interact with /ocs/v2.php/apps/notifications/api/v2/notifications.

See the Nextcloud Notifications API v2 documentation and Nextcloud Developer Manual OCS Overview.

Implementations

impl<'a, T: Transport, A: AuthProvider> NotificationClient<'a, T, A>

pub const fn new(transport: &'a T, auth: &'a A) -> Self

Binds a notification client to a transport and credential provider.

pub const fn transport(&self) -> &'a T

The transport this client sends requests through.

pub const fn auth(&self) -> &'a A

The credential provider applied to every call.

pub async fn list(&self) -> Result<Vec<Notification>, Error>

Lists all notifications for the authenticated user.

Sends GET /ocs/v2.php/apps/notifications/api/v2/notifications.

Returns an empty list when no notifications exist, or when the server responds with 204 No Content indicating polling should be reduced.

See Getting the notifications of a user.

pub async fn get(&self, notification_id: u64) -> Result<Notification, Error>

Retrieves a single notification by its notification_id.

Sends GET /ocs/v2.php/apps/notifications/api/v2/notifications/{id}.

See Get a single notification for a user.

pub async fn delete(&self, notification_id: u64) -> Result<(), Error>

Deletes/dismisses a single notification by its notification_id.

Sends DELETE /ocs/v2.php/apps/notifications/api/v2/notifications/{id}.

See Deleting a notification for a user.

pub async fn delete_all(&self) -> Result<(), Error>

Deletes/dismisses all notifications for the authenticated user.

Sends DELETE /ocs/v2.php/apps/notifications/api/v2/notifications.

See Deleting all notifications for a user.

Trait Implementations

impl<'a, T: Clone + Transport, A: Clone + AuthProvider> Clone for NotificationClient<'a, T, A>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, T: Copy + Transport, A: Copy + AuthProvider> Copy for NotificationClient<'a, T, A>

impl<'a, T: Debug + Transport, A: Debug + AuthProvider> Debug for NotificationClient<'a, T, A>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.