Struct a2::request::notification::NotificationOptions

pub struct NotificationOptions<'a> {
    pub apns_id: Option<&'a str>,
    pub apns_push_type: Option<PushType>,
    pub apns_expiration: Option<u64>,
    pub apns_priority: Option<Priority>,
    pub apns_topic: Option<&'a str>,
    pub apns_collapse_id: Option<CollapseId<'a>>,
}

Headers to specify options to the notification.

Fields

apns_id: Option<&'a str>

A canonical UUID that identifies the notification. If there is an error sending the notification, APNs uses this value to identify the notification to your server.

apns_push_type: Option<PushType>

The apns-push-type header field has the following valid values.

Recent and upcoming features may not work if this header is missing. See the table above to determine if this header is required or optional.

apns_expiration: Option<u64>

A UNIX epoch date expressed in seconds (UTC). This header identifies the date when the notification is no longer valid and can be discarded.

If this value is nonzero, APNs stores the notification and tries to deliver it at least once, repeating the attempt as needed if it is unable to deliver the notification the first time. If the value is 0, APNs treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it.

apns_priority: Option<Priority>

The priority of the notification. If None, the APNs server sets the priority to High.

apns_topic: Option<&'a str>

The topic of the remote notification, which is typically the bundle ID for your app. The certificate you create in your developer account must include the capability for this topic.

If your certificate includes multiple topics, you must specify a value for this header.

If you omit this request header and your APNs certificate does not specify multiple topics, the APNs server uses the certificate’s Subject as the default topic.

If you are using a provider token instead of a certificate, you must specify a value for this request header. The topic you provide should be provisioned for the your team named in your developer account.

apns_collapse_id: Option<CollapseId<'a>>

Multiple notifications with the same collapse identifier are displayed to the user as a single notification. The value of this key must not exceed 64 bytes.

Trait Implementations

impl<'a> Clone for NotificationOptions<'a>

fn clone(&self) -> NotificationOptions<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for NotificationOptions<'a>

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

Formats the value using the given formatter.

impl<'a> Default for NotificationOptions<'a>

fn default() -> NotificationOptions<'a>

Returns the “default value” for a type.