jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-08 01:46:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change name of apns notify service (#1772)

Browse Source 
* Both apns notify services are now found under the notify domain.
* Update required configuration.
This commit is contained in:
Martin Hjelmare 2017-01-15 03:54:32 +01:00 committed by GitHub
parent c80d9b5e29
commit f72a7838e7
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
source/_components/notify.apns.markdown
View File

@ -22,17 +22,19 @@ notify:
name: NOTIFIER_NAME name: NOTIFIER_NAME
platform: apns platform: apns
cert_file: cert_file.pem cert_file: cert_file.pem
topic: topic
``` ```
Configuration variables: Configuration variables:
- **name** (*Required*): The name of the notifier. The notifier will bind to the service `notify.NOTIFIER_NAME`. - **name** (*Required*): The name of the notifier. The notifier will bind to the service `notify.NOTIFIER_NAME`.
- **sandbox** (*Optional*): If true notifications will be sent to the sandbox (test) notification service. Default false.
- **cert_file** (*Required*): The certificate to use to authenticate with the APNS service. - **cert_file** (*Required*): The certificate to use to authenticate with the APNS service.
- **topic** (*Required*): The app bundle ID specified in the certificate.
- **sandbox** (*Optional*): If true notifications will be sent to the sandbox (test) notification service. Default false.
The APNS platform will register two services, `notify.NOTIFIER_NAME` and `apns.NOTIFIER_NAME`. The APNS platform will register two services, `notify.NOTIFIER_NAME` and `notify.apns_NOTIFIER_NAME`.
### apns.NOTIFIER_NAME ### notify.apns_NOTIFIER_NAME
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`. 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`.
@ -47,7 +49,7 @@ This service will send messages to a registered device. The following parameters
- **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. - **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.
- **data**: - **data**:
* **badge**: The number to display as the badge of the app ic. * **badge**: The number to display as the badge of the app ic.
* **sound**: The name of a sound file in the app bundle or in the Library/Sounds folder. * **sound**: The name of a sound file in the app bundle or in the Library/Sounds folder.
* **category**: Provide this key with a string value that represents the identifier property of the UIMutableUserNotificationCategory. * **category**: Provide this key with a string value that represents the identifier property of the UIMutableUserNotificationCategory.
* **content_available**: Provide this key with a value of 1 to indicate that new content is available. * **content_available**: Provide this key with a value of 1 to indicate that new content is available.