telegram

Documentation

Index

• Constants
• func New(ctx context.Context, cfg *handlerTY.Config) (handlerTY.Plugin, error)
• type Config
• type Message
• type Response
• type TelegramClient
  • func (c *TelegramClient) Close() error
  • func (c *TelegramClient) GetMe() (*User, error)
  • func (p *TelegramClient) Name() string
  • func (c *TelegramClient) Post(parameters map[string]interface{}) error
  • func (c *TelegramClient) SendMessage(message *Message) error
  • func (c *TelegramClient) Start() error
  • func (c *TelegramClient) State() *types.State
• type User

Constants

const (
	ServerURL      = "https://api.telegram.org"
	APIGetMe       = "/getMe"
	APISendMessage = "/sendMessage"
)

Telegram server api details

const (
	ParseModeText       = "Text"
	ParseModeMarkdownV2 = "MarkdownV2"
	ParseModeHTML       = "HTML"
)

Message types

const (
	PluginTelegram = "telegram"
)

Functions

func New

func New(ctx context.Context, cfg *handlerTY.Config) (handlerTY.Plugin, error)

telegram handler

Types

type Config

type Config struct {
	Token   string `json:"-"`
	ChatIDs []string
}

Config data for telegram client

type Message

type Message struct {
	ChatID                string `json:"chat_id"`
	Text                  string `json:"text"`
	ParseMode             string `json:"parse_mode"`
	DisableWebPagePreview bool   `json:"disable_web_page_preview"`
	DisableNotification   bool   `json:"disable_notification"`
	ReplyToMessageID      int    `json:"reply_to_message_id"`
}

Message struct

type Response

type Response struct {
	IsOK        bool                   `json:"ok"`
	Result      map[string]interface{} `json:"result"`
	ErrorCode   int                    `json:"error_code"`
	Description string                 `json:"description"`
}

Response struct

type TelegramClient

type TelegramClient struct {
	Config *Config
	// contains filtered or unexported fields
}

TelegramClient struct

func (*TelegramClient) Close

func (c *TelegramClient) Close() error

Close handler implementation

func (*TelegramClient) GetMe

func (c *TelegramClient) GetMe() (*User, error)

GetMe returns about the user profile

func (*TelegramClient) Name

func (p *TelegramClient) Name() string

func (*TelegramClient) Post

func (c *TelegramClient) Post(parameters map[string]interface{}) error

Post handler implementation

func (*TelegramClient) SendMessage

func (c *TelegramClient) SendMessage(message *Message) error

SendMessage func

func (*TelegramClient) Start

func (c *TelegramClient) Start() error

Start handler implementation

func (*TelegramClient) State

func (c *TelegramClient) State() *types.State

State implementation

type User

type User struct {
	ID           int    `json:"id"`
	IsBot        bool   `json:"is_bot"`
	FirstName    string `json:"first_name"`
	LastName     string `json:"last_name"`
	Username     string `json:"username"`
	LanguageCode string `json:"language_code"`
}

User struct