notification

Documentation

Index

• func PostNotification(edgexcontext *appcontext.Context, content string) error
• func RegisterSubscriber(emails []string) error
• type Channels
• type Subscriber

Functions

func PostNotification

func PostNotification(edgexcontext *appcontext.Context, content string) error

This leverages EdgeX Alerts & notification service

func RegisterSubscriber

func RegisterSubscriber(emails []string) error

RegisterSubscriber registers a subscriber to EdgeX Alerts & notification service using email as channel

Types

type Channels

type Channels struct {
	Type          string   `json:"type"`
	URL           string   `json:"url,omitempty"`
	MailAddresses []string `json:"mailAddresses,omitempty"`
}

Channels holds the body schema to specify different type of notification channels (email, SMS, REST post call)

type Subscriber

type Subscriber struct {
	Slug                 string     `json:"slug"`
	Receiver             string     `json:"receiver"`
	SubscribedCategories []string   `json:"subscribedCategories"`
	SubscribedLabels     []string   `json:"subscribedLabels"`
	Channels             []Channels `json:"channels"`
}

Subscriber holds the body schema to register a subscriber to EdgeX