apns

Utilities for Apple Push Notification and Feedback Services.

Installation

go get github.com/gsempe/apns/core

Documentation

• APNS package documentation
• Information on the APN JSON payloads
• Information on the APN binary protocols
• Information on APN troubleshooting

Usage

Creating push notification and payload

package main

import (
  "fmt"
  apns "github.com/gsempe/apns"
)

func main() {
  payload := apns.NewPayload()
  payload.Alert = "Hello, world!"
  payload.Badge = 42
  payload.Sound = "bingbong.aiff"

  pn := apns.NewPushNotification()
  pn.AddPayload(payload)

  alert, _ := pn.PayloadString()
  fmt.Println(alert)
}

Println output:

{
  "aps": {
    "alert": "Hello, world!",
    "badge": 42,
    "sound": "bingbong.aiff"
  }
}

Sending a notification

Running apnsclient and apnscli binaries

Note: apnsclient and apnscli use a local RabbitMQ server to communicate. Install it to get them work: RabbitMQ

Open a terminal, go to the apnsclient directory, get the binary dependencies and build it

$ cd $GOPATH/src/github.com/gsempe/apns/apnsclient
$ go get github.com/gsempe/apns/apnsclient
$ go build

Launch apnsclient with the command line arguments needed

$ ./apnsclient -help
Usage of ./apnsclient:
  -cert="apns-cert.pem": The certificate file
  -key="apns-key.pem": The key file
  -sandbox=false: Use this flag to communicate with the sandbox and not the production

If you get no errors apnsclient is waiting for push notifications to send.

Open another terminal, go to the apncli directory, get the binary dependencies and build it

$ cd $GOPATH/src/github.com/gsempe/apns/apnscli
$ go get github.com/gsempe/apns/apnscli
$ go build

Launch apnscli with the command line arguments needed

$ ./apnscli -help
Usage of ./apnscli:
  -text="Push notification text": The text of the push notification
  -token="6f3031f2828aa1a369c78d3216be4b7c40ca7a8728a6a8d3e6229afc437b4ef1": The token used to send the push notification

If all the parameters are correct, you should receive a push notification on the device corresponding to the token given via the apnscli command line argument, and you should get a message in the apnsclient console.

Sending push notification with ID 1

Use the library to code your own client

The apnsclient source code is a good starting point to code your own APNs client: apns/apnsclient/main.go

Advanced push notifications formats

Using an alert dictionary for complex payloads

package main

import (
  "fmt"
  apns "github.com/anachronistic/apns"
)

func main() {
  args := make([]string, 1)
  args[0] = "localized args"

  dict := apns.NewAlertDictionary()
  dict.Body = "Alice wants Bob to join in the fun!"
  dict.ActionLocKey = "Play a Game!"
  dict.LocKey = "localized key"
  dict.LocArgs = args
  dict.LaunchImage = "image.jpg"

  payload := apns.NewPayload()
  payload.Alert = dict
  payload.Badge = 42
  payload.Sound = "bingbong.aiff"

  pn := apns.NewPushNotification()
  pn.AddPayload(payload)

  alert, _ := pn.PayloadString()
  fmt.Println(alert)
}

Returns

{
  "aps": {
    "alert": {
      "body": "Alice wants Bob to join in the fun!",
      "action-loc-key": "Play a Game!",
      "loc-key": "localized key",
      "loc-args": [
        "localized args"
      ],
      "launch-image": "image.jpg"
    },
    "badge": 42,
    "sound": "bingbong.aiff"
  }
}

Setting custom properties

package main

import (
  "fmt"
  apns "github.com/anachronistic/apns"
)

func main() {
  payload := apns.NewPayload()
  payload.Alert = "Hello, world!"
  payload.Badge = 42
  payload.Sound = "bingbong.aiff"

  pn := apns.NewPushNotification()
  pn.AddPayload(payload)

  pn.Set("foo", "bar")
  pn.Set("doctor", "who?")
  pn.Set("the_ultimate_answer", 42)

  alert, _ := pn.PayloadString()
  fmt.Println(alert)
}

Returns

{
  "aps": {
    "alert": "Hello, world!",
    "badge": 42,
    "sound": "bingbong.aiff"
  },
  "doctor": "who?",
  "foo": "bar",
  "the_ultimate_answer": 42
}