telebot

Documentation

Index

• Constants
• func ToContext(ctx context.Context, client *Client) context.Context
• type Action
  • func ErrorMiddleware(next Action) Action
  • func LangMiddleware(next Action) Action
• type Client
  • func FromContext(ctx context.Context) *Client
  • func New(configs Configs) *Client
  • func (c *Client) Command(cmd Command)
  • func (c *Client) DelState(ctx context.Context, chatID int64) error
  • func (c *Client) Event(on telegram.UpdateType, event Event)
  • func (c *Client) GetSession(ctx context.Context, chatID int64, data any) error
  • func (c *Client) GetState(ctx context.Context, chatID int64, state *State) error
  • func (c *Client) Middleware(middleware ...Middleware)
  • func (c *Client) Run(ctx context.Context) error
  • func (c *Client) SetSession(ctx context.Context, chatID int64, data any) error
  • func (c *Client) SetState(ctx context.Context, chatID int64, state *State) error
• type Command
• type Configs
• type Event
• type InlineKeyboard
  • func NewInlineKeyboard() *InlineKeyboard
  • func (k *InlineKeyboard) AddCol(button telegram.InlineKeyboardButton) *InlineKeyboard
  • func (k *InlineKeyboard) AddRow(button telegram.InlineKeyboardButton) *InlineKeyboard
  • func (k *InlineKeyboard) Render() telegram.KeyboardMarkup
• type Keyword
  • func (k Keyword) String() string
• type Middleware
  • func ActionMiddleware(action telegram.Action) Middleware
• type ReplyKeyboard
  • func NewReplyKeyboard() *ReplyKeyboard
  • func (k *ReplyKeyboard) AddCol(button telegram.KeyboardButton) *ReplyKeyboard
  • func (k *ReplyKeyboard) AddRow(button telegram.KeyboardButton) *ReplyKeyboard
  • func (k *ReplyKeyboard) Render() telegram.KeyboardMarkup
• type Route
• type State

Constants

const (
	Name = "telebot"
)

Functions

func ToContext

func ToContext(ctx context.Context, client *Client) context.Context

Types

type Action

type Action func(ctx context.Context, update telegram.Update) (Keyword, error)

func ErrorMiddleware

func ErrorMiddleware(next Action) Action

func LangMiddleware

func LangMiddleware(next Action) Action

type Client

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

func FromContext

func FromContext(ctx context.Context) *Client

func New

func New(configs Configs) *Client

func (*Client) Command

func (c *Client) Command(cmd Command)

func (*Client) DelState

func (c *Client) DelState(ctx context.Context, chatID int64) error

func (*Client) Event

func (c *Client) Event(on telegram.UpdateType, event Event)

func (*Client) GetSession

func (c *Client) GetSession(ctx context.Context, chatID int64, data any) error

func (*Client) GetState

func (c *Client) GetState(ctx context.Context, chatID int64, state *State) error

func (*Client) Middleware

func (c *Client) Middleware(middleware ...Middleware)

func (*Client) Run

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

func (*Client) SetSession

func (c *Client) SetSession(ctx context.Context, chatID int64, data any) error

func (*Client) SetState

func (c *Client) SetState(ctx context.Context, chatID int64, state *State) error

type Command

type Command interface {
	Name() Keyword
	Alias() []Keyword
	Actions() map[Keyword]Route
	Init(ctx context.Context, update telegram.Update) (Keyword, error)
}

type Configs

type Configs struct {
	TelegramStoragePrefix string        `env:"TELEGRAM_STORAGE_PREFIX" envDefault:"telegram"`
	TelegramPullInterval  time.Duration `env:"TELEGRAM_PULL_INTERVAL" envDefault:"30s"`
	TelegramConcurrency   uint8         `env:"TELEGRAM_CONCURRENCY" envDefault:"10"`
}

type Event

type Event func(ctx context.Context, update telegram.Update) error

type InlineKeyboard

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

func NewInlineKeyboard

func NewInlineKeyboard() *InlineKeyboard

func (*InlineKeyboard) AddCol

func (k *InlineKeyboard) AddCol(button telegram.InlineKeyboardButton) *InlineKeyboard

func (*InlineKeyboard) AddRow

func (k *InlineKeyboard) AddRow(button telegram.InlineKeyboardButton) *InlineKeyboard

func (*InlineKeyboard) Render

func (k *InlineKeyboard) Render() telegram.KeyboardMarkup

type Keyword

type Keyword string

const (
	Empty Keyword = ""
)

func (Keyword) String

func (k Keyword) String() string

type Middleware

type Middleware func(next Action) Action

func ActionMiddleware

func ActionMiddleware(action telegram.Action) Middleware

type ReplyKeyboard

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

func NewReplyKeyboard

func NewReplyKeyboard() *ReplyKeyboard

func (*ReplyKeyboard) AddCol

func (k *ReplyKeyboard) AddCol(button telegram.KeyboardButton) *ReplyKeyboard

func (*ReplyKeyboard) AddRow

func (k *ReplyKeyboard) AddRow(button telegram.KeyboardButton) *ReplyKeyboard

func (*ReplyKeyboard) Render

func (k *ReplyKeyboard) Render() telegram.KeyboardMarkup

type Route

type Route struct {
	Action       Action
	AllowUpdates []telegram.UpdateType
}

type State

type State struct {
	Command   Keyword  `json:"command,omitempty"`
	Action    Keyword  `json:"action,omitempty"`
	Arguments []string `json:"arguments,omitempty"`
}