tgfun

Documentation

Index

• type EventMessage
• type Funnel
  • func NewFunnel(data FunnelData, script FunnelScript) (*Funnel, error)
  • func (f *Funnel) Run() error
• type FunnelData
• type FunnelEvent
• type FunnelScript
• type MessageButton

Types

type EventMessage

type EventMessage struct {
	//ID      string          `json:"id"`
	Text    string          `json:"text"`
	Image   string          `json:"image"`   // local filename or URL. optional
	Buttons []MessageButton `json:"buttons"` // optional
}

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, error)

NewFunnel - funnel constructor

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"`
}

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