fcm

README

Firebase Cloud Messaging (FCM)

Prerequisites

Navigate to Firebase console, login with your Google account and create a new project. You will find the Server Key in the project settings screen under Cloud Messaging tab. When the server is up and running you can add Firebase to your applications following the instructions in the Engage/Cloud Messaging section.

To test the integration with a device you can use FCM toolbox. You can also download the app to your mobile, create a device token and test the reachability of your device.

Usage

package main

import (
	"context"
	"log"

	"github.com/nikoksr/notify"
	"github.com/nikoksr/notify/service/fcm"
)

func main() {
	fcmSvc, err := fcm.New("server_api_key")
	if err != nil {
		log.Fatalf("fcm.New() failed: %s", err.Error())
	}

	fcmSvc.AddReceivers("deviceToken1")

	notifier := notify.New()
	notifier.UseServices(fcmSvc)

	// Use context.Background() if you want to send a simple notification message.
	ctx := context.Background()

	// Optionally, you can include additional data in the message payload by adding the corresponding value to the context.
	ctxWithData := context.WithValue(ctx, fcm.DataKey, map[string]interface{}{
		"some-key":  "some-value",
		"other-key": "other-value",
	})

	// Optionally, you can specify a total of retry attempts per each message by adding the corresponding value to the context.
	ctxWithDataAndRetries := context.WithValue(ctxWithData, fcm.RetriesKey, 3)

	err = notifier.Send(ctxWithDataAndRetries, "subject", "message")
	if err != nil {
		log.Fatalf("notifier.Send() failed: %s", err.Error())
	}

	log.Println("notification sent")
}

Documentation

Overview

Package fcm provides message notification integration for Firebase Cloud Messaging (FCM).

Usage:

package main

import (
	"context"
	"log"

	"github.com/nikoksr/notify"
	"github.com/nikoksr/notify/service/fcm"
)

func main() {
	fcmSvc, err := fcm.New("server_api_key")
	if err != nil {
		log.Fatalf("fcm.New() failed: %s", err.Error())
	}

	fcmSvc.AddReceivers("deviceToken1")

	notifier := notify.New()
	notifier.UseServices(fcmSvc)

	// Use context.Background() if you want to send a simple notification message.
	ctx := context.Background()

	// Optionally, you can include additional data in the message payload by adding the corresponding value to the
	// context.
	ctxWithData := context.WithValue(ctx, fcm.DataKey, map[string]interface{}{
		"some-key":  "some-value",
		"other-key": "other-value",
	})

	// Optionally, you can specify a total of retry attempts per each message by adding the corresponding value to
	// the context.
	ctxWithDataAndRetries := context.WithValue(ctxWithData, fcm.RetriesKey, 3)

	err = notifier.Send(ctxWithDataAndRetries, "subject", "message")
	if err != nil {
		log.Fatalf("notifier.Send() failed: %s", err.Error())
	}

	log.Println("notification sent")
}

Index

• type Option
  • func WithCredentialsFile(filename string) Option
  • func WithHTTPClient(httpClient *http.Client) Option
  • func WithProjectID(projectID string) Option
• type Service
  • func New(ctx context.Context, opts ...Option) (*Service, error)
  • func (s *Service) AddReceivers(deviceTokens ...string)
  • func (s *Service) Send(ctx context.Context, subject, message string) error

Types

type Option

type Option func(*Service) error

Option is a function that configures a Service.

func WithCredentialsFile

func WithCredentialsFile(filename string) Option

WithCredentialsFile returns an Option to configure the FCM client with a credentials file.

func WithHTTPClient

func WithHTTPClient(httpClient *http.Client) Option

WithHTTPClient returns an Option to configure the FCM client with a custom HTTP client.

func WithProjectID

func WithProjectID(projectID string) Option

WithProjectID returns an Option to configure the FCM client with a project ID.

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service encapsulates the FCM client along with internal state for storing device tokens.

func New

func New(ctx context.Context, opts ...Option) (*Service, error)

New returns a new instance of a FCM notification service.

func (*Service) AddReceivers

func (s *Service) AddReceivers(deviceTokens ...string)

AddReceivers takes FCM device tokens and appends them to the internal device tokens slice.

func (*Service) Send

func (s *Service) Send(ctx context.Context, subject, message string) error

Send takes a message subject and a message body and sends them to all previously set devices.