fcm

Documentation

Overview

Package fcm implements push notification plugin for Google FCM backend. Push notifications for Android, iOS and web clients are sent through Google's Firebase Cloud Messaging service. Package fcm is push notification plugin using Google FCM. https://firebase.google.com/docs/cloud-messaging

Index

• func PrepareNotifications(rcpt *push.Receipt, config *AndroidConfig) []messageData
• type AndroidConfig
• type Handler
  • func (Handler) Init(jsonconf string) error
  • func (Handler) IsReady() bool
  • func (Handler) Push() chan<- *push.Receipt
  • func (Handler) Stop()

Functions

func PrepareNotifications

func PrepareNotifications(rcpt *push.Receipt, config *AndroidConfig) []messageData

PrepareNotifications creates notification payloads ready to be posted to push notification server for the provided receipt.

Types

type AndroidConfig

type AndroidConfig struct {
	Enabled bool `json:"enabled,omitempty"`

	// Configs for specific push types.
	Msg androidPayload `json:"msg,omitempty"`
	Sub androidPayload `json:"msg,omitempty"`
	// contains filtered or unexported fields
}

Configuration of AndroidNotification payload.

type Handler

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

Handler represents the push handler; implements push.PushHandler interface.

func (Handler) Init

func (Handler) Init(jsonconf string) error

Init initializes the push handler

func (Handler) IsReady

func (Handler) IsReady() bool

IsReady checks if the push handler has been initialized.

func (Handler) Push

func (Handler) Push() chan<- *push.Receipt

Push returns a channel that the server will use to send messages to. If the adapter blocks, the message will be dropped.

func (Handler) Stop

func (Handler) Stop()

Stop shuts down the handler