Class

XojoCloud.RemoteNotifications.DeliveryOptions

Description

Used to provide information on how the message will be delivered, when it expires and more.

Methods

Name

Parameters

Returns

Shared

Constructor

bundleIdentifier As String, apnsKeyID As String, appleTeamID As String

Enumerations

XojoCloud.RemoteNotifications.DeliveryOptions.Types

Types

The various ways in which a notification can be displayed to the end user.

Enum

Description

Alert

Shows or plays an alert on the user's device.

Background

A notification without any user interface.

VoiceOverIP

Used by VOIP apps to indicate an incoming call.

Complication

Updates a complication on the user's Apple Watch.

FileProvider

Signals changes to a File Provider.

ManagedDeviceMessage

Tells managed devices to contact the MDM server.

Property descriptions

XojoCloud.RemoteNotifications.DeliveryOptions.APNsKeyID

APNsKeyID As String

The KeyID provided when you register for an Apple Push Notification certificate through the Apple Developer Portal.

This property is read-only.

XojoCloud.RemoteNotifications.DeliveryOptions.AppleTeamID

AppleTeamID As String

The ID provided when you register for an Apple Push Notification certificate through the Apple Developer Portal.

This property is read-only.

XojoCloud.RemoteNotifications.DeliveryOptions.BundleIdentifier

BundleIdentifier As String

The bundle identifier of the application that is to receive the message.

XojoCloud.RemoteNotifications.DeliveryOptions.ExpirationDate

ExpirationDate As DateTime

The date and time after which the notification is no longer valid and thus will not be delivered.

XojoCloud.RemoteNotifications.DeliveryOptions.GroupID

GroupID As String

An identifier you use to coalesce multiple notifications into a single notification for the user.

XojoCloud.RemoteNotifications.DeliveryOptions.Priority

Priority As Integer

A value between 0 and 10 that determines how important the message is. 10 delivers the message immediately while any number below 6 will deliver it based upon the device's available power.

A value above 10 or below 0 will result in an OutOfBoundsException.

XojoCloud.RemoteNotifications.DeliveryOptions.SandBox

SandBox As Boolean

Indicates whether or not you are testing.

SandBox is True by default. Set it to False when you deploy your app to the App Store.

XojoCloud.RemoteNotifications.DeliveryOptions.TeamID

TeamID As String

The developer's Team Identifier provided in the Apple Developer portal.

This property is read-only.

XojoCloud.RemoteNotifications.DeliveryOptions.Type

Type As DeliveryOptions.Type

The style of notification as it will be delivered to the user.

Method descriptions

XojoCloud.RemoteNotifications.DeliveryOptions.Constructor

Constructor(bundleIdentifier As String, apnsKeyID As String, appleTeamID As String)

Note

Constructors are special methods called when you create an object with the New keyword and pass in the parameters above.

Creates a new DeliveryOptions object using the bundle identifier of the app that should receive the message, the Key identifier associated with the Apple push notification certificate and the Apple Team identifier from the developer's Apple Developer portal.

Compatibility

All project types on all supported operating systems.