bot

Documentation

Index

• type Bot
  • func New(botAPI *telegram.BotAPI, state types.StateProvider, ...) *Bot
  • func NewFromSpec(s *spec.Bot) (*Bot, error)
  • func NewWithOptions(botAPI *telegram.BotAPI, opts ...Option) *Bot
  • func (b *Bot) ApiHandler(id string, h api.Handler)
  • func (b *Bot) Handle(filter types.EventFilter, h types.Handler)
  • func (b *Bot) HandleUpdate(ctx context.Context, upd *telegram.Update)
  • func (b *Bot) HandleUpdateErr(ctx context.Context, upd *telegram.Update) error
  • func (b *Bot) HandleWithData(filter types.EventFilter, h types.Handler, dl types.DataLoader)
  • func (b *Bot) HandlerAPI(cfg api.Config) *api.Service
  • func (b *Bot) SetupApiHandlersFromSpec(src []*spec.ApiHandler) error
  • func (b *Bot) SetupHandlersFromSpec(src []*spec.Handler) error
  • func (b *Bot) Start() error
  • func (b *Bot) Stop() error
• type Option
  • func WithAPIAddr(addr string) Option
  • func WithAssets(assets types.Assets) Option
  • func WithContextProvider(cp types.ContextProvider) Option
  • func WithHTTPClient(cli *http.Client) Option
  • func WithLogger(log zerolog.Logger) Option
  • func WithPaymentProviders(payments types.PaymentProviders) Option
  • func WithSecrets(secrets types.Secrets) Option
  • func WithStateProvider(sp types.StateProvider) Option

Types

type Bot

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

Bot is a main bot instance.

func New

func New(botAPI *telegram.BotAPI, state types.StateProvider,
	context types.ContextProvider, assets types.Assets,
	paymentProviders types.PaymentProviders, secrets types.Secrets,
	apiAddr string, log zerolog.Logger,
) *Bot

New creates a new bot instance with default values for empty options. deprecated: use NewWithOptions instead

func NewFromSpec

func NewFromSpec(s *spec.Bot) (*Bot, error)

func NewWithOptions

func NewWithOptions(botAPI *telegram.BotAPI, opts ...Option) *Bot

NewWithOptions creates a new bot instance with options or default values for empty options.

func (*Bot) ApiHandler

func (b *Bot) ApiHandler(id string, h api.Handler)

func (*Bot) Handle

func (b *Bot) Handle(filter types.EventFilter, h types.Handler)

func (*Bot) HandleUpdate

func (b *Bot) HandleUpdate(ctx context.Context, upd *telegram.Update)

HandleUpdate handles telegram update and log error if any. Deprecated: use HandleUpdateErr instead, in next major release HandlerUpdateErr will be renamed to HandleUpdate.

func (*Bot) HandleUpdateErr

func (b *Bot) HandleUpdateErr(ctx context.Context, upd *telegram.Update) error

HandleUpdateErr handles telegram update and returns error if any.

func (*Bot) HandleWithData

func (b *Bot) HandleWithData(filter types.EventFilter, h types.Handler, dl types.DataLoader)

func (*Bot) HandlerAPI

func (b *Bot) HandlerAPI(cfg api.Config) *api.Service

func (*Bot) SetupApiHandlersFromSpec

func (b *Bot) SetupApiHandlersFromSpec(src []*spec.ApiHandler) error

func (*Bot) SetupHandlersFromSpec

func (b *Bot) SetupHandlersFromSpec(src []*spec.Handler) error

func (*Bot) Start

func (b *Bot) Start() error

func (*Bot) Stop

func (b *Bot) Stop() error

type Option

type Option func(*Bot)

Option is a functional option for Bot.

func WithAPIAddr

func WithAPIAddr(addr string) Option

WithAPIAddr option sets API address for bot.

func WithAssets

func WithAssets(assets types.Assets) Option

WithAssets option sets assets provider for bot.

func WithContextProvider

func WithContextProvider(cp types.ContextProvider) Option

WithContextProvider option sets context provider for bot.

func WithHTTPClient

func WithHTTPClient(cli *http.Client) Option

WithHTTPClient option sets HTTP client for bot.

func WithLogger

func WithLogger(log zerolog.Logger) Option

WithLogger option sets logger for bot.

func WithPaymentProviders

func WithPaymentProviders(payments types.PaymentProviders) Option

WithPaymentProviders option sets payment providers for bot.

func WithSecrets

func WithSecrets(secrets types.Secrets) Option

WithSecrets option sets secrets provider for bot.

func WithStateProvider

func WithStateProvider(sp types.StateProvider) Option

WithStateProvider option sets state provider for bot.