types

Documentation

Overview

Package types provides base public types used by bot.

Index

• type Assets
• type Bot
• type ChatID
  • func (cid ChatID) Int64() int64
  • func (cid ChatID) String() string
• type Context
• type ContextProvider
• type DataContainer
  • func (c *DataContainer) Get() any
  • func (c *DataContainer) Set(data any)
• type DataLoader
• type EventFilter
• type Handler
• type PaymentProviders
• type Secret
  • func (s Secret) String() string
  • func (s Secret) Value() string
• type Secrets
• type State
• type StateChanges
  • func (s *StateChanges) IsEmpty() bool
• type StateOp
• type StateProvider

Types

type Assets

type Assets interface {
	// LoadAsset loads the asset with the given key.
	LoadAsset(ctx context.Context, key string) (io.ReadCloser, error)
}

Assets provider interface.

type Bot

type Bot interface {
	// Handle register bot's handler with filter.
	Handle(EventFilter, Handler)

	// Start bot.
	Start() error

	// Stop bot.
	Stop() error
}

Bot instance.

type ChatID

type ChatID int64

ChatID is a chat identifier.

func (ChatID) Int64

func (cid ChatID) Int64() int64

func (ChatID) String

func (cid ChatID) String() string

type Context

type Context interface {

	// Set context value.
	Set(ctx.Context, string) error

	// Reset context.
	Reset(ctx.Context) error

	// Check context value.
	Check(ctx.Context, string) (bool, error)
}

type ContextProvider

type ContextProvider interface {
	UserContext(ChatID) Context
}

type DataContainer

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

func (*DataContainer) Get

func (c *DataContainer) Get() any

func (*DataContainer) Set

func (c *DataContainer) Set(data any)

type DataLoader

type DataLoader interface {
	Load(ctx context.Context, c *DataContainer, upd *telegram.Update) error
}

type EventFilter

type EventFilter interface {
	Check(context.Context, *telegram.Update) (bool, error)
}

EventFilter checks that telegram update could be handlerd.

type Handler

type Handler interface {
	// Handle update message.
	// telegram.BotAPI is deprecated and will be removed in future versions.
	Handle(context.Context, *telegram.Update, *telegram.BotAPI) error
}

Handler of telegram update message.

type PaymentProviders

type PaymentProviders interface {
	PaymentToken(name string) string
}

type Secret

type Secret string

Secret is a string that should not be printed

func (Secret) String

func (s Secret) String() string

func (Secret) Value

func (s Secret) Value() string

type Secrets

type Secrets interface {
	// Get secret map, returns error if not found.
	Get(ctx context.Context) (map[string]Secret, error)
}

Secrets is a collection of secrets.

type State

type State interface {
	Get(key string) (string, bool)
	Set(key, value string)
	Delete(key string)
	Map() map[string]string
	Fill(map[string]string)
	Changes() StateChanges
}

type StateChanges

type StateChanges struct {
	Added   []string
	Removed []string
}

func (*StateChanges) IsEmpty

func (s *StateChanges) IsEmpty() bool

type StateOp

type StateOp interface {
	Apply(State, ...func(string) string) error
}

type StateProvider

type StateProvider interface {
	Load(context.Context, ChatID, State) error
	Update(context.Context, ChatID, State) error
}