1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
# apns
Utilities for Apple Push Notification and Feedback Services.
[](https://godoc.org/github.com/anachronistic/apns)
## Installation
`go get github.com/anachronistic/apns`
## Documentation
- [APNS package documentation](http://godoc.org/github.com/anachronistic/apns)
- [Information on the APN JSON payloads](http://developer.apple.com/library/mac/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/ApplePushService.html)
- [Information on the APN binary protocols](http://developer.apple.com/library/ios/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/CommunicatingWIthAPS.html)
- [Information on APN troubleshooting](http://developer.apple.com/library/ios/#technotes/tn2265/_index.html)
## Usage
### Creating pns and payloads manually
```go
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)
alert, _ := pn.PayloadString()
fmt.Println(alert)
}
```
#### Returns
```json
{
"aps": {
"alert": "Hello, world!",
"badge": 42,
"sound": "bingbong.aiff"
}
}
```
### Using an alert dictionary for complex payloads
```go
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
```json
{
"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
```go
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
```json
{
"aps": {
"alert": "Hello, world!",
"badge": 42,
"sound": "bingbong.aiff"
},
"doctor": "who?",
"foo": "bar",
"the_ultimate_answer": 42
}
```
### Sending a notification
```go
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.DeviceToken = "YOUR_DEVICE_TOKEN_HERE"
pn.AddPayload(payload)
client := apns.NewClient("gateway.sandbox.push.apple.com:2195", "YOUR_CERT_PEM", "YOUR_KEY_NOENC_PEM")
resp := client.Send(pn)
alert, _ := pn.PayloadString()
fmt.Println(" Alert:", alert)
fmt.Println("Success:", resp.Success)
fmt.Println(" Error:", resp.Error)
}
```
#### Returns
```shell
Alert: {"aps":{"alert":"Hello, world!","badge":42,"sound":"bingbong.aiff"}}
Success: true
Error: <nil>
```
### Checking the feedback service
```go
package main
import (
"fmt"
apns "github.com/anachronistic/apns"
"os"
)
func main() {
fmt.Println("- connecting to check for deactivated tokens (maximum read timeout =", apns.FeedbackTimeoutSeconds, "seconds)")
client := apns.NewClient("feedback.sandbox.push.apple.com:2196", "YOUR_CERT_PEM", "YOUR_KEY_NOENC_PEM")
go client.ListenForFeedback()
for {
select {
case resp := <-apns.FeedbackChannel:
fmt.Println("- recv'd:", resp.DeviceToken)
case <-apns.ShutdownChannel:
fmt.Println("- nothing returned from the feedback service")
os.Exit(1)
}
}
}
```
#### Returns
```shell
- connecting to check for deactivated tokens (maximum read timeout = 5 seconds)
- nothing returned from the feedback service
exit status 1
```
Your output will differ if the service returns device tokens.
```shell
- recv'd: DEVICE_TOKEN_HERE
...etc.
```
|
