notifier

Documentation

Index

• func SendPlaintextMessage(ctx context.Context, notifiers []Notifier, msg string) error
• type Notifier

Functions

func SendPlaintextMessage

func SendPlaintextMessage(ctx context.Context, notifiers []Notifier, msg string) error

SendPlaintextMessage sends a plaintext message to specified providers.

Types

type Notifier

type Notifier interface {

	// SendEvent notifies about new incoming event from source.
	SendEvent(context.Context, events.Event, []string) error

	// SendMessage is used for notifying about BotKube start/stop listening, possible BotKube upgrades and other events.
	// Some integrations may decide to ignore such messages and have SendMessage method no-op.
	// TODO: Consider option per channel to turn on/off "announcements" (BotKube start/stop/upgrade, notify/config change).
	SendMessage(context.Context, interactive.Message) error

	// IntegrationName returns a name of a given communication platform.
	IntegrationName() config.CommPlatformIntegration

	// Type returns a given integration type. See config.IntegrationType for possible integration types.
	Type() config.IntegrationType
}

Notifier sends event notifications and messages on the communication channels.