Skip to content

Latest commit

 

History

History
124 lines (85 loc) · 3.75 KB

ios.md

File metadata and controls

124 lines (85 loc) · 3.75 KB
Raw

iOS Notification Delivery Method

Send Apple Push Notifications with HTTP2 using the apnotic gem. The benefit of HTTP2 is that we can receive feedback for invalid device tokens without running a separate feedback service like RPush does.

bundle add "apnotic"

Apple Push Notification Service (APNS) Authentication

Token-based authentication is used for APNS.

  • A single key can be used for every app in your developer account.
  • Token authentication never expires, unlike certificate authentication which must be renewed annually.

Follow these docs for setting up Token-based authentication. https://github.com/ostinelli/apnotic#token-based-authentication https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/establishing_a_token-based_connection_to_apns

Usage

class CommentNotification
  deliver_by :ios
end

With custom configuration:

class CommentNotification
  deliver_by :ios, format: :ios_format, cert_path: :ios_cert_path, key_id: :ios_key_id, team_id: :ios_team_id, pool_size: 5

  # Customize notification
  # See https://github.com/ostinelli/apnotic#apnoticnotification
  def ios_format(apn)
    apn.alert = "Hello world"
    apn.custom_payload = { url: root_url }
  end

  def ios_cert_path
    Rails.root.join("config/certs/ios/apns.p8")
  end

  def ios_key_id
    Rails.application.credentials.dig(:ios, :key_id)
  end

  def ios_team_id
    Rails.application.credentials.dig(:ios, :team_id)
  end
end

Options

  • format: :ios_format - Optional

    Customize the Apnotic notification object

    See https://github.com/ostinelli/apnotic#apnoticnotification

  • bundle_identifier: Rails.application.credentials.dig(:ios, :bundle_identifier) - Optional

    The APN bundle identifier

  • cert_path: Rails.root.join("config/certs/ios/apns.p8") - Optional

    The location of your APNs p8 certificate. This can also accept a StringIO object StringIO.new("p8 file content as string"). As well as a File object File.open("path/to/p8.file").

  • key_id: Rails.application.credentials.dig(:ios, :key_id) - Optional

    Your APN Key ID

    If nothing passed, we'll default to Rails.application.credentials.dig(:ios, :key_id) If a String is passed, we'll use that as the key ID. If a Symbol is passed, we'll call the matching method and you can return the Key ID.

  • team_id: Rails.application.credentials.dig(:ios, :team_id) - Optional

    Your APN Team ID

    If nothing passed, we'll default to Rails.application.credentials.dig(:ios, :team_id) If a String is passed, we'll use that as the team ID. If a Symbol is passed, we'll call the matching method and you can return the team ID.

  • pool_size: 5 - Optional

    The connection pool size for Apnotic

  • development: false - Optional

    Set this to true to use the APNS sandbox environment for sending notifications. This is required when running the app to your device via Xcode. Running the app via TestFlight or the App Store should not use development.

Gathering Notification Tokens

A recipient can have multiple tokens (i.e. multiple iOS devices), so make sure to return them all.

Here, the recipient has_many :notification_tokens with columns platform and token.

def ios_device_tokens(recipient)
  recipient.notification_tokens.where(platform: "iOS").pluck(:token)
end

Handling Failures

Apple Push Notifications may fail delivery if the user has removed the app from their device. Noticed allows you

class CommentNotification
  deliver_by :ios

  # Remove invalid device tokens
  #
  # token - the device token from iOS or Android
  # platform - "iOS" or "Android"
  def cleanup_device_token(token:, platform:)
    NotificationToken.where(token: token, platform: platform).destroy_all
  end
end