mirror of
https://github.com/status-im/go-fcm.git
synced 2025-02-24 01:38:08 +00:00
143 lines
2.0 KiB
Markdown
143 lines
2.0 KiB
Markdown
# go-fcm
|
|
|
|
[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=MYW4MY786JXFN&lc=GB&item_name=go%2dfcm%20development&item_number=go%2dfcm¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted)
|
|
[]()
|
|
|
|
Firebase Cloud Messaging ( FCM ) Library using golang ( Go )
|
|
|
|
This library uses HTTP/JSON Firebase Cloud Messaging connection server protocol
|
|
|
|
|
|
###### features
|
|
|
|
* Send messages to a topic
|
|
* Send messages to a device list
|
|
* Message can be a notification or data payload
|
|
* Supports condition attribute
|
|
|
|
|
|
###### in progress
|
|
* Retry
|
|
* Instance id features
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
```
|
|
go get github.com/NaySoftware/go-fcm
|
|
|
|
```
|
|
|
|
### Notes
|
|
|
|
|
|
serverKey is the server key by Firebase Cloud Messaging
|
|
|
|
Server Key can be found in:
|
|
|
|
1. Firebase project settings
|
|
2. Cloud Messaging
|
|
3. then copy the server key
|
|
|
|
|
|
|
|
|
|
# Examples
|
|
|
|
### Send to A topic
|
|
|
|
```golang
|
|
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"github.com/NaySoftware/go-fcm"
|
|
)
|
|
|
|
const (
|
|
serverKey = "YOUR-KEY"
|
|
topic = "/topics/someTopic"
|
|
)
|
|
|
|
func main() {
|
|
|
|
data := map[string]string{
|
|
"msg": "Hello World1",
|
|
"sum": "Happy Day",
|
|
}
|
|
|
|
c := fcm.NewFcmClient(serverKey)
|
|
c.NewFcmMsgTo(topic, data)
|
|
|
|
|
|
status, err := c.Send(1) // send once - no retry
|
|
// [retries n > 1]
|
|
|
|
if err == nil {
|
|
status.PrintResults()
|
|
} else {
|
|
fmt.Println(err)
|
|
}
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
### Send to a list of Devices (tokens)
|
|
|
|
```golang
|
|
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"github.com/NaySoftware/go-fcm"
|
|
)
|
|
|
|
const (
|
|
serverKey = "YOUR-KEY"
|
|
)
|
|
|
|
func main() {
|
|
|
|
data := map[string]string{
|
|
"msg": "Hello World1",
|
|
"sum": "Happy Day",
|
|
}
|
|
|
|
ids := []string{
|
|
"token1",
|
|
}
|
|
|
|
|
|
xds := []string{
|
|
"token5",
|
|
"token6",
|
|
"token7",
|
|
}
|
|
|
|
c := fcm.NewFcmClient(serverKey)
|
|
c.NewFcmRegIdsMsg(ids, data)
|
|
c.AppendDevices(xds)
|
|
|
|
status, err := c.Send(1) // send once - no retry
|
|
// [retries n > 1]
|
|
|
|
if err == nil {
|
|
status.PrintResults()
|
|
} else {
|
|
fmt.Println(err)
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
```
|