tgbox

package module

Go to main page

Versions in this module

v0

v0.2.0

Oct 15, 2026

Changes in this version

+ type ChatMigrateTo struct

+ NewChannelID int64

+ OldChatID int64

type Client

+ func (c *Client) OnChatMigrateTo(h Handler, opts ...HandlerOption)

type Context

+ Meta FastMetadata

+ func (c *Context) Release()

+ type ContextPool struct

+ func NewContextPool() *ContextPool

+ func (p *ContextPool) Acquire(parent context.Context, meta FastMetadata) *Context

+ func (p *ContextPool) Release(ctx *Context)

type Dispatcher

+ SetMetrics func(m dispatcher.MetricsReporter)

+ type FastMetadata struct

+ ClientID int64

+ SpanID uint64

+ TraceID [16]byte

+ UnixNano int64

+ func (m FastMetadata) TraceIDString() string

type Option

+ func WithOnTooLong(cb func()) Option

+ func WithStateStorage(s syncstate.StateStorage) Option

+ type PipelineContext struct

+ Meta FastMetadata

+ Update tg.UpdateClass

+ func (c *PipelineContext) Deadline() (deadline time.Time, ok bool)

+ func (c *PipelineContext) Done() <-chan struct{}

+ func (c *PipelineContext) Err() error

+ func (c *PipelineContext) Release()

+ func (c *PipelineContext) Value(key any) any

type Profiler

+ func (p *Profiler) Metrics() *telemetry.SyncMetrics

type ProfilerConfig

+ SyncMetrics *telemetry.SyncMetrics

type StateManager

+ MoveState func(ctx context.Context, oldChatID, oldUserID, newChatID, newUserID int64) error

type Update

+ ChatMigrateTo *ChatMigrateTo

+ MessageService *tg.MessageService

type UpdateKind

+ const KindChatMigrateTo

v0.1.0

Oct 2, 2026

Changes in this version

+ var ErrContinueGroups = dispatcher.ErrContinueGroups

+ var ErrEndGroups = dispatcher.ErrEndGroups

+ var ErrExpirationWatchNotSupported = errors.New("tgbox: FSM storage does not support reactive expiration watching")

+ var ErrFSMNotConfigured = errors.New("tgbox: conversational FSM engine/storage is not configured")

+ var ErrInvalidFSMContext = errors.New("tgbox: FSM operations require a valid chat and user context")

+ var ErrNetworkNotConfigured = errors.New("tgbox: network profile is not configured")

+ var ErrNilUpdate = errors.New("tgbox: context update payload is nil")

+ var ErrNoCallbackQuery = errors.New("tgbox: context does not hold an active callback query")

+ var ErrNoInlineQuery = errors.New("tgbox: context does not hold an active inline query")

+ var ErrNoMessageID = errors.New("tgbox: current update has no associated message ID to edit")

+ var ErrNoPeer = errors.New("tgbox: update structure does not present any recognizable peer")

+ func BuildBanRequest(channel tg.InputChannelClass, participant tg.InputPeerClass) *tg.ChannelsEditBannedRequest

+ func BuildPromoteRequest(channel tg.InputChannelClass, user tg.InputUserClass) *tg.ChannelsEditAdminRequest

+ func ClientIDFromContext(ctx context.Context) int64

+ func DefaultAdminRights() tg.ChatAdminRights

+ func DefaultBannedRights() tg.ChatBannedRights

+ func RegisterControllers(r Registrar, controllers ...Controller) error

+ func TraceIDFromContext(ctx context.Context) string

+ func WithClientID(ctx context.Context, clientID int64) context.Context

+ func WithTraceID(ctx context.Context, traceID string) context.Context

+ type AdminService interface

+ Ban func(ctx context.Context, channel tg.InputChannelClass, ...) error

+ Promote func(ctx context.Context, channel tg.InputChannelClass, user tg.InputUserClass) error

+ func NewAdminService(rpc *tg.Client) AdminService

+ type Client struct

+ func New(appName string, opts ...Option) (*Client, error)

+ func (c *Client) API() *tg.Client

+ func (c *Client) Admin() AdminService

+ func (c *Client) Chat() MessageService

+ func (c *Client) Close() error

+ func (c *Client) DownloadFile(ctx context.Context, location tg.InputFileLocationClass, dst io.Writer) (tg.StorageFileTypeClass, error)

+ func (c *Client) FetchSelf(ctx context.Context) error

+ func (c *Client) Install(plugins ...Plugin) error

+ func (c *Client) OnCallbackQuery(f Filter, h Handler, opts ...HandlerOption)

+ func (c *Client) OnChatJoinRequest(f Filter, h Handler, opts ...HandlerOption)

+ func (c *Client) OnChatMemberUpdated(f Filter, h Handler, opts ...HandlerOption)

+ func (c *Client) OnCommand(pattern string, h Handler, opts ...HandlerOption)

+ func (c *Client) OnDeletedMessages(f Filter, h Handler, opts ...HandlerOption)

