tgkit

type Bot ¶

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

Bot is a telegram bot model.

func MustNewBot(identity string) Bot

func NewBot(identity string) (Bot, error)

func (b Bot) GetID() BotID

func (b Bot) GetIdentity() BotIdentity

func (b Bot) GetToken() BotToken

func (b Bot) String() string

type BotID ¶

type BotID uint64

BotID is a Bot ID number.

func (id BotID) String() string

type BotIdentity ¶

type BotIdentity string

BotIdentity is a Bot identity string.

func (t BotIdentity) String() string

type BotToken ¶

type BotToken string

BotToken is a Bot token string.

func (t BotToken) String() string

type ChatID ¶

type ChatID string

ChatID is a telegram chat ID/username.

func (id ChatID) String() string

type Client ¶

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

Client is a tool to communicate with a Telegram API via the HTTPS.

func NewClientWithOptions(options ...ClientOption) *Client

func NewDefaultClient() *Client

func (c *Client) Get(bot Bot, method string, target any) error

func (c *Client) GetMe(bot Bot) (TgUser, error)

func (c *Client) GetUpdates(bot Bot) ([]TgUpdate, error)

func (c *Client) Post(bot Bot, method string, reqData any, target any) error

func (c *Client) SendMessage(bot Bot, msg TgMessageRequest) (TgMessage, error)

type ClientOption ¶ added in v0.7.0

type ClientOption func(*Client)

ClientOption is a client constructor configuration option.

func WithHTTPClient(httpClient HTTPClient) ClientOption

func WithRetrier(retrier RequestRetrier) ClientOption

type HTTPClient ¶ added in v0.0.6

type HTTPClient interface {
	Get(url string) (resp *http.Response, err error)
	Post(url, contentType string, body io.Reader) (resp *http.Response, err error)
}

HTTPClient is an HTTP client interface; the http.Client fits.

type HTTPClientJSONMock ¶ added in v0.0.6

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

HTTPClientJSONMock is a test client returning the predefined response.

func (m *HTTPClientJSONMock) Get(url string) (resp *http.Response, err error)

func (m *HTTPClientJSONMock) Post(url, _ string, _ io.Reader) (resp *http.Response, err error)

func (m *HTTPClientJSONMock) RegisterResponse(method string, url string, responseCode int, responseBody any)

type RequestRetrier ¶ added in v0.7.0

type RequestRetrier interface {
	Do(reqFn sendRequestFn) (*http.Response, error)
}

RequestRetrier is a tool to retry failed requests.

func NewLinearRetrier(attempts uint, delay time.Duration) RequestRetrier

func NewNoopRetrier() RequestRetrier

func NewProgressiveRetrier(attempts uint, initialDelay time.Duration, multiplier float64) RequestRetrier

type TgChat ¶ added in v1.0.0

type TgChat struct {
	ID        int64  `json:"id"`
	Type      string `json:"type"`
	Title     string `json:"title,omitempty"`
	Username  string `json:"username,omitempty"`
	FirstName string `json:"first_name,omitempty"`
	LastName  string `json:"last_name,omitempty"`
	IsForum   bool   `json:"is_forum,omitempty"`
}

TgChat is a model representing the Telegram API chat object. See: https://core.telegram.org/bots/api#chat

id Integer Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. type String Type of the chat, can be either “private”, “group”, “supergroup” or “channel” title String Optional. Title, for supergroups, channels and group chats username String Optional. Username, for private chats, supergroups and channels if available first_name String Optional. First name of the other party in a private chat last_name String Optional. Last name of the other party in a private chat is_forum True Optional. True, if the supergroup chat is a forum (has topics enabled)

type TgErrorResponse ¶

type TgErrorResponse struct {
	Ok          bool   `json:"ok"`
	ErrorCode   int    `json:"error_code,omitempty"`
	Description string `json:"description,omitempty"`
}

TgErrorResponse is a Telegram response describing the error.

func (r TgErrorResponse) Error() string

type TgMessage ¶

type TgMessage struct {
	MessageID       int    `json:"message_id"`
	MessageThreadId int    `json:"message_thread_id,omitempty"`
	Date            uint64 `json:"date"`

	From TgUser `json:"from"`
	Chat TgChat `json:"chat"`
}

TgMessage is a Telegram message model. See https://core.telegram.org/bots/api#message TODO: add a lot of fields :)

type TgMessageRequest ¶

type TgMessageRequest struct {
	ChatID ChatID `json:"chat_id"`
	Text   string `json:"text"`

	BusinessConnectionId string `json:"business_connection_id,omitempty"`
	MessageThreadId      int    `json:"message_thread_id,omitempty"`
	ParseMode            string `json:"parse_mode,omitempty"`

	DisableNotification bool `json:"disable_notification,omitempty"`
	ProtectContent      bool `json:"protect_content,omitempty"`
}

TgMessageRequest is a message request body. See https://core.telegram.org/bots/api#sendmessage TODO: add entities, link_preview_options, reply_parameters and reply_markup fields.

type TgMessageResponse ¶

type TgMessageResponse struct {
	Ok     bool      `json:"ok"`
	Result TgMessage `json:"result"`
}

TgMessageResponse is a Telegram response with a single message result.

type TgUpdate ¶ added in v1.0.0

type TgUpdate struct {
	UpdateID int       `json:"update_id"`
	Message  TgMessage `json:"message"`
}

TgUpdate is struct representing the Telegram's Update object. See https://core.telegram.org/bots/api#update TODO: add a lot of fields :)

type TgUpdatesResponse ¶ added in v1.0.0

type TgUpdatesResponse struct {
	Ok     bool       `json:"ok"`
	Result []TgUpdate `json:"result"`
}

type TgUser ¶

type TgUser struct {
	ID int64 `json:"id"`

	FirstName    string `json:"first_name"`
	LastName     string `json:"last_name,omitempty"`
	Username     string `json:"username,omitempty"`
	LanguageCode string `json:"language_code,omitempty"`

	IsBot     bool `json:"is_bot"`
	IsPremium bool `json:"is_premium,omitempty"`

	AddedToAttachmentMenu   bool `json:"added_to_attachment_menu,omitempty"`
	CanJoinGroups           bool `json:"can_join_groups,omitempty"`
	CanReadAllGroupMessages bool `json:"can_read_all_group_messages,omitempty"`
	SupportsInlineQueries   bool `json:"supports_inline_queries,omitempty"`
	CanConnectToBusiness    bool `json:"can_connect_to_business,omitempty"`
}

TgUser is a model of the Telegram User. See https://core.telegram.org/bots/api#user

type TgUserResponse ¶

type TgUserResponse struct {
	Ok     bool
	Result TgUser
}

TgUserResponse is a response from the Telegram with a single TgUser object inside.