telegram

Documentation

Overview

Package telegram is a module that sends notification to a Telegram chat when certain conditions trigger

Index

• Constants
• type Telegram
  • func Load(s *session.Session) (m *Telegram, err error)
  • func Self(s *session.Session) *Telegram
  • func (module *Telegram) Author() string
  • func (module *Telegram) Description() string
  • func (module *Telegram) Name() string
  • func (module *Telegram) PrintConfig()
  • func (module *Telegram) Prompt()
  • func (module *Telegram) Send(message string)

Constants

const (
	Name        = "telegram"
	Description = "A module that sends notifications via Telegram chat"
	Author      = "Muraena Team"
)

Types

type Telegram

type Telegram struct {
	session.SessionModule

	Enabled  bool
	BotToken string
	ChatID   []string
}

Telegram module

func Load

func Load(s *session.Session) (m *Telegram, err error)

Load configures the module by initializing its main structure and variables

func Self

func Self(s *session.Session) *Telegram

func (*Telegram) Author

func (module *Telegram) Author() string

Author returns the module author

func (*Telegram) Description

func (module *Telegram) Description() string

Description returns the module description

func (*Telegram) Name

func (module *Telegram) Name() string

Name returns the module name

func (*Telegram) PrintConfig

func (module *Telegram) PrintConfig()

PrintConfig shows the actual Telegram configuration

func (*Telegram) Prompt

func (module *Telegram) Prompt()

Prompt prints module status based on the provided parameters

func (*Telegram) Send

func (module *Telegram) Send(message string)