Skip to content

Latest commit

 

History

History
executable file
·
61 lines (42 loc) · 4.5 KB

PUSH_NOTIFICATIONS.md

File metadata and controls

executable file
·
61 lines (42 loc) · 4.5 KB
Raw

Push notifications

Push notifications are sent via Airship, whose SDK is integrated into the Play SRG app. The SDK is currently only integrated for iOS only.

Manually sending push notifications via Airship

  1. Pick a show and an associated media and write down their URNs.
  2. On a test device launch an internal build of the associated Play SRG application and register to push notifications for the show you picked.
  3. Login to the Airship administration interface.
  4. Pick the project corresponding to the Play SRG application you are using.
  5. Click the + button and choose Message. Then proceed through the required steps to create a realistic push notification:

    1. Audience: Either restrict to iOS or enable both platforms and select a user base (simply All Users if you don't mind bothering all users).

    2. Content: Select Push notification, click the Add content button and then:

      • Set a text (notification body / description).
      • Enable Title optional feature to provide a title (notification title).

    3. Delivery: Select Send Now and add the following Custom Keys that describe the content associated with the push notification:

      • media: The URN of the media you picked.
      • show: The URN of the show you picked and subscribed to.
      • type: Set to newod (new on-demand).
      • imageUrl: The URL of the image to be displayed in the notification (without scaling path components; use the URL as returned by the IL).

      Other fields can be optionally filled if desired:

      • channelId: The id of the radio channel which the show belongs to (if none simply omit this field).
      • startTime: The time at which to start playback, in seconds. Omit this field to start at the default position.

      Then in iOS Options section:

      • Enable Mutable Content to allow notification extension service to download image and store notifications locally.
      • Enable Badge with increment by +1 option.

    4. Review & Send: Click on Send Message and observe your test device. Using debug builds you can also set breakpoints and inspect the app or extension code as needed.

Remark

To check that your setup is working you can initially create very a basic push notification containing a simple body, omitting all other fields. This notification will be processed by the app but will not provide any action or image, and won't be stored locally to be display then in the application (if not opened from the notification itself).

Observe push status messages

An old technical note discusses push notification status message inspection. No profile is required anymore nowadays: You can observe status messages in the Console application by filtering results associated with the apns process.

Debugging the notification service

To debug the notification service:

  • Run the Play debug application for some business unit on a physical device and enable push notifications for some show.
  • In Xcode ensure the notification service extension scheme is visible for the Play app you picked.
  • Edit the extension scheme and ensure the iOS app is associated as Executable when running the scheme.
  • Run the notification service extension scheme on the device.
  • Set a breakpoint in the code.
  • On Airship create a push notification for the app and URN of the show you registered to and send it. Xcode should resume in the debugger where you can inspect the code.

Troubleshooting

To identify potential issues with Airship registration you can use the Support information button available in the application settings:

  • A device token is generated for each device and should always be available.
  • An Airship identifier associates a device token with a registration on Airship side, which should happen quickly after enabling push notifications. If no identifier is available but push notifications have been enabled please verify that the registration happened properly (Airship usually logs errors to the console). It might happen that using a VPN (e.g. the 1Blocker VPN) might prevent registration from occuring correctly, in which case you should temporarily disable it so that registration can succeed.
  • Also check that URN registrations are available.

If a device token and an Airship identifier are available you should be able to receive push notifications for the specified URN registrations.