Class

# XojoCloud.RemoteNotifications.Message

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

## Description

A message to be sent to one or more devices.

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                                                                       | Type                                                                     | Read-Only | Shared |
|----------------------------------------------------------------------------|--------------------------------------------------------------------------|-----------|--------|
| `AlertBody<xojocloud.remotenotifications.message.alertbody>`               | `String</api/data_types/string>`                                         |           |        |
| `AlertSubTitle<xojocloud.remotenotifications.message.alertsubtitle>`       | `String</api/data_types/string>`                                         |           |        |
| `AlertTitle<xojocloud.remotenotifications.message.alerttitle>`             | `String</api/data_types/string>`                                         |           |        |
| `Badge<xojocloud.remotenotifications.message.badge>`                       | `Integer</api/data_types/integer>`                                       |           |        |
| `Category<xojocloud.remotenotifications.message.category>`                 | `String</api/data_types/string>`                                         |           |        |
| `ContentAvailable<xojocloud.remotenotifications.message.contentavailable>` | `Boolean</api/data_types/boolean>`                                       |           |        |
| `FocusPriority<xojocloud.remotenotifications.message.focuspriority>`       | `FocusPriorities<xojocloud.remotenotifications.message.focuspriorities>` |           |        |
| `LaunchImageName<xojocloud.remotenotifications.message.launchimagename>`   | `String</api/data_types/string>`                                         |           |        |
| `MutableContent<xojocloud.remotenotifications.message.mutablecontent>`     | `Boolean</api/data_types/boolean>`                                       |           |        |
| `Relevance<xojocloud.remotenotifications.message.relevance>`               | `Double</api/data_types/double>`                                         |           |        |
| `SoundCritical<xojocloud.remotenotifications.message.soundcritical>`       | `Boolean</api/data_types/boolean>`                                       |           |        |
| `SoundName<xojocloud.remotenotifications.message.soundname>`               | `String</api/data_types/string>`                                         |           |        |
| `SoundVolume<xojocloud.remotenotifications.message.soundvolume>`           | `Double</api/data_types/double>`                                         |           |        |
| `TargetContentID<xojocloud.remotenotifications.message.targetcontentid>`   | `String</api/data_types/string>`                                         |           |        |
| `ThreadID<xojocloud.remotenotifications.message.threadid>`                 | `String</api/data_types/string>`                                         |           |        |
| `UserData<xojocloud.remotenotifications.message.userdata>`                 | `JSONItem</api/text/json/jsonitem>`                                      |           |        |

## Enumerations

<div id="xojocloud.remotenotifications.message.focuspriorities">

<div class="rst-class">

forsearch

</div>

</div>

XojoCloud.RemoteNotifications.Message.FocusPriorities

### FocusPriorities

> The various priorities that dictate how the content should be handled should the user have a focus enabled.
>
> | Enum          | Description                                                                                                                                                                                                                                                                                                                          |
> |---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
> | Passive       | Does not show an alert, light up the screen or break through Focus settings. These notifications are delivered silently and are available the next time the notification list is viewed. Examples are Dining Recommendations and New Episode availability.                                                                           |
> | Active        | This is the default and matches the behavior of iOS 14 and below. This priority can show up on screen, play sounds and will light up the screen. They will not break through Focus settings. Active should be used for notifications that do not warrant interrupting if the user does not want to be interrupted.                   |
> | TimeSensitive | This priority is just like Active except that it can break through system controls such as notification summary and Focus if it has been allowed by the user. This priority should only be used when the notification requires immediate attention. For example, medication reminders, account security and package delivery alerts. |
> | Critical      | This priority is equivalent to the Critical notification support that exists is iOS 14. It can actively alert, break through system Focus settings and also bypass the ringer switch on the device. This priority requires a special entitlement from Apple. Examples would be weather alerts and local safety alerts.               |

## Property descriptions

<div id="xojocloud.remotenotifications.message.alertbody">

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

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.Message.AlertBody

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

> The title of the alert which is displayed in bold.

