notifications

Documentation

Index

• Constants
• func AddNotification(channel, destination string) error
• func GetNotificationDestinationsForChannel(channel string) ([]string, error)
• func RemoveNotificationForChannel(channel, destination string) error
• func Setup(datastore *data.Datastore)
• type Notifier
  • func New(datastore *data.Datastore) (*Notifier, error)
  • func (n *Notifier) Notify()

Constants

const (
	// BrowserPushNotification represents a push notification for a browser.
	BrowserPushNotification = "BROWSER_PUSH_NOTIFICATION"
)

Functions

func AddNotification

func AddNotification(channel, destination string) error

AddNotification saves a new user notification destination.

func GetNotificationDestinationsForChannel

func GetNotificationDestinationsForChannel(channel string) ([]string, error)

GetNotificationDestinationsForChannel will return a collection of destinations to notify for a given channel.

func RemoveNotificationForChannel

func RemoveNotificationForChannel(channel, destination string) error

RemoveNotificationForChannel removes a notification destination.

func Setup

func Setup(datastore *data.Datastore)

Setup will perform any pre-use setup for the notifier.

Types

type Notifier

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

Notifier is an instance of the live stream notifier.

func New

func New(datastore *data.Datastore) (*Notifier, error)

New creates a new instance of the Notifier.

func (*Notifier) Notify

func (n *Notifier) Notify()

Notify will fire the different notification channels.