notifier

Documentation

Index

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

Functions

func SendPlaintextMessage

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

SendPlaintextMessage sends a plaintext message to specified providers.

Types

type Bot

type Bot interface {

	// SendMessageToAll 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).
	SendMessageToAll(context.Context, interactive.CoreMessage) error

	// SendMessage sends a generic message for a given source bindings.
	SendMessage(context.Context, interactive.CoreMessage, []string) 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
}

Bot sends event notifications and messages on the communication channels.

type Platform

type Platform interface {
	GetStatus() health.PlatformStatus
	IntegrationName() config.CommPlatformIntegration
}

Platform represents platform notifier

type Sink

type Sink interface {
	// SendEvent sends a generic event for a given source bindings.
	SendEvent(context.Context, any, []string) 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

	// GetStatus gets sink status
	GetStatus() health.PlatformStatus
}

Sink sends event notifications to the sinks.