Class

# CalendarNotification

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

## Description

Notifications scheduled for a specific `DateTime</api/data_types/datetime>`.

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                                                      | Type                                        | Read-Only | Shared |
|-----------------------------------------------------------|---------------------------------------------|-----------|--------|
| `Badge<calendarnotification.badge>`                       | `Integer</api/data_types/integer>`          | ✓         |        |
| `Body<calendarnotification.body>`                         | `String</api/data_types/string>`            | ✓         |        |
| `DeliveryDate<calendarnotification.deliverydate>`         | `DateTime</api/data_types/datetime>`        | ✓         |        |
| `FirstTriggerDate<calendarnotification.firsttriggerdate>` | `DateTime</api/data_types/datetime>`        | ✓         |        |
| `Handle<calendarnotification.handle>`                     | `Ptr</api/data_types/additional_types/ptr>` | ✓         |        |
| `Identifier<calendarnotification.identifier>`             | `String</api/data_types/string>`            | ✓         |        |
| `NextTriggerDate<calendarnotification.nexttriggerdate>`   | `DateTime</api/data_types/datetime>`        | ✓         |        |
| `Repeats<calendarnotification.repeats>`                   | `Boolean</api/data_types/boolean>`          | ✓         |        |
| `Subtitle<calendarnotification.subtitle>`                 | `String</api/data_types/string>`            | ✓         |        |
| `Thread<calendarnotification.thread>`                     | `String</api/data_types/string>`            | ✓         |        |
| `Title<calendarnotification.title>`                       | `String</api/data_types/string>`            | ✓         |        |
| `UserInfo<calendarnotification.userinfo>`                 | `Dictionary</api/language/dictionary>`      | ✓         |        |

## Property descriptions

<div id="calendarnotification.badge">

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

</div>

<div class="rst-class">

forsearch

</div>

CalendarNotification.Badge

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

> The number that appears on the app icon when the notification is presented.
>
> This property is read-only.

<div id="calendarnotification.body">

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

</div>

<div class="rst-class">

forsearch

</div>

CalendarNotification.Body

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

> The details of the notification message.
>
> This information may not be shown if the device is locked and the user has hidden message details.
>
> This property is read-only.

<div id="calendarnotification.deliverydate">

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

</div>

<div class="rst-class">

forsearch

</div>

CalendarNotification.DeliveryDate

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

> When the notification was delivered.
>
> This property is read-only.

<div id="calendarnotification.firsttriggerdate">

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

</div>

<div class="rst-class">

forsearch

</div>

CalendarNotification.FirstTriggerDate

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

> The first time the notification was or will be presented to the user.
>
> This property is read-only.

<div id="calendarnotification.handle">

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

</div>

<div class="rst-class">

forsearch

</div>

CalendarNotification.Handle

**Handle** As `Ptr</api/data_types/additional_types/ptr>`

> A pointer to the notification for use with declares.
>
> This property is read-only.

<div id="calendarnotification.identifier">

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

</div>

<div class="rst-class">

forsearch

</div>

CalendarNotification.Identifier

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

> The UUID that uniquely identifies the notification.
>
> This property is read-only.
>
> The UUID is created when the Notification is created.

<div id="calendarnotification.nexttriggerdate">

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

</div>

<div class="rst-class">

forsearch

</div>

CalendarNotification.NextTriggerDate

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

> The next time the notification will be presented to the user.
>
> This property is read-only.

<div id="calendarnotification.repeats">

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

</div>

<div class="rst-class">

forsearch

</div>

CalendarNotification.Repeats

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

> If `True</api/language/true>`, the notification will repeat.
>
> This property is read-only.
>
> The shortest interval allowed is 60 seconds.

<div id="calendarnotification.subtitle">

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

</div>

<div class="rst-class">

forsearch

</div>

CalendarNotification.Subtitle

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

> A secondary line of text that appears below the title of the notification message.
>
> This information may not be shown if the device is locked and the user has hidden message details.
>
> This property is read-only.

<div id="calendarnotification.thread">

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

</div>

<div class="rst-class">

forsearch

</div>

CalendarNotification.Thread

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

> Identifies the thread to which the notification belongs.
>
> Threads are a set of characters you create which allow notifications to be grouped together in the iOS notifications user interface.
>
> This property is read-only.

<div id="calendarnotification.title">

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

</div>

<div class="rst-class">

forsearch

</div>

CalendarNotification.Title

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

> The title of the notification message.
>
> This property is read-only.

<div id="calendarnotification.userinfo">

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

</div>

<div class="rst-class">

forsearch

</div>

CalendarNotification.UserInfo

**UserInfo** As `Dictionary</api/language/dictionary>`

> Information sent along with the notification.
>
> The underlying data structure is `JSON</api/text/json/jsonitem>` format.
>
> This property is read-only.

## Notes

See the `MobileNotifications.NotificationReceived<mobilenotifications.notificationreceived>` event for information on how to use this class.

## Compatibility

|                       |        |
|-----------------------|--------|
| **Project Types**     | Mobile |
| **Operating Systems** | iOS    |

<div class="seealso">

`Notification</api/user_interface/notifications/notification>` parent class; `MobileNotifications</api/mobile/mobilenotifications>` class.

</div>