diff options
author | Corey Hulen <corey@hulen.com> | 2015-12-16 13:43:02 -0800 |
---|---|---|
committer | Corey Hulen <corey@hulen.com> | 2015-12-16 13:43:02 -0800 |
commit | 791129de2fa7db22ee2b23b97d4040c288110e97 (patch) | |
tree | 5976a456548fce8beb79014c7c2780afeea89a8a /Godeps/_workspace/src/github.com/anachronistic/apns/README.md | |
parent | f08deca79f24ff1efe086483a091cf807a5a2e14 (diff) | |
parent | f54936467101bb08bbdf7f3d9c341134c06b83c3 (diff) | |
download | chat-791129de2fa7db22ee2b23b97d4040c288110e97.tar.gz chat-791129de2fa7db22ee2b23b97d4040c288110e97.tar.bz2 chat-791129de2fa7db22ee2b23b97d4040c288110e97.zip |
Merge pull request #1742 from mattermost/update-golang-deps
Updating go dependancies
Diffstat (limited to 'Godeps/_workspace/src/github.com/anachronistic/apns/README.md')
-rw-r--r-- | Godeps/_workspace/src/github.com/anachronistic/apns/README.md | 223 |
1 files changed, 0 insertions, 223 deletions
diff --git a/Godeps/_workspace/src/github.com/anachronistic/apns/README.md b/Godeps/_workspace/src/github.com/anachronistic/apns/README.md deleted file mode 100644 index 02b012fd3..000000000 --- a/Godeps/_workspace/src/github.com/anachronistic/apns/README.md +++ /dev/null @@ -1,223 +0,0 @@ -# apns - -Utilities for Apple Push Notification and Feedback Services. - -[![GoDoc](https://godoc.org/github.com/anachronistic/apns?status.png)](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. -``` |