Skip to content

Commit f72a783

Browse files
Change name of apns notify service (home-assistant#1772)
* Both apns notify services are now found under the notify domain. * Update required configuration.
1 parent c80d9b5 commit f72a783

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

source/_components/notify.apns.markdown

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,19 @@ notify:
2222
name: NOTIFIER_NAME
2323
platform: apns
2424
cert_file: cert_file.pem
25+
topic: topic
2526
```
2627
2728
Configuration variables:
2829
2930
- **name** (*Required*): The name of the notifier. The notifier will bind to the service `notify.NOTIFIER_NAME`.
30-
- **sandbox** (*Optional*): If true notifications will be sent to the sandbox (test) notification service. Default false.
3131
- **cert_file** (*Required*): The certificate to use to authenticate with the APNS service.
32+
- **topic** (*Required*): The app bundle ID specified in the certificate.
33+
- **sandbox** (*Optional*): If true notifications will be sent to the sandbox (test) notification service. Default false.
3234

33-
The APNS platform will register two services, `notify.NOTIFIER_NAME` and `apns.NOTIFIER_NAME`.
35+
The APNS platform will register two services, `notify.NOTIFIER_NAME` and `notify.apns_NOTIFIER_NAME`.
3436

35-
### apns.NOTIFIER_NAME
37+
### notify.apns_NOTIFIER_NAME
3638

3739
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`.
3840

@@ -47,7 +49,7 @@ This service will send messages to a registered device. The following parameters
4749
- **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.
4850

4951
- **data**:
50-
* **badge**: The number to display as the badge of the app ic.
51-
* **sound**: The name of a sound file in the app bundle or in the Library/Sounds folder.
52-
* **category**: Provide this key with a string value that represents the identifier property of the UIMutableUserNotificationCategory.
53-
* **content_available**: Provide this key with a value of 1 to indicate that new content is available.
52+
* **badge**: The number to display as the badge of the app ic.
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.
55+
* **content_available**: Provide this key with a value of 1 to indicate that new content is available.

0 commit comments

Comments
 (0)