discord

package

v1.1.1 Latest Latest Go to latest Published: May 18, 2023 License: Apache-2.0 Imports: 22 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/xmidt-org/ears

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func NewPlugin() (*pkgplugin.Plugin, error)
func NewPluginVersion(name string, version string, commitID string) (*pkgplugin.Plugin, error)
func NewReceiver(tid tenant.Id, plugin string, name string, config interface{}, ...) (receiver.Receiver, error)
func NewSender(tid tenant.Id, plugin string, name string, config interface{}, ...) (sender.Sender, error)
type Receiver
type ReceiverConfig
- func (rc *ReceiverConfig) Validate() error
- func (rc *ReceiverConfig) WithDefaults() ReceiverConfig
type Sender
type SenderConfig
- func (sc *SenderConfig) Validate() error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	Name     = "discord"
	Version  = "v0.0.0"
	CommitID = ""
)

View Source

var DefaultReceiverConfig = ReceiverConfig{
	BotToken: "",
}

Functions ¶

func NewPlugin ¶

func NewPlugin() (*pkgplugin.Plugin, error)

func NewPluginVersion ¶

func NewPluginVersion(name string, version string, commitID string) (*pkgplugin.Plugin, error)

func NewReceiver ¶

func NewReceiver(tid tenant.Id, plugin string, name string, config interface{}, secrets secret.Vault) (receiver.Receiver, error)

func NewSender ¶

func NewSender(tid tenant.Id, plugin string, name string, config interface{}, secrets secret.Vault) (sender.Sender, error)

Types ¶

type Receiver ¶

type Receiver struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*Receiver) Config ¶

func (r *Receiver) Config() interface{}

func (*Receiver) Name ¶

func (r *Receiver) Name() string

func (*Receiver) Plugin ¶

func (r *Receiver) Plugin() string

func (*Receiver) Receive ¶

func (r *Receiver) Receive(next receiver.NextFn) error

func (*Receiver) StopReceiving ¶

func (r *Receiver) StopReceiving(ctx context.Context) error

func (*Receiver) Tenant ¶

func (r *Receiver) Tenant() tenant.Id

func (*Receiver) Trigger ¶

func (r *Receiver) Trigger(e event.Event)

type ReceiverConfig ¶

type ReceiverConfig struct {
	BotToken string `json:"botToken"`
}

func (*ReceiverConfig) Validate ¶

func (rc *ReceiverConfig) Validate() error

Validate returns an error upon validation failure

func (*ReceiverConfig) WithDefaults ¶

func (rc *ReceiverConfig) WithDefaults() ReceiverConfig

WithDefaults returns a new config object that has all of the unset (nil) values filled in.

type Sender ¶

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

func (*Sender) Config ¶

func (r *Sender) Config() interface{}

func (*Sender) Name ¶

func (s *Sender) Name() string

func (*Sender) Plugin ¶

func (s *Sender) Plugin() string

func (*Sender) Send ¶

func (s *Sender) Send(event event.Event)

func (*Sender) StopSending ¶

func (s *Sender) StopSending(ctx context.Context)

func (*Sender) Tenant ¶

func (s *Sender) Tenant() tenant.Id

func (*Sender) Unwrap ¶

func (s *Sender) Unwrap() sender.Sender

type SenderConfig ¶

type SenderConfig struct {
	BotToken  string `json:"botToken"`
	ChannelId string `json:"channelId"`
}

func (*SenderConfig) Validate ¶

func (sc *SenderConfig) Validate() error

Validate

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
main

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL