telegram_client

Documentation

Overview

модуль для использования Телеграмм Клиента (или бота)

Index

• Constants
• Variables
• func AddContact(ctx context.Context, phone_send_to string) error
• func AsFloodWait(err error) (d int, ok bool)
• func CloseConnection()
• func Connect(...)
• func Connect_err(...) error
• func CreateTelegramClient(...)
• func CreateTelegramClient_err(...) error
• func FillSettings()
• func FindMessageByID(ctx context.Context, id int) (*tg.Message, error)
• func FloodWait(ctx context.Context, err error) bool
• func GetContactsAll()
• func LogInfo_Connected(err error)
• func OnNewMessage(ctx context.Context, entities tg.Entities, ...) error
• func OnNewMessage_Test(ctx context.Context, entities tg.Entities, u *tg.UpdateNewMessage) error
• func SendMessage(phone_send_to string, text string) (int, error)
• func SendStyledText(phone_send_to string, texts ...message.StyledTextOption) (int, error)
• func StartTelegram(...)
• func Start_ctx(ctx *context.Context, WaitGroup *sync.WaitGroup, ...) error
• func TimeLimit()
• func WaitStop()
• type MessageTelegram
  • func FillMessageTelegramFromMessage(m *tg.Message) MessageTelegram
  • func (m MessageTelegram) String() string
• type SettingsINI

Constants

const MAX_MESSAGE_LEN = 4096

MAX_MESSAGE_LEN - максимальная длина сообщения

Variables

var Client *telegram.Client

Client - клиент соединения мессенджера Телеграм

var Contacts *tg.ContactsContacts

Contacts - список контактов в Telegram

var Func_OnNewMessage func(ctx context.Context, entities tg.Entities, u *tg.UpdateNewMessage, Peer1 storage.Peer) error

Func_OnNewMessage - функция из внешнего модуля, для приёма новых сообщений

var MaxSendMessageCountIn1Second float32 = 0.13 //0.13 =4 сообщения в секунду

MaxSendMessageCountIn1Second - максимальное количество сообщений в 1 секунду

var PeerDB *pebble.PeerStorage

PeerDB - локальная база данных cockroachdb, для хранения кеша PeerID отправителей

var UserSelf *tg.User

UserSelf - собственный юзер в Телеграм

Functions

func AddContact

func AddContact(ctx context.Context, phone_send_to string) error

AddContact - добавляет новый контакт в список контактов Телеграм

func AsFloodWait

func AsFloodWait(err error) (d int, ok bool)

AsFloodWait returns wait duration and true boolean if err is the "FLOOD_WAIT" error.

Client should wait for that duration before issuing new requests with same method.

func CloseConnection

func CloseConnection()

CloseConnection - остановка работы клиента Телеграм

func Connect

func Connect(func_OnNewMessage func(ctx context.Context, entities tg.Entities, u *tg.UpdateNewMessage, Peer1 storage.Peer) error)

Connect подключение к серверу Телеграм, паника при ошибке

func Connect_err

func Connect_err(func_OnNewMessage func(ctx context.Context, entities tg.Entities, u *tg.UpdateNewMessage, Peer1 storage.Peer) error) error

Connect_err подключение к серверу Телеграм

func CreateTelegramClient

func CreateTelegramClient(func_OnNewMessage func(ctx context.Context, entities tg.Entities, u *tg.UpdateNewMessage, Peer1 storage.Peer) error)

CreateTelegramClient создание клиента Телеграм, без подключения лучше использовать Connect() - с подключением

func CreateTelegramClient_err

func CreateTelegramClient_err(func_OnNewMessage func(ctx context.Context, entities tg.Entities, u *tg.UpdateNewMessage, Peer1 storage.Peer) error) error

CreateTelegramClient_err создание клиента Телеграм, без подключения лучше использовать Connect_err() - с подключением

func FillSettings

func FillSettings()

FillSettings загружает переменные окружения в структуру из переменных окружения

func FindMessageByID

func FindMessageByID(ctx context.Context, id int) (*tg.Message, error)

FindMessageByID - находит сообщение на сервере Телеграм по id

func FloodWait

func FloodWait(ctx context.Context, err error) bool

FloodWait sleeps required duration and returns true if err is FLOOD_WAIT or false and context or original error otherwise.

func GetContactsAll

func GetContactsAll()

GetContactsAll - обновляет список контактов

func LogInfo_Connected

func LogInfo_Connected(err error)

LogInfo_Connected - выводит сообщение в Лог, или паника при ошибке

func OnNewMessage

func OnNewMessage(ctx context.Context, entities tg.Entities, UpdateNewMessage1 *tg.UpdateNewMessage) error

OnNewMessage - функция для получения новых сообщений, и перенаправления во внешний Func_OnNewMessage() чтоб отправить сообщение надо: api := telegram_client.Client.API() sender := message.NewSender(api) InputPeerClass1 := Peer1.AsInputPeer() RequestBuilder1 := sender.To(InputPeerClass1) UpdateClass1, err := RequestBuilder1.Text(ctx, TextMess)

func OnNewMessage_Test

func OnNewMessage_Test(ctx context.Context, entities tg.Entities, u *tg.UpdateNewMessage) error

OnNewMessage_Test - пример функции для получения новых сообщений

func SendMessage

func SendMessage(phone_send_to string, text string) (int, error)

SendMessage - отправка сообщения в мессенджер Телеграм возвращает: id = id отправленного сообщения в telegram err = error

func SendStyledText

func SendStyledText(phone_send_to string, texts ...message.StyledTextOption) (int, error)

SendStyledText - отправка сообщения в мессенджер Телеграм, все слова должны быть оформлены в StyledTextOption возвращает: id = id отправленного сообщения в telegram err = error

func StartTelegram

func StartTelegram(func_OnNewMessage func(ctx context.Context, entities tg.Entities, u *tg.UpdateNewMessage, Peer1 storage.Peer) error)

StartTelegram - подключается к телеграмму, запускает остановку приложения. func_OnNewMessage - функция для приёма новых сообщений

func Start_ctx

func Start_ctx(ctx *context.Context, WaitGroup *sync.WaitGroup, func_OnNewMessage func(ctx context.Context, entities tg.Entities, u *tg.UpdateNewMessage, Peer1 storage.Peer) error) error

Start_ctx - необходимые процедуры для подключения к серверу Telegram Свой контекст и WaitGroup нужны для остановки работы сервиса Graceful shutdown Для тех кто пользуется этим репозиторием для старта и останова сервиса можно просто StartTelegram()

func TimeLimit

func TimeLimit()

TimeLimit пауза для ограничения количество сообщений в секунду

func WaitStop

func WaitStop()

WaitStop - ожидает отмену глобального контекста

Types

type MessageTelegram

type MessageTelegram struct {
	Text      string
	FromID    int64
	ChatID    int64
	IsFromMe  bool
	MediaType string
	//NameTo    string
	IsGroup  bool
	ID       int
	TimeSent time.Time
}

MessageTelegram - сообщение из Telegram сокращённо

func FillMessageTelegramFromMessage

func FillMessageTelegramFromMessage(m *tg.Message) MessageTelegram

FillMessageTelegramFromMessage - заполнение струткру MessageTelegram из сообщения от Telegram

func (MessageTelegram) String

func (m MessageTelegram) String() string

String - возвращает строку из структуры

type SettingsINI

type SettingsINI struct {
	TELEGRAM_APP_ID          int
	TELEGRAM_APP_HASH        string
	TELEGRAM_PHONE_FROM      string
	TELEGRAM_PHONE_SEND_TEST string
}

SettingsINI - структура для хранения всех нужных переменных окружения TELEGRAM_APP_ID, TELEGRAM_APP_HASH - первоначально получить по ссылке: https://my.telegram.org/apps TELEGRAM_PHONE_FROM - номер телефона с которого отправляются сообщения

var Settings SettingsINI

Settings хранит все нужные переменные окружения