<div id="xojocloud.remotenotifications.message.alertsubtitle">

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

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.Message.AlertSubTitle

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

> The subtitle of the alert, displayed below the Title using a smaller font size.

<div id="xojocloud.remotenotifications.message.alerttitle">

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

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.Message.AlertTitle

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

> The descriptive text of the alert, displayed below the title and subtitle.

<div id="xojocloud.remotenotifications.message.badge">

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

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.Message.Badge

**Badge** As `Integer</api/data_types/integer>`

> A number that, if greater than 0, appears in a red circle on the target app's icon on the home screen to indicate unread notifications.

<div id="xojocloud.remotenotifications.message.category">

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

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.Message.Category

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

> Corresponds to the identifier specified in the target app with MobileNotifications.AddResponseCategory.
>
> If you're adding response categories in your iOS app, you assign them a category identifier. The Message.Category property should have the same identifier.

<div id="xojocloud.remotenotifications.message.contentavailable">

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

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.Message.ContentAvailable

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

> The background notification flag.

<div id="xojocloud.remotenotifications.message.focuspriority">

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

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.Message.FocusPriority

**FocusPriority** As `FocusPriorities<xojocloud.remotenotifications.message.focuspriorities>`

> Dictates how the content should be handled should the user have a focus enabled.
>
> See the `FocusPriorities<xojocloud.remotenotifications.message.focuspriorities>` enumeration for details on the various priorities available.

<div id="xojocloud.remotenotifications.message.launchimagename">

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

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.Message.LaunchImageName

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

> Name of an image (to be display with the notification) in the app receiving the notification.
>
> The image can be in the Xojo project or in the bundle if you are using a CopyFilesStep to put images into the built app.

<div id="xojocloud.remotenotifications.message.mutablecontent">

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

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.Message.MutableContent

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

> Indicates whether the data in the notification can be modified before it is presented to the user.

<div id="xojocloud.remotenotifications.message.relevance">

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

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.Message.Relevance

**Relevance** As `Double</api/data_types/double>`

> The level of relevance relative to other notifications created by the same app.
>
> On iOS 15 and later, when the user opens the Notification Center, of the unread notifications from an app (if any), the one with the highest relevance will be included in the summary.

<div id="xojocloud.remotenotifications.message.soundcritical">

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

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.Message.SoundCritical

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

> Indicates that the sound should play even if the user has the sound disabled on their phone.
>
> This is meant for emergency services and requires a special entitlement from Apple.

<div id="xojocloud.remotenotifications.message.soundname">

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

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.Message.SoundName

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

> The name of a sound file in the main bundle or in the Library/Sounds folder of the container directory of the app receiving the message.
>
> The sound called "Default" will play the system sound.

<div id="xojocloud.remotenotifications.message.soundvolume">

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

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.Message.SoundVolume

**SoundVolume** As `Double</api/data_types/double>`

> The volume of a sound file in the main bundle or in the Library/Sounds folder of the container directory of the app receiving the message.

<div id="xojocloud.remotenotifications.message.targetcontentid">

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

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.Message.TargetContentID

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

> The identifier of the window brought forward.
>
> This ID can be used with a `Declare</api/language/declare>` to get at the information connected to it. You can find out more in [Apple's Developer Documentation.](https://developer.apple.com/documentation/usernotifications/unnotificationcontent/3235764-targetcontentidentifier?language=objc)

<div id="xojocloud.remotenotifications.message.threadid">

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

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.Message.ThreadID

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

> An app-specific identifier for grouping related notifications.

<div id="xojocloud.remotenotifications.message.userdata">

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

</div>

<div class="rst-class">

forsearch

</div>

XojoCloud.RemoteNotifications.Message.UserData

**UserData** As `JSONItem</api/text/json/jsonitem>`

> Additional data to be delivered to the app.

## Notes

See `XojoCloud.RemoteNotifications</api/xojocloud/xojocloud.remotenotifications>` class for sample code.

## 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.DeliveryOptions</api/xojocloud/xojocloud.remotenotifications.deliveryoptions>` classes.

</div>