+ func (c *Client) OnEditedMessage(f Filter, h Handler, opts ...HandlerOption)

+ func (c *Client) OnInlineQuery(f Filter, h Handler, opts ...HandlerOption)

+ func (c *Client) OnMessage(f Filter, h Handler, opts ...HandlerOption)

+ func (c *Client) OnRawUpdate(h RawHandler, opts ...HandlerOption)

+ func (c *Client) OnState(state string, h Handler, opts ...HandlerOption)

+ func (c *Client) RegisterController(controllers ...Controller) error

+ func (c *Client) Resume() error

+ func (c *Client) Run(ctx context.Context) error

+ func (c *Client) Self() *tg.User

+ func (c *Client) Sender() *message.Sender

+ func (c *Client) State() StateManager

+ func (c *Client) Suspend() error

+ func (c *Client) UploadFile(ctx context.Context, name string, src io.Reader, size int64) (tg.InputFileClass, error)

+ type CommandRouter interface

+ Insert func(path string, handler commandRoute)

+ Match func(path string) (handler commandRoute, params map[string]string, ok bool)

+ type Context struct

+ Entities *tg.Entities

+ Logger *slog.Logger

+ Params map[string]string

+ StdContext context.Context

+ Update *Update

+ func (c *Context) ActiveChannelAndSender() (*tg.InputChannel, tg.InputUserClass, error)

+ func (c *Context) ClientID() int64

+ func (c *Context) Context() context.Context

+ func (c *Context) CurrentPeer() (tg.InputPeerClass, error)

+ func (c *Context) Deadline() (time.Time, bool)

+ func (c *Context) Done() <-chan struct{}

+ func (c *Context) Err() error

+ func (c *Context) Param(key string) string

+ func (c *Context) PeerPromise() peer.Promise

+ func (c *Context) ResolveUser(id int64) (tg.InputUserClass, error)

+ func (c *Context) TraceID() string

+ func (c *Context) Value(key any) any

+ type Controller interface

+ RegisterRoutes func(r Registrar) error

+ type ControllerFunc func(r Registrar) error

+ func (f ControllerFunc) RegisterRoutes(r Registrar) error

+ type Dispatcher interface

+ AddRoute func(kind int, f Filter, h Handler, m []Middleware, group int)

+ Handle func(c *Context, update *Update)

+ SetInterceptor func(f func(*Context, *Update) bool)

+ SetWildcardKind func(kind int)

+ Start func(ctx context.Context)

+ type Filter func(ctx *Context, update *Update) bool

+ type Handler func(ctx *Context, update *Update) error

+ func Logger(h Handler) Handler

+ func Recover(h Handler) Handler

+ type HandlerOption interface

+ func InGroup(group int) HandlerOption

+ func WithLocalMiddlewares(m ...Middleware) HandlerOption

+ type Lock interface

+ Release func(ctx context.Context) error

+ type Locker interface

+ Obtain func(ctx context.Context, key string, ttl time.Duration) (Lock, error)

+ type MessageService interface

+ AnswerCallback func(ctx context.Context, queryID int64, alert bool, text string) error

+ EditActive func(ctx context.Context, peer tg.InputPeerClass, msgID int, text string, ...) (tg.UpdatesClass, error)

+ EditReplyMarkup func(ctx context.Context, peer tg.InputPeerClass, msgID int, ...) (tg.UpdatesClass, error)

+ EditRich func(ctx context.Context, peer tg.InputPeerClass, msgID int, ...) (tg.UpdatesClass, error)

+ ReplyHTML func(ctx context.Context, peer tg.InputPeerClass, msgID int, text string, ...) (tg.UpdatesClass, error)

+ ReplyMarkdown func(ctx context.Context, peer tg.InputPeerClass, msgID int, text string, ...) (tg.UpdatesClass, error)

+ ReplyRich func(ctx context.Context, peer tg.InputPeerClass, msgID int, ...) (tg.UpdatesClass, error)

+ ReplyRichMarkdown func(ctx context.Context, peer tg.InputPeerClass, msgID int, text string, ...) (tg.UpdatesClass, error)

+ ReplyText func(ctx context.Context, peer tg.InputPeerClass, msgID int, text string, ...) (tg.UpdatesClass, error)

+ SendHTML func(ctx context.Context, peer tg.InputPeerClass, text string, opts ...SendOption) (tg.UpdatesClass, error)

+ SendMarkdown func(ctx context.Context, peer tg.InputPeerClass, text string, opts ...SendOption) (tg.UpdatesClass, error)

+ SendRich func(ctx context.Context, peer tg.InputPeerClass, msg tg.InputRichMessageClass, ...) (tg.UpdatesClass, error)

+ SendRichMarkdown func(ctx context.Context, peer tg.InputPeerClass, text string, opts ...SendOption) (tg.UpdatesClass, error)

+ SendText func(ctx context.Context, peer tg.InputPeerClass, text string, opts ...SendOption) (tg.UpdatesClass, error)

