tgfun

README

tgfun

Documentation

Index

• type BuildMessageCallback
• type EventMessage
• type Funnel
  • func NewFunnel(data FunnelData, script FunnelScript) *Funnel
  • func (f *Funnel) EnableUsersFeature(feature UsersFeature)
  • func (f *Funnel) Run() error
• type FunnelData
• type FunnelEvent
• type FunnelScript
• type MessageButton
• type OnEventCallback
• type UsersFeature

Types

type BuildMessageCallback

type BuildMessageCallback func(tb.Context) interface{}

type EventMessage

type EventMessage struct {
	// main data
	Text  string `json:"text"`
	Image string `json:"image"` // local filename or URL. optional

	// instead of main data
	Callback BuildMessageCallback `json:"-"` // use it to redefine message

	// additional events
	OnEvent OnEventCallback `json:"-"`

	// optional
	Buttons          []MessageButton `json:"buttons"` // optional
	ButtonsIsColumns bool            `json:"buttonsIsColumns"`
	IsCTA            bool            `json:"isCTA"`
	OnCTA            OnEventCallback `json:"-"`
}

EventMessage - funnel event message data

type Funnel

type Funnel struct {
	// public
	Data   FunnelData
	Script FunnelScript
	// contains filtered or unexported fields
}

Funnel - telegram bot funnel

func NewFunnel

func NewFunnel(data FunnelData, script FunnelScript) *Funnel

NewFunnel - funnel constructor

func (*Funnel) EnableUsersFeature

func (f *Funnel) EnableUsersFeature(feature UsersFeature)

EnableUsersFeature !

func (*Funnel) Run

func (f *Funnel) Run() error

Run funnel. This is a non-blocking operation

type FunnelData

type FunnelData struct {
	Token     string `json:"token"`
	ImageRoot string `json:"imageRoot"`
}

FunnelData - data container for Funnel struct

type FunnelEvent

type FunnelEvent struct {
	Message EventMessage `json:"message"`
}

FunnelEvent - user interaction event

type FunnelScript

type FunnelScript map[string]FunnelEvent // message ID -> event

FunnelScript - funnel scenario

type MessageButton

type MessageButton struct {
	Text          string `json:"text"`
	NextMessageID string `json:"nextID"` // optional for URL-buttons
	URL           string `json:"url"`    // optional. only for URL-buttons
}

MessageButton - funnel event message button

type OnEventCallback

type OnEventCallback func(tb.Context) error

type UsersFeature

type UsersFeature struct {
	// required
	DBConn    *sql.DB
	TableName string

	// optional
	AdminChatID int64
}

UsersFeature - feature to enable users db