Struct NotificationEffects 

pub struct NotificationEffects<'a, 'b, S: AppState> { /* private fields */ }

Convenience builder for the standard notification host capabilities.

Implementations

impl<'a, 'b, S: AppState> NotificationEffects<'a, 'b, S>

pub fn request_permission( self, request: NotificationPermissionRequest, ) -> EffectBuilder<'a, 'b, S>

Requests notification permission from the active host.

request declares which notification features the app wants, such as alerts, badges, sounds, or provisional delivery. The returned EffectBuilder should normally bind success and error actions so the reducer can update state after the user responds to the platform prompt.

pub fn settings(self) -> EffectBuilder<'a, 'b, S>

Queries the host’s current notification settings without showing a prompt.

Use this before rendering notification-dependent controls or when a settings screen needs to explain why delivery is unavailable. The success action receives NotificationSettings.

pub fn show(self, request: NotificationRequest) -> EffectBuilder<'a, 'b, S>

Shows an immediate local notification through the host.

request supplies the stable notification id, visible title/body, badge, sound policy, optional deep link, and action buttons. Use schedule instead when delivery should happen at a future time.

pub fn schedule(self, request: NotificationRequest) -> EffectBuilder<'a, 'b, S>

Schedules a local notification for future delivery.

The schedule field on request controls the delivery time. Hosts may reject schedules they cannot persist, cannot deliver in the background, or cannot map to the platform notification model.

pub fn cancel( self, request: CancelNotificationRequest, ) -> EffectBuilder<'a, 'b, S>

Cancels one pending or displayed notification by id.

Use the same NotificationId that was used for show or schedule. A host may treat cancelling an unknown id as success if the desired final state is already true.

pub fn cancel_all(self) -> EffectBuilder<'a, 'b, S>

Cancels all notifications owned by this app where the host supports it.

Use this for sign-out, workspace switching, or clearing a notification center state that no longer matches app state. Hosts that cannot bulk cancel should return NotificationError.

pub fn set_badge_count( self, request: SetBadgeCountRequest, ) -> EffectBuilder<'a, 'b, S>

Sets or clears the app badge count.

request.count = Some(n) asks the host to show a badge count. request.count = None clears the badge. Badge support varies by desktop shell, launcher, browser, and mobile platform.

pub fn register_push( self, request: PushRegistrationRequest, ) -> EffectBuilder<'a, 'b, S>

Registers the app for remote or push notifications.

request carries provider-specific public registration inputs such as a web push application-server key, Android sender id, or requested topics. Secrets and store credentials belong in host configuration, not in app state.

pub fn unregister_push(self) -> EffectBuilder<'a, 'b, S>

Unregisters the app from remote or push notification delivery.

Use this during sign-out, account removal, or when a user disables remote notifications. The host should invalidate or delete its platform token where the provider supports that operation.