Struct deltachat::push::PushSubscriber

pub struct PushSubscriber {
    inner: Arc<RwLock<PushSubscriberState>>,
}

Manages subscription to Apple Push Notification services.

This structure is created by account manager and is shared between accounts. To enable notifications, application should request the device token as described in https://developer.apple.com/documentation/usernotifications/registering-your-app-with-apns and give it to the account manager, which will forward the token in this structure.

Each account (context) can then retrieve device token from this structure and give it to the email server. If email server does not support push notifications, account can call subscribe method to register device token with the heartbeat notification provider server as a fallback.

Fields

inner: Arc<RwLock<PushSubscriberState>>

Implementations

impl PushSubscriber

pub(crate) fn new() -> Self

Creates new push notification subscriber.

pub(crate) async fn set_device_token(&mut self, token: &str)

Sets device token for Apple Push Notification service.

pub(crate) async fn device_token(&self) -> Option<String>

Retrieves device token.

Token may be not available if application is not running on Apple platform, failed to register for remote notifications or is in the process of registering.

IMAP loop should periodically check if device token is available and send the token to the email server if it supports push notifications.

pub(crate) async fn subscribe(&self, _context: &Context) -> Result<()>

Placeholder to skip subscribing to heartbeat notifications outside iOS.

pub(crate) async fn heartbeat_subscribed(&self) -> bool

Trait Implementations

impl Clone for PushSubscriber

fn clone(&self) -> PushSubscriber

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PushSubscriber

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

Formats the value using the given formatter.

impl Default for PushSubscriber

fn default() -> PushSubscriber

Returns the “default value” for a type.