You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/notify.apns.markdown
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ ha_release: 0.31
14
14
15
15
The `apns` platform uses the Apple Push Notification service (APNS) to deliver notifications from Home Assistant.
16
16
17
-
To use the APNS service you will need an Apple developer account and you will need to create an App to receive push notifications. For more information see the apple developer documentation.
17
+
To use the APNS service you will need an Apple developer account and you will need to create an app to receive push notifications. For more information, see the Apple developer documentation.
18
18
19
19
```yaml
20
20
# Example configuration.yaml entry
@@ -36,20 +36,20 @@ The APNS platform will register two services, `notify.NOTIFIER_NAME` and `notify
36
36
37
37
### notify.apns_NOTIFIER_NAME
38
38
39
-
This service will register device id's with home assistant. In order to receive a notification a device must be registered. The app on the device can use this service to send an ID to Home Assistant during startup, the ID will be stored in `[NOTIFIER_NAME]_apns.yaml`.
39
+
This service will register device IDs with Home Assistant. In order to receive a notification a device must be registered. The app on the device can use this service to send an ID to Home Assistant during startup, the ID will be stored in `[NOTIFIER_NAME]_apns.yaml`.
40
40
41
-
See didRegisterForRemoteNotificationsWithDeviceToken in the [Apple developer documentation](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIApplicationDelegate_Protocol/#//apple_ref/occ/intfm/UIApplicationDelegate/application:didRegisterForRemoteNotificationsWithDeviceToken:) for more information about how to obtain a device id.
41
+
See `didRegisterForRemoteNotificationsWithDeviceToken` in the [Apple developer documentation](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIApplicationDelegate_Protocol/#//apple_ref/occ/intfm/UIApplicationDelegate/application:didRegisterForRemoteNotificationsWithDeviceToken:) for more information about how to obtain a device ID.
42
42
43
43
### notify.NOTIFIER_NAME
44
44
45
45
This service will send messages to a registered device. The following parameters can be used:
46
46
47
-
- **message**: The message to send
47
+
- **message**: The message to send.
48
48
49
49
- **target**: The desired state of the device, only devices that match the state will receive messages. To enable state tracking a registered device must have a `tracking_device_id` attribute added to the `[NOTIFIER_NAME]_apns.yaml` file. If this ID matches a device in `known_devices.yaml` the device state will be tracked.
50
50
51
51
- **data**:
52
-
* **badge**: The number to display as the badge of the app ic.
52
+
* **badge**: The number to display as the badge of the app icon.
53
53
* **sound**: The name of a sound file in the app bundle or in the Library/Sounds folder.
54
-
* **category**: Provide this key with a string value that represents the identifier property of the UIMutableUserNotificationCategory.
54
+
* **category**: Provide this key with a string value that represents the identifier property of the `UIMutableUserNotificationCategory`.
55
55
* **content_available**: Provide this key with a value of 1 to indicate that new content is available.
0 commit comments