telegram

Documentation

Index

• Constants
• type Telegram
  • func New(apiToken string) (*Telegram, error)
  • func (t *Telegram) AddReceivers(chatIDs ...int64)
  • func (t Telegram) Send(ctx context.Context, subject, message string) error
  • func (t *Telegram) SetClient(client *tgbotapi.BotAPI)
  • func (t *Telegram) SetParseMode(mode string)

Constants

const (
	ModeMarkdown = tgbotapi.ModeMarkdown
	ModeHTML     = tgbotapi.ModeHTML
)

Types

type Telegram

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

Telegram struct holds necessary data to communicate with the Telegram API.

func New

func New(apiToken string) (*Telegram, error)

New returns a new instance of a Telegram notification service. For more information about telegram api token:

-> https://pkg.go.dev/github.com/go-telegram-bot-api/telegram-bot-api#NewBotAPI

func (*Telegram) AddReceivers

func (t *Telegram) AddReceivers(chatIDs ...int64)

AddReceivers takes Telegram chat IDs and adds them to the internal chat ID list. The Send method will send a given message to all those chats.

func (Telegram) Send

func (t Telegram) Send(ctx context.Context, subject, message string) error

Send takes a message subject and a message body and sends them to all previously set chats. Message body supports html as markup language.

func (*Telegram) SetClient

func (t *Telegram) SetClient(client *tgbotapi.BotAPI)

SetClient set a new custom BotAPI instance. For example allowing you to use NewBotAPIWithClient:

-> https://pkg.go.dev/github.com/go-telegram-bot-api/telegram-bot-api#NewBotAPIWithClient

func (*Telegram) SetParseMode

func (t *Telegram) SetParseMode(mode string)

SetParseMode sets the parse mode for the message body. For more information about telegram constants:

-> https://pkg.go.dev/github.com/go-telegram-bot-api/telegram-bot-api#pkg-constants