+ func NewChatService(sender *message.Sender, rpc *tg.Client, peerStorage contribstorage.PeerStorage) MessageService

+ type Middleware func(Handler) Handler

+ type MultiTenantSessionStorage interface

+ DeleteSession func(ctx context.Context, tenantKey string) error

+ GetSessionStorage func(tenantKey string) SessionStorage

+ HasSession func(ctx context.Context, tenantKey string) (bool, error)

+ type Option interface

+ func WithAppHash(hash string) Option

+ func WithAppID(id int) Option

+ func WithAppVersion(v string) Option

+ func WithAutoPeerCaching(enabled bool) Option

+ func WithBotToken(token string) Option

+ func WithDeviceConfig(d telegram.DeviceConfig) Option

+ func WithDeviceModel(model string) Option

+ func WithEngine(e engine.Engine) Option

+ func WithEngineOptions(fn func(opts *telegram.Options)) Option

+ func WithFSMStorage(s fsm.Storage) Option

+ func WithHTTPProxy(addr, username, password string, fallback bool) Option

+ func WithInitParams(v tg.JSONValueClass) Option

+ func WithLangCode(code string) Option

+ func WithLangPack(pack string) Option

+ func WithLogger(l *slog.Logger) Option

+ func WithNetworkProfile(profile network.Profile) Option

+ func WithPFS(enabled bool, ttl ...time.Duration) Option

+ func WithPeerStorage(p storage.PeerStorage) Option

+ func WithProfiler(cfg ProfilerConfig) Option

+ func WithProxy(rawURL string, fallback bool) Option

+ func WithSOCKS5(addr, username, password string, fallback bool) Option

+ func WithSessionStorage(s SessionStorage) Option

+ func WithSystemLangCode(code string) Option

+ func WithSystemVersion(v string) Option

+ func WithTrafficObserver(cb func()) Option

+ func WithWorkers(w int) Option

+ func WithoutUpdates() Option

+ type Plugin interface

+ Register func(r Registrar) error

+ type Profiler struct

+ func NewProfiler(cfg ProfilerConfig, logger *slog.Logger) *Profiler

+ func (*Profiler) LeakedGoroutines() int

+ func (*Profiler) NumGoroutine() int

+ func (p *Profiler) Addr() string

+ func (p *Profiler) Close() error

+ type ProfilerConfig struct

+ Enabled bool

+ GoroutineThreshold int

+ HTTPAddr string

+ OnLeakDetected func(count int)

+ OnThresholdExceeded func(count int)

+ ScanInterval time.Duration

+ type RawHandler func(ctx *Context, entities *tg.Entities, raw tg.UpdateClass) error

+ type Registrar interface

+ API func() *tg.Client

+ OnCallbackQuery func(f Filter, h Handler, opts ...HandlerOption)

+ OnChatJoinRequest func(f Filter, h Handler, opts ...HandlerOption)

+ OnChatMemberUpdated func(f Filter, h Handler, opts ...HandlerOption)

+ OnCommand func(pattern string, h Handler, opts ...HandlerOption)

+ OnDeletedMessages func(f Filter, h Handler, opts ...HandlerOption)

+ OnEditedMessage func(f Filter, h Handler, opts ...HandlerOption)

+ OnInlineQuery func(f Filter, h Handler, opts ...HandlerOption)

+ OnMessage func(f Filter, h Handler, opts ...HandlerOption)

+ OnRawUpdate func(h RawHandler, opts ...HandlerOption)

+ OnState func(state string, h Handler, opts ...HandlerOption)

+ Self func() *tg.User

+ type SendOption func(b *message.Builder) error

+ func WithMarkup(markup keyboard.ReplyMarkup) SendOption

+ type SessionStorage = session.Storage

+ type StateManager interface

+ ClearState func(ctx context.Context, chatID, userID int64) error

+ GetState func(ctx context.Context, chatID, userID int64) (string, error)

+ SetState func(ctx context.Context, chatID, userID int64, state string, ttl time.Duration) error

+ WatchExpired func(ctx context.Context, handler func(chatID, userID int64)) error

+ func NewStateManager(storage fsm.Storage) StateManager

+ type Update struct

+ CallbackQuery *tg.UpdateBotCallbackQuery

+ ChannelMember *tg.UpdateChannelParticipant

+ ChatMember *tg.UpdateChatParticipant

+ InlineQuery *tg.UpdateBotInlineQuery

+ IsOutgoing bool

+ JoinRequest *tg.UpdatePendingJoinRequests

+ Kind UpdateKind

+ Message *tg.Message

+ Raw tg.UpdateClass

+ func (u *Update) ChatID() int64

+ func (u *Update) GetMessage() tg.MessageClass

+ func (u *Update) SenderID() int64

+ type UpdateKind int

+ const KindCallbackQuery

+ const KindChatJoinRequest

+ const KindChatMemberUpdated

+ const KindDeletedMessages

+ const KindEditedMessage

+ const KindInlineQuery

+ const KindMessage

+ const KindRaw

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL