list

package

v0.0.0-...-516d34e Latest Latest Go to latest Published: Jun 11, 2023 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var (
	ErrInvalidTextPath = errors.New("invalid paths")
	ErrInvalidLanguage = errors.New("locale does not exist")
)

This section is empty.

type Callback func(list *List, path string, c *tb.Message) bool

Callback that triggers when a user sends an item from the list if the function returns true - the user is being evicted from the active sessions

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

List is a set of prepared replies in a selected language that is able to perform a callback when a user selects an answer from the list

func NewListFlow(id string, textEngine *tr.Engine, bot *tb.Bot, callback Callback, textPaths ...string) (*List, error)

Creates a new list

func (l *List) Build(lang string) *List

Builds markups for a specific locale

func (l *List) GetBot() *tb.Bot

Get attached Telegram bot

func (l *List) GetId() string

Get list's unique identificator

func (l *List) GetMarkup(lang string) *tb.ReplyMarkup

Gets a built markup in a specified language

func (l *List) GetSession(of tb.Recipient) (string, bool)

Retrieves a session language by recipient

func (l *List) Start(to tb.Recipient, textPath, language string) error

Starts a list flow for the user

func (l *List) StartWithText(to tb.Recipient, text, language string) error

Starts a list flow for the user with a custom text