Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

tgo

package module

Go to main page

Versions in this module

v1

v1.1.1

Dec 23, 2024

v1.1.0

Dec 23, 2024

v1.0.5

Nov 5, 2024

Changes in this version

+ func FormatChatID(chatID int64) string

+ func FormatFullNameAndUsername(fullName, username string) string

type Bot

+ func (b *Bot) Bootstrap(ctx context.Context)

v1.0.4

Nov 4, 2024

v1.0.3

Nov 4, 2024

v1.0.2

Nov 4, 2024

v1.0.1

Nov 4, 2024

Changes in this version

type Bot

+ func NewBot(callOpts ...CallOption) (*Bot, error)

v1.0.0

Nov 4, 2024

Changes in this version

+ const MessageLengthLimit

+ func EscapeHTMLSymbols(str string) string

+ func EscapeStringForMarkdownV2(src string) string

+ func FullNameFromFirstAndLastName(firstName, lastName string) string

+ func MapChatTypeToChineseText(chatType ChatType) string

+ func MapMemberStatusToChineseText(memberStatus MemberStatus) string

+ func RemoveHTMLBlocksFromString(str string) string

+ func ReplaceMarkdownTitlesToTelegramBoldElement(text string) string

+ func SplitMessagesAgainstLengthLimitIntoMessageGroups(originalSlice []string) [][]string

+ type Bot struct

+ func NewBotService(callOpts ...CallOption) (*Bot, error)

+ func (b *Bot) Bot() *BotAPI

+ func (b *Bot) MayMakeRequest(endpoint string, params tgbotapi.Params) *tgbotapi.APIResponse

+ func (b *Bot) PinChatMessage(config PinChatMessageConfig) error

+ func (b *Bot) Start(ctx context.Context) error

+ func (b *Bot) Stop(ctx context.Context) error

+ func (b *Bot) UnpinChatMessage(config UnpinChatMessageConfig) error

+ type BotAPI struct

+ func (b *BotAPI) AssignOneCallbackQueryData(route string, data any) (string, error)

+ func (b *BotAPI) AssignOneNopCallbackQueryData() (string, error)

+ func (b *BotAPI) DeleteAllDeleteLaterMessages(forUserID int64) error

+ func (b *BotAPI) IsBotAdministrator(chatID int64) (bool, error)

+ func (b *BotAPI) IsBotWasBlockedByTheUserErr(err error) bool

+ func (b *BotAPI) IsCannotInitiateChatWithUserErr(err error) bool

+ func (b *BotAPI) IsGroupAnonymousBot(user *tgbotapi.User) bool

+ func (b *BotAPI) IsUserMemberStatus(chatID int64, userID int64, status []MemberStatus) (bool, error)

+ func (b *BotAPI) MayRequest(chattable tgbotapi.Chattable) *tgbotapi.APIResponse

+ func (b *BotAPI) MaySend(chattable tgbotapi.Chattable) *tgbotapi.Message

+ func (b *BotAPI) PushOneDeleteLaterMessage(forUserID int64, chatID int64, messageID int) error

+ func (b *BotAPI) RateLimitForCommand(chatID int64, command string, rate int64, perDuration time.Duration) (int64, bool, error)

+ func (b *BotAPI) RemoveInlineKeyboardButtonFromInlineKeyboardMarkupThatMatchesDataWith(inlineKeyboardMarkup tgbotapi.InlineKeyboardMarkup, callbackData string) tgbotapi.InlineKeyboardMarkup

+ func (b *BotAPI) ReplaceInlineKeyboardButtonFromInlineKeyboardMarkupThatMatchesDataWith(inlineKeyboardMarkup tgbotapi.InlineKeyboardMarkup, callbackData string, ...) tgbotapi.InlineKeyboardMarkup

+ type CallOption func(*botServiceOptions)

+ func WithAPIEndpoint(endpoint string) CallOption

+ func WithDispatcher(dispatcher *Dispatcher) CallOption

+ func WithI18n(i18n *i18n.I18n) CallOption

+ func WithLogger(logger *logger.Logger) CallOption

+ func WithQueue(queue queue.Queue) CallOption

