botsfw

package

Go to main page

Versions in this module

v0

v0.9.7

Apr 3, 2023

v0.9.6

Apr 3, 2023

Changes in this version

type BotChat

+ GetAppUserStrID func() string

type BotChatEntity

+ func (e *BotChatEntity) GetAppUserStrID() string

v0.9.5

Apr 3, 2023

v0.9.4

Apr 3, 2023

v0.9.3

Apr 3, 2023

v0.9.2

Apr 3, 2023

v0.9.1

Apr 3, 2023

Changes in this version

type BotUser

+ GetAppUserStrID func() string

v0.9.0

Apr 3, 2023

v0.8.0

Apr 3, 2023

v0.7.0

Apr 3, 2023

Changes in this version

+ const AwaitingReplyToParamsSeparator

+ const AwaitingReplyToPath2QuerySeparator

+ const AwaitingReplyToPathSeparator

+ const BotAPISendMessageOverHTTPS

+ const BotAPISendMessageOverResponse

+ const DefaultTitle

+ const MessageTextBotDidNotUnderstandTheCommand

+ const MessageTextOopsSomethingWentWrong

+ const NoMessageToSend

+ const ShortTitle

+ var ErrEntityNotFound = errors.New("bots-framework: no such entity")

+ var ErrNoCommandsMatched = errors.New("no commands matched")

+ var ErrNotImplemented = errors.New("not implemented")

+ var ErrorIcon = "🚨"

+ var IgnoreCommand = Command

+ var WebhookInputTypeNames = map[WebhookInputType]string

+ func AwaitingReplyToPath(awaitingReplyTo string) string

+ func AwaitingReplyToQuery(awaitingReplyTo string) string

+ func CommandTextNoTrans(title, icon string) string

+ func NewChatID(botID, botChatID string) string

+ func NotFoundHandler(w http.ResponseWriter, r *http.Request, _ httprouter.Params)

+ func PingHandler(w http.ResponseWriter, r *http.Request)

+ func SetAccessGranted(whc WebhookContext, value bool) (err error)

+ type AnalyticsSettings struct

+ Enabled func(r *http.Request) bool

+ GaTrackingID string

+ type Attachment interface

+ AttachmentType func() AttachmentType

+ type AttachmentType int

+ const AttachmentTypeAudio

+ const AttachmentTypeFile

+ const AttachmentTypeImage

+ const AttachmentTypeNone

+ const AttachmentTypeVideo

+ type BaseHandler struct

+ TranslatorProvider TranslatorProvider

+ func (bh *BaseHandler) Register(d WebhookDriver, h BotHost)

+ func (j *BaseHandler) MarshalJSON() ([]byte, error)

+ func (j *BaseHandler) MarshalJSONBuf(buf fflib.EncodingBuffer) error

+ func (j *BaseHandler) UnmarshalJSON(input []byte) error

+ func (j *BaseHandler) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

+ type BotAPISendMessageChannel string

+ type BotAPIUser interface

+ FirstName func() string

+ LastName func() string

+ type BotAppContext interface

+ GetBotChatEntityFactory func(platform string) func() BotChat

+ NewBotAppUserEntity func() BotAppUser

+ type BotAppUser interface

+ GetFullName func() string

+ SetBotUserID func(platform, botID, botUserID string)

+ type BotAppUserStore interface

+ CreateAppUser func(c context.Context, botID string, actor WebhookActor) (appUserID int64, appUserEntity BotAppUser, err error)

+ GetAppUserByID func(c context.Context, appUserID int64, appUser BotAppUser) error

+ type BotChat interface

+ AddClientLanguage func(languageCode string) (changed bool)

+ AddWizardParam func(key, value string)

+ GetAppUserIntID func() int64

+ GetAwaitingReplyTo func() string

+ GetBotID func() string

+ GetGaClientID func() uuid.UUID

+ GetPreferredLanguage func() string

+ GetWizardParam func(key string) string

+ IsAccessGranted func() bool

+ IsAwaitingReplyTo func(code string) bool

+ IsGroupChat func() bool

+ PopStepsFromAwaitingReplyUpToSpecificParent func(code string)

+ PushStepToAwaitingReplyTo func(code string)

+ SetAccessGranted func(value bool) bool

+ SetAppUserIntID func(id int64)

+ SetAwaitingReplyTo func(path string)

+ SetBotID func(botID string)

+ SetBotUserID func(id interface{})

+ SetDtLastInteraction func(time time.Time)

+ SetIsGroupChat func(bool)

+ SetPreferredLanguage func(value string)

+ type BotChatEntity struct

+ AppUserIntIDs []int64

+ AwaitingReplyTo string

+ BotID string

+ DtForbidden time.Time

+ DtForbiddenLast time.Time

+ DtLastInteraction time.Time

+ GaClientID []byte

+ InteractionsCount int

+ IsGroup bool

+ LanguageCodes []string

+ PreferredLanguage string

+ Title string

+ Type string

+ func (e *BotChatEntity) AddClientLanguage(languageCode string) (changed bool)

+ func (e *BotChatEntity) AddWizardParam(key, value string)

+ func (e *BotChatEntity) GetAwaitingReplyTo() string

+ func (e *BotChatEntity) GetBotID() string

+ func (e *BotChatEntity) GetGaClientID() uuid.UUID

+ func (e *BotChatEntity) GetPreferredLanguage() string

+ func (e *BotChatEntity) GetWizardParam(key string) string

+ func (e *BotChatEntity) IsAwaitingReplyTo(code string) bool

+ func (e *BotChatEntity) IsGroupChat() bool

+ func (e *BotChatEntity) PopStepsFromAwaitingReplyUpToSpecificParent(step string)

+ func (e *BotChatEntity) PushStepToAwaitingReplyTo(step string)

+ func (e *BotChatEntity) SetAwaitingReplyTo(value string)

+ func (e *BotChatEntity) SetBotID(botID string)

+ func (e *BotChatEntity) SetBotUserID(id interface{})

+ func (e *BotChatEntity) SetDtLastInteraction(v time.Time)

+ func (e *BotChatEntity) SetDtUpdateToNow()

+ func (e *BotChatEntity) SetIsGroupChat(v bool)

+ func (e *BotChatEntity) SetPreferredLanguage(value string)

+ type BotChatStore interface

+ Close func(c context.Context) error

+ GetBotChatEntityByID func(c context.Context, botID, botChatID string) (BotChat, error)

+ NewBotChatEntity func(c context.Context, botID string, botChat WebhookChat, appUserID int64, ...) BotChat

+ SaveBotChat func(c context.Context, botID, botChatID string, chatEntity BotChat) error

+ type BotContext struct

+ BotHost BotHost

+ BotSettings BotSettings

+ func NewBotContext(host BotHost, settings BotSettings) *BotContext

+ type BotCoreStores struct

+ type BotDriver struct

+ Analytics AnalyticsSettings

+ func (d BotDriver) HandleWebhook(w http.ResponseWriter, r *http.Request, webhookHandler WebhookHandler)

+ func (d BotDriver) RegisterWebhookHandlers(httpRouter *httprouter.Router, pathPrefix string, ...)

+ type BotEntity struct

+ AccessGranted bool

+ func (e *BotEntity) IsAccessGranted() bool

+ func (e *BotEntity) SetAccessGranted(value bool) bool

+ type BotHost interface

+ Context func(r *http.Request) context.Context

+ DB func() dal.Database

+ GetBotCoreStores func(platform string, appContext BotAppContext, r *http.Request) BotCoreStores

+ GetHTTPClient func(c context.Context) *http.Client

+ type BotInputProvider interface

+ Input func() WebhookInput

+ type BotMessage interface

+ BotMessageType func() BotMessageType

+ type BotMessageType int

+ const BotMessageTypeCallbackAnswer

+ const BotMessageTypeEditMessage

+ const BotMessageTypeExportChatInviteLink

+ const BotMessageTypeInlineResults

+ const BotMessageTypeLeaveChat

+ const BotMessageTypeText

+ const BotMessageTypeUndefined

+ type BotPlatform interface

+ ID func() string

+ Version func() string

+ type BotSettings struct

+ Code string

+ Env strongo.Environment

+ GAToken string

+ ID string

+ Locale strongo.Locale

+ PaymentTestToken string

+ PaymentToken string

+ Profile string

+ Router WebhooksRouter

+ Token string

+ VerifyToken string

+ func NewBotSettings(mode strongo.Environment, profile, code, id, token, gaToken string, ...) BotSettings

+ type BotState interface

+ IsNewerThen func(chatEntity BotChat) bool

+ type BotUser interface

+ GetAppUserIntID func() int64

+ IsAccessGranted func() bool

+ SetAccessGranted func(value bool) bool

+ SetAppUserIntID func(appUserID int64)

+ type BotUserEntity struct

+ FirstName string

+ LastName string

+ UserName string

+ type BotUserStore interface

+ CreateBotUser func(c context.Context, botID string, apiUser WebhookActor) (BotUser, error)

+ GetBotUserByID func(c context.Context, botUserID interface{}) (BotUser, error)

+ SaveBotUser func(c context.Context, botUserID interface{}, botUserEntity BotUser) error

+ type CallbackAction func(whc WebhookContext, callbackUrl *url.URL) (m MessageFromBot, err error)

+ type ChatIntID int64

+ func (chatUID ChatIntID) ChatUID() string

+ type ChatUID interface

+ ChatUID func() string

+ type Command struct

+ Action CommandAction

+ CallbackAction CallbackAction

+ Code string

+ Commands []string

+ ExactMatch string

+ Icon string

+ InputTypes []WebhookInputType

+ Matcher CommandMatcher

+ Replies []Command

+ Title string

+ Titles map[string]string

+ func NewCallbackCommand(code string, action CallbackAction) Command

+ func NewInlineQueryCommand(code string, action CommandAction) Command

+ func (c Command) DefaultTitle(whc WebhookContext) string

+ func (c Command) String() string

+ func (c Command) TitleByKey(key string, whc WebhookContext) string

+ type CommandAction func(whc WebhookContext) (m MessageFromBot, err error)

+ type CommandMatcher func(Command, WebhookContext) bool

+ type EntryInput struct

+ Entry WebhookEntry

+ Input WebhookInput

+ func (j *EntryInput) MarshalJSON() ([]byte, error)

+ func (j *EntryInput) MarshalJSONBuf(buf fflib.EncodingBuffer) error

+ func (j *EntryInput) UnmarshalJSON(input []byte) error

+ func (j *EntryInput) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

+ type EntryInputs struct

+ Entry WebhookEntry

+ Inputs []WebhookInput

+ func (j *EntryInputs) MarshalJSON() ([]byte, error)

+ func (j *EntryInputs) MarshalJSONBuf(buf fflib.EncodingBuffer) error

+ func (j *EntryInputs) UnmarshalJSON(input []byte) error

+ func (j *EntryInputs) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

+ type ErrAuthFailed string

+ func (e ErrAuthFailed) Error() string

+ type GaContext interface

+ GaCommon func() gamp.Common

+ GaEvent func(category, action string) *gamp.Event

+ GaEventWithLabel func(category, action, label string) *gamp.Event

+ type GaQueuer interface

+ Queue func(message gamp.Message) error

+ type InputMessage interface

+ Text func() string

+ type Keyboard interface

+ KeyboardType func() KeyboardType

+ type KeyboardType int

+ const KeyboardTypeBottom

+ const KeyboardTypeForceReply

+ const KeyboardTypeHide

+ const KeyboardTypeInline

+ const KeyboardTypeNone

+ type MessageFormat int

+ const MessageFormatHTML

+ const MessageFormatMarkdown

+ const MessageFormatText

+ type MessageFromBot struct

+ BotMessage BotMessage

+ FbmAttachment *fbmbotapi.RequestAttachment

+ ToChat ChatUID

+ func (j *MessageFromBot) MarshalJSON() ([]byte, error)

+ func (j *MessageFromBot) MarshalJSONBuf(buf fflib.EncodingBuffer) error

+ func (j *MessageFromBot) UnmarshalJSON(input []byte) error

+ func (j *MessageFromBot) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

+ type MessageUID interface

+ UID func() string

+ type MessengerResponse interface

+ type OnMessageSentResponse struct

+ StatusCode int

+ TelegramMessage MessengerResponse

+ type SettingsBy struct

+ ByAPIToken map[string]BotSettings

+ ByCode map[string]BotSettings

+ ByID map[string]BotSettings

+ ByLocale map[string][]BotSettings

+ HasRouter bool

+ func NewBotSettingsBy(router func(profile string) WebhooksRouter, bots ...BotSettings) SettingsBy

+ type SettingsProvider func(c context.Context) SettingsBy

+ type TextMessageFromBot struct

+ DisableNotification bool

+ DisableWebPagePreview bool

+ EditMessageUID MessageUID

+ Format MessageFormat

+ IsEdit bool

+ Keyboard Keyboard

+ Text string

+ func (j *TextMessageFromBot) MarshalJSON() ([]byte, error)

+ func (j *TextMessageFromBot) MarshalJSONBuf(buf fflib.EncodingBuffer) error

+ func (j *TextMessageFromBot) UnmarshalJSON(input []byte) error

+ func (j *TextMessageFromBot) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

+ func (m TextMessageFromBot) BotMessageType() BotMessageType

+ type TranslatorProvider func(c context.Context) strongo.Translator

+ type TypeCommands struct

+ type WebhookActor interface

+ GetFirstName func() string

+ GetID func() interface{}

+ GetLanguage func() string

+ GetLastName func() string

+ GetUserName func() string

+ IsBotUser func() bool

+ Platform func() string

+ type WebhookAttachment interface

+ PayloadUrl func() string

+ Type func() string

+ type WebhookAudioMessage interface

+ type WebhookCallbackQuery interface

+ Chat func() WebhookChat

+ GetData func() string

+ GetFrom func() WebhookSender

+ GetID func() string

+ GetInlineMessageID func() string

+ GetMessage func() WebhookMessage

+ type WebhookChat interface

+ GetID func() string

+ GetType func() string

+ IsGroupChat func() bool

+ type WebhookChosenInlineResult interface

+ GetFrom func() WebhookSender

+ GetInlineMessageID func() string

+ GetQuery func() string

+ GetResultID func() string

+ type WebhookContactMessage interface

+ FirstName func() string

+ LastName func() string

+ PhoneNumber func() string

+ UserID func() interface{}

+ type WebhookContext interface

+ AppUserIntID func() int64

+ AppUserStrID func() string

+ BotAppContext func() BotAppContext

+ BotContext func() BotContext

+ BotPlatform func() BotPlatform

+ ChatEntity func() BotChat

+ CommandText func(title, icon string) string

+ Context func() context.Context

+ Environment func() strongo.Environment

+ ExecutionContext func() strongo.ExecutionContext

+ GA func() GaContext

+ GetAppUser func() (BotAppUser, error)

+ GetBotCode func() string

+ GetBotSettings func() BotSettings

+ GetBotToken func() string

+ IsInGroup func() bool

+ MustBotChatID func() string

+ NewEditMessage func(text string, format MessageFormat) (MessageFromBot, error)

+ NewMessage func(text string) MessageFromBot

+ NewMessageByCode func(messageCode string, a ...interface{}) MessageFromBot

+ Request func() *http.Request

+ Responder func() WebhookResponder

+ SetContext func(c context.Context)

+ SetLocale func(code5 string) error

+ UpdateLastProcessed func(chatEntity BotChat) error

+ type WebhookContextBase struct

+ BotUserKey *datastore.Key

+ func NewWebhookContextBase(r *http.Request, botAppContext BotAppContext, botPlatform BotPlatform, ...) *WebhookContextBase

+ func (whcb *WebhookContextBase) AppUserEntity() BotAppUser

+ func (whcb *WebhookContextBase) AppUserIntID() (appUserIntID int64)

+ func (whcb *WebhookContextBase) AppUserStrID() string

+ func (whcb *WebhookContextBase) BotAppContext() BotAppContext

+ func (whcb *WebhookContextBase) BotChatID() (botChatID string, err error)

+ func (whcb *WebhookContextBase) BotContext() BotContext

+ func (whcb *WebhookContextBase) BotPlatform() BotPlatform

+ func (whcb *WebhookContextBase) Chat() WebhookChat

+ func (whcb *WebhookContextBase) ChatEntity() BotChat

+ func (whcb *WebhookContextBase) CommandText(title, icon string) string

+ func (whcb *WebhookContextBase) Context() context.Context

+ func (whcb *WebhookContextBase) Environment() strongo.Environment

+ func (whcb *WebhookContextBase) ExecutionContext() strongo.ExecutionContext

+ func (whcb *WebhookContextBase) GA() GaContext

+ func (whcb *WebhookContextBase) GetAppUser() (BotAppUser, error)

+ func (whcb *WebhookContextBase) GetBotCode() string

+ func (whcb *WebhookContextBase) GetBotSettings() BotSettings

+ func (whcb *WebhookContextBase) GetBotToken() string

+ func (whcb *WebhookContextBase) GetOrCreateBotUserEntityBase() (BotUser, error)

+ func (whcb *WebhookContextBase) GetRecipient() WebhookRecipient

+ func (whcb *WebhookContextBase) GetSender() WebhookSender

+ func (whcb *WebhookContextBase) GetTime() time.Time

+ func (whcb *WebhookContextBase) HasChatEntity() bool

+ func (whcb *WebhookContextBase) Input() WebhookInput

+ func (whcb *WebhookContextBase) InputType() WebhookInputType

+ func (whcb *WebhookContextBase) IsInGroup() bool

+ func (whcb *WebhookContextBase) IsInTransaction(c context.Context) bool

+ func (whcb *WebhookContextBase) Locale() strongo.Locale

+ func (whcb *WebhookContextBase) LogRequest()

+ func (whcb *WebhookContextBase) MessageText() string

+ func (whcb *WebhookContextBase) MustBotChatID() (chatID string)

+ func (whcb *WebhookContextBase) NewMessage(text string) (m MessageFromBot)

+ func (whcb *WebhookContextBase) NewMessageByCode(messageCode string, a ...interface{}) (m MessageFromBot)

+ func (whcb *WebhookContextBase) NonTransactionalContext(tc context.Context) context.Context

+ func (whcb *WebhookContextBase) Request() *http.Request

+ func (whcb *WebhookContextBase) RunReadonlyTransaction(c context.Context, f dal.ROTxWorker, options ...dal.TransactionOption) error

+ func (whcb *WebhookContextBase) RunReadwriteTransaction(c context.Context, f dal.RWTxWorker, options ...dal.TransactionOption) error

+ func (whcb *WebhookContextBase) SetChatEntity(chatEntity BotChat)

+ func (whcb *WebhookContextBase) SetChatID(v string)

+ func (whcb *WebhookContextBase) SetContext(c context.Context)

+ func (whcb *WebhookContextBase) SetLocale(code5 string) error

+ func (whcb *WebhookContextBase) Translate(key string, args ...interface{}) string

+ func (whcb *WebhookContextBase) TranslateNoWarning(key string, args ...interface{}) string

+ type WebhookConversationStarted interface

+ ConversationStartedMessage func() interface{}

+ type WebhookDelivery interface

+ Payload func() string

+ type WebhookDriver interface

+ HandleWebhook func(w http.ResponseWriter, r *http.Request, webhookHandler WebhookHandler)

+ RegisterWebhookHandlers func(httpRouter *httprouter.Router, pathPrefix string, ...)

+ func NewBotDriver(gaSettings AnalyticsSettings, appContext BotAppContext, host BotHost, ...) WebhookDriver

+ type WebhookEntry interface

+ GetID func() interface{}

+ GetTime func() time.Time

+ type WebhookHandler interface

+ CreateBotCoreStores func(appContext BotAppContext, r *http.Request) BotCoreStores

+ CreateWebhookContext func(appContext BotAppContext, r *http.Request, botContext BotContext, ...) WebhookContext

+ GetBotContextAndInputs func(c context.Context, r *http.Request) (botContext *BotContext, entriesWithInputs []EntryInputs, err error)

+ GetResponder func(w http.ResponseWriter, whc WebhookContext) WebhookResponder

+ HandleUnmatched func(whc WebhookContext) (m MessageFromBot)

+ HandleWebhookRequest func(w http.ResponseWriter, r *http.Request, params httprouter.Params)

+ RegisterHttpHandlers func(driver WebhookDriver, botHost BotHost, router *httprouter.Router, ...)

+ type WebhookInlineQuery interface

+ GetFrom func() WebhookSender

+ GetID func() interface{}

+ GetInlineQueryID func() string

+ GetOffset func() string

+ GetQuery func() string

+ type WebhookInlineQueryContext interface

+ type WebhookInput interface

+ BotChatID func() (string, error)

+ Chat func() WebhookChat

+ GetRecipient func() WebhookRecipient

+ GetSender func() WebhookSender

+ GetTime func() time.Time

+ InputType func() WebhookInputType

+ LogRequest func()

+ type WebhookInputType int

+ const WebhookInputAttachment

+ const WebhookInputAudio

+ const WebhookInputCallbackQuery

+ const WebhookInputChosenInlineResult

+ const WebhookInputContact

+ const WebhookInputConversationStarted

+ const WebhookInputDelivery

+ const WebhookInputInlineQuery

+ const WebhookInputLeftChatMembers

+ const WebhookInputNewChatMembers

+ const WebhookInputNotImplemented

+ const WebhookInputPhoto

+ const WebhookInputPostback

+ const WebhookInputReferral

+ const WebhookInputSticker

+ const WebhookInputSubscribed

+ const WebhookInputText

+ const WebhookInputUnknown

+ const WebhookInputUnsubscribed

+ const WebhookInputVoice

+ type WebhookLeftChatMembersMessage interface

+ BotChatID func() (string, error)

+ LeftChatMembers func() []WebhookActor

+ type WebhookMessage interface

+ Chat func() WebhookChat

+ IntID func() int64

+ StringID func() string

+ type WebhookNewChatMembersMessage interface

+ BotChatID func() (string, error)

+ NewChatMembers func() []WebhookActor

+ type WebhookNewContext struct

+ type WebhookPhotoMessage interface

+ type WebhookPostback interface

+ Payload func() string

+ PostbackMessage func() interface{}

+ type WebhookRecipient interface

+ type WebhookReferralMessage interface

+ RefData func() string

+ Source func() string

+ Type func() string

+ type WebhookResponder interface

+ SendMessage func(c context.Context, m MessageFromBot, channel BotAPISendMessageChannel) (OnMessageSentResponse, error)

+ type WebhookSender interface

+ GetAvatar func() string

+ type WebhookStickerMessage interface

+ type WebhookSubscribed interface

+ SubscribedMessage func() interface{}

+ type WebhookTextMessage interface

+ IsEdited func() bool

+ Text func() string

+ type WebhookUnsubscribed interface

+ UnsubscribedMessage func() interface{}

+ type WebhookUser interface

+ GetCountry func() string

+ type WebhookVoiceMessage interface

+ type WebhooksRouter struct

+ func NewWebhookRouter(commandsByType map[WebhookInputType][]Command, errorFooterText func() string) WebhooksRouter

+ func (router *WebhooksRouter) AddCommands(commandsType WebhookInputType, commands []Command)

+ func (router *WebhooksRouter) Dispatch(webhookHandler WebhookHandler, responder WebhookResponder, whc WebhookContext)

+ func (router *WebhooksRouter) DispatchInlineQuery(responder WebhookResponder)

+ func (router *WebhooksRouter) RegisterCommands(commands []Command)

+ func (router WebhooksRouter) CommandsCount() int

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL