Class

# XojoCloud.RemoteNotifications.DeliveryOptions

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

## Description

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

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                                                                               | Type                                                                         | Read-Only | Shared |
|------------------------------------------------------------------------------------|------------------------------------------------------------------------------|-----------|--------|
| `APNsKeyID<xojocloud.remotenotifications.deliveryoptions.apnskeyid>`               | `String</api/data_types/string>`                                             | ✓         |        |
| `AppleTeamID<xojocloud.remotenotifications.deliveryoptions.appleteamid>`           | `String</api/data_types/string>`                                             | ✓         |        |
| `BundleIdentifier<xojocloud.remotenotifications.deliveryoptions.bundleidentifier>` | `String</api/data_types/string>`                                             |           |        |
| `ExpirationDate<xojocloud.remotenotifications.deliveryoptions.expirationdate>`     | `DateTime</api/data_types/datetime>`                                         |           |        |
| `GroupID<xojocloud.remotenotifications.deliveryoptions.groupid>`                   | `String</api/data_types/string>`                                             |           |        |
| `Priority<xojocloud.remotenotifications.deliveryoptions.priority>`                 | `Integer</api/data_types/integer>`                                           |           |        |
| `SandBox<xojocloud.remotenotifications.deliveryoptions.sandbox>`                   | `Boolean</api/data_types/boolean>`                                           |           |        |
| `TeamID<xojocloud.remotenotifications.deliveryoptions.teamid>`                     | `String</api/data_types/string>`                                             | ✓         |        |
| `Type<xojocloud.remotenotifications.deliveryoptions.type>`                         | `DeliveryOptions.Types<xojocloud.remotenotifications.deliveryoptions.types>` |           |        |

## Methods

<div class="rst-class">

table-centered_column_4

</div>

| Name                                                                      | Parameters                                                                                                                                           | Returns | Shared |
|---------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|---------|--------|
| `Constructor<xojocloud.remotenotifications.deliveryoptions.constructor0>` | bundleIdentifier As `String</api/data_types/string>`, apnsKeyID As `String</api/data_types/string>`, appleTeamID As `String</api/data_types/string>` |         |        |

## Enumerations

<div id="xojocloud.remotenotifications.deliveryoptions.types">

<div class="rst-class">

forsearch

</div>

</div>

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

<div id="xojocloud.remotenotifications.deliveryoptions.apnskeyid">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.DeliveryOptions.APNsKeyID

**APNsKeyID** As `String</api/data_types/string>`

> The KeyID provided when you register for an Apple Push Notification certificate through the Apple Developer Portal.
>
> This property is read-only.

<div id="xojocloud.remotenotifications.deliveryoptions.appleteamid">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.DeliveryOptions.AppleTeamID

**AppleTeamID** As `String</api/data_types/string>`

> The ID provided when you register for an Apple Push Notification certificate through the Apple Developer Portal.
>
> This property is read-only.

<div id="xojocloud.remotenotifications.deliveryoptions.bundleidentifier">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.DeliveryOptions.BundleIdentifier

**BundleIdentifier** As `String</api/data_types/string>`

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

<div id="xojocloud.remotenotifications.deliveryoptions.expirationdate">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.DeliveryOptions.ExpirationDate

**ExpirationDate** As `DateTime</api/data_types/datetime>`

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

<div id="xojocloud.remotenotifications.deliveryoptions.groupid">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.DeliveryOptions.GroupID

**GroupID** As `String</api/data_types/string>`

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

<div id="xojocloud.remotenotifications.deliveryoptions.priority">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.DeliveryOptions.Priority

**Priority** As `Integer</api/data_types/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</api/exceptions/outofboundsexception>`.

<div id="xojocloud.remotenotifications.deliveryoptions.sandbox">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.DeliveryOptions.SandBox

**SandBox** As `Boolean</api/data_types/boolean>`

> Indicates whether or not you are testing.
>
> SandBox is `True</api/language/true>` by default. Set it to `False</api/language/false>` when you deploy your app to the App Store.

<div id="xojocloud.remotenotifications.deliveryoptions.teamid">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.DeliveryOptions.TeamID

**TeamID** As `String</api/data_types/string>`

> The developer's Team Identifier provided in the Apple Developer portal.
>
> This property is read-only.

<div id="xojocloud.remotenotifications.deliveryoptions.type">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.DeliveryOptions.Type

**Type** As `DeliveryOptions.Types<xojocloud.remotenotifications.deliveryoptions.types>`

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

## Method descriptions

<div id="xojocloud.remotenotifications.deliveryoptions.constructor0">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.DeliveryOptions.Constructor

**Constructor**(bundleIdentifier As `String</api/data_types/string>`, apnsKeyID As `String</api/data_types/string>`, appleTeamID As `String</api/data_types/string>`)

> <div class="note">
>
> <div class="title">
>
> Note
>
> </div>
>
> `Constructors</api/language/constructor>` are special methods called when you create an object with the `New</api/language/new>` keyword and pass in the parameters above.
>
> </div>
>
> 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

|                       |     |
|-----------------------|-----|
| **Project Types**     | Web |
| **Operating Systems** | All |

<div class="seealso">

`Object</api/data_types/additional_types/object>` parent class; `XojoCloud.RemoteNotifications</api/xojocloud/xojocloud.remotenotifications>` and `XojoCloud.RemoteNotifications.Message</api/xojocloud/xojocloud.remotenotifications.message>` classes.

</div>