+ func WithRueidis(rueidis rueidis.Client) CallOption

+ func WithTTLCache(ttlcache ttlcache.TTLCache) CallOption

+ func WithToken(token string) CallOption

+ func WithWebhookPort(port string) CallOption

+ func WithWebhookURL(url string) CallOption

+ type ChatType string

+ const ChatTypeChannel

+ const ChatTypeGroup

+ const ChatTypePrivate

+ const ChatTypeSuperGroup

+ type Command struct

+ Command string

+ Handler Handler

+ HelpMessage func(*Context) string

+ type Context struct

+ Bot *BotAPI

+ I18n *i18n.I18n

+ Logger *logger.Logger

+ Update tgbotapi.Update

+ func NewContext(bot *tgbotapi.BotAPI, botAPI *BotAPI, update tgbotapi.Update, ...) *Context

+ func (c *Context) Abort()

+ func (c *Context) BindFromCallbackQueryData(dst any) error

+ func (c *Context) IsAborted() bool

+ func (c *Context) IsBotAdministrator() (bool, error)

+ func (c *Context) IsUserMemberStatus(userID int64, status []MemberStatus) (bool, error)

+ func (c *Context) Language() string

+ func (c *Context) NewEditMessageReplyMarkup(messageID int, replyMarkup tgbotapi.InlineKeyboardMarkup) EditMessageResponse

+ func (c *Context) NewEditMessageText(messageID int, text string) EditMessageResponse

+ func (c *Context) NewEditMessageTextAndReplyMarkup(messageID int, text string, replyMarkup tgbotapi.InlineKeyboardMarkup) EditMessageResponse

+ func (c *Context) NewMessage(message string) MessageResponse

+ func (c *Context) NewMessageReplyTo(message string, replyToMessageID int) MessageResponse

+ func (c *Context) RateLimitForCommand(chatID int64, command string, rate int64, perDuration time.Duration) (int64, bool, error)

+ func (c *Context) T(key string, args ...any) string

+ func (c *Context) UpdateType() UpdateType

+ type Dispatcher struct

+ func NewDispatcher(logger *logger.Logger) *Dispatcher

+ func (d *Dispatcher) Dispatch(bot *tgbotapi.BotAPI, botAPI *BotAPI, i18n *i18n.I18n, update tgbotapi.Update)

+ func (d *Dispatcher) OnCallbackQuery(route string, h Handler)

+ func (d *Dispatcher) OnCancelCommand(cancelHandler func(c *Context) (bool, error), handler Handler)

+ func (d *Dispatcher) OnChannelPost(handler Handler)

+ func (d *Dispatcher) OnChatMigrationFrom(h Handler)

+ func (d *Dispatcher) OnCommand(cmd string, commandHelp func(c *Context) string, h Handler)

+ func (d *Dispatcher) OnCommandGroup(groupName func(*Context) string, group []Command)

+ func (d *Dispatcher) OnLeftChatMember(h Handler)

+ func (d *Dispatcher) OnMyChatMember(handler Handler)

+ func (d *Dispatcher) OnNewChatMember(h Handler)

+ func (d *Dispatcher) OnStartCommand(h Handler)

+ func (d *Dispatcher) Use(middleware MiddlewareFunc)

+ type EditMessageResponse struct

+ func NewEditMessageReplyMarkup(chatID int64, messageID int, replyMarkup tgbotapi.InlineKeyboardMarkup) EditMessageResponse

+ func NewEditMessageText(chatID int64, messageID int, text string) EditMessageResponse

+ func NewEditMessageTextAndReplyMarkup(chatID int64, messageID int, text string, ...) EditMessageResponse

+ func (r EditMessageResponse) WithEditMessageCaptionConfig(config tgbotapi.EditMessageCaptionConfig) EditMessageResponse

+ func (r EditMessageResponse) WithEditMessageLiveLocationConfig(config tgbotapi.EditMessageLiveLocationConfig) EditMessageResponse

+ func (r EditMessageResponse) WithEditMessageMediaConfig(config tgbotapi.EditMessageMediaConfig) EditMessageResponse

+ func (r EditMessageResponse) WithEditMessageReplyMarkupConfig(config tgbotapi.EditMessageReplyMarkupConfig) EditMessageResponse

+ func (r EditMessageResponse) WithEditMessageTextConfig(config tgbotapi.EditMessageTextConfig) EditMessageResponse

+ func (r EditMessageResponse) WithInlineReplyMarkup(inlineMarkup tgbotapi.InlineKeyboardMarkup) EditMessageResponse

+ func (r EditMessageResponse) WithParseModeHTML() EditMessageResponse

+ type ExceptionError struct

+ func NewExceptionError(err error) ExceptionError

+ func (e ExceptionError) Error() string

+ func (e ExceptionError) WithDeleteLater(userID int64, chatID int64) ExceptionError

+ func (e ExceptionError) WithEdit(message *tgbotapi.Message) ExceptionError

+ func (e ExceptionError) WithMessage(message string) ExceptionError

+ func (e ExceptionError) WithReply(message *tgbotapi.Message) ExceptionError

+ func (e ExceptionError) WithReplyMarkup(replyMarkup tgbotapi.InlineKeyboardMarkup) ExceptionError

+ type HandleFunc func(ctx *Context) (Response, error)

+ type Handler interface

+ Handle func(c *Context) (Response, error)

+ func NewHandler(h HandleFunc) Handler

+ type HandlerGroup interface

+ Install func(dispatcher *Dispatcher)

+ type MemberStatus string

+ const MemberStatusAdministrator

+ const MemberStatusCreator

+ const MemberStatusKicked

+ const MemberStatusLeft

+ const MemberStatusMember

+ const MemberStatusRestricted

+ type MessageError struct

+ func NewMessageError(message string) MessageError

+ func (e MessageError) Error() string

+ func (e MessageError) WithDeleteLater(userID int64, chatID int64) MessageError

+ func (e MessageError) WithEdit(message *tgbotapi.Message) MessageError

+ func (e MessageError) WithParseModeHTML() MessageError

+ func (e MessageError) WithReply(message *tgbotapi.Message) MessageError

+ func (e MessageError) WithReplyMarkup(replyMarkup tgbotapi.InlineKeyboardMarkup) MessageError

+ type MessageResponse struct

+ func NewMessage(chatID int64, message string) MessageResponse

+ func NewMessageReplyTo(chatID int64, message string, replyToMessageID int) MessageResponse

+ func (r MessageResponse) WithDeleteLater(userID int64, chatID int64) MessageResponse

+ func (r MessageResponse) WithMessageConfig(config tgbotapi.MessageConfig) MessageResponse

+ func (r MessageResponse) WithParseModeHTML() MessageResponse

+ func (r MessageResponse) WithReplyMarkup(replyMarkup any) MessageResponse

+ type MiddlewareFunc func(ctx *Context, next func())

+ type PinChatMessageConfig struct

+ ChannelUsername string

+ ChatID int64

+ DisableNotification bool

+ MessageID int

+ func NewPinChatMessageConfig(chatID int64, messageID int) PinChatMessageConfig

+ type Response interface

+ type UnpinChatMessageConfig struct

+ ChannelUsername string

+ ChatID int64

+ MessageID int

+ func NewUnpinChatMessageConfig(chatID int64, messageID int) UnpinChatMessageConfig

+ type UpdateType string

+ const UpdateTypeCallbackQuery

+ const UpdateTypeChannelPost

+ const UpdateTypeChatJoinRequest

+ const UpdateTypeChatMember

+ const UpdateTypeChatMigrationFrom

+ const UpdateTypeChatMigrationTo

+ const UpdateTypeChosenInlineResult

+ const UpdateTypeEditedChannelPost

+ const UpdateTypeEditedMessage

+ const UpdateTypeInlineQuery

+ const UpdateTypeLeftChatMember

+ const UpdateTypeMessage

+ const UpdateTypeMyChatMember

+ const UpdateTypeNewChatMembers

+ const UpdateTypePoll

+ const UpdateTypePollAnswer

+ const UpdateTypePreCheckoutQuery

+ const UpdateTypeShippingQuery

+ const UpdateTypeUnknown