Documentation
¶
Overview ¶
Package handlers provides a type-safe way to register and manage event handlers.
Index ¶
- type BusinessConnectionHandler
- type CallbackQueryHandler
- type CallbackQueryMatcher
- type ChatBoostHandler
- type ChatJoinRequestHandler
- type ChatMemberHandler
- type ChosenInlineResultHandler
- type CommandHandler
- type CommandMatcher
- type DeletedBusinessMessagesHandler
- type InlineQueryHandler
- type ManagedBotHandler
- type MessageHandler
- type MessageMatcher
- type MessageReactionCountHandler
- type MessageReactionHandler
- type PollAnswerHandler
- type PollHandler
- type PreCheckoutQueryHandler
- type PurchasedPaidMediaHandler
- type Registry
- func (r *Registry) OnBusinessConnection(handler BusinessConnectionHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnBusinessMessage(handler MessageHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnCallbackData(data string, handler CallbackQueryHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnCallbackDataPrefix(prefix string, handler CallbackQueryHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnCallbackQuery(handler CallbackQueryHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnCallbackQueryMatch(match CallbackQueryMatcher, handler CallbackQueryHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnChannelPost(handler MessageHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnChatBoost(handler ChatBoostHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnChatJoinRequest(handler ChatJoinRequestHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnChatMember(handler ChatMemberHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnChosenInlineResult(handler ChosenInlineResultHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnCommand(handler CommandHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnCommandMatch(match CommandMatcher, handler CommandHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnCommandName(name string, handler CommandHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnDeletedBusinessMessages(handler DeletedBusinessMessagesHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnEditedBusinessMessage(handler MessageHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnEditedChannelPost(handler MessageHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnEditedMessage(handler MessageHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnGuestMessage(handler MessageHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnInlineQuery(handler InlineQueryHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnManagedBot(handler ManagedBotHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnMessage(handler MessageHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnMessageMatch(match MessageMatcher, handler MessageHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnMessageReaction(handler MessageReactionHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnMessageReactionCount(handler MessageReactionCountHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnMessageType(t messagetype.MessageType, handler MessageHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnMyChatMember(handler ChatMemberHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnPoll(handler PollHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnPollAnswer(handler PollAnswerHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnPreCheckoutQuery(handler PreCheckoutQueryHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnPurchasedPaidMedia(handler PurchasedPaidMediaHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnRemovedChatBoost(handler RemovedChatBoostHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnShippingQuery(handler ShippingQueryHandler) eventemitter.UnsubscribeFunc
- func (r *Registry) OnUpdate(handler UpdateHandler) eventemitter.UnsubscribeFunc
- type RemovedChatBoostHandler
- type ShippingQueryHandler
- type UpdateHandler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BusinessConnectionHandler ¶
type BusinessConnectionHandler func(ctx context.Context, event *events.BusinessConnectionEvent) error
BusinessConnectionHandler is a function that handles a business connection event.
type CallbackQueryHandler ¶
type CallbackQueryHandler func(ctx context.Context, event *events.CallbackQueryEvent) error
CallbackQueryHandler is a function that handles a callback query event.
type CallbackQueryMatcher ¶
type CallbackQueryMatcher func(event *events.CallbackQueryEvent) bool
CallbackQueryMatcher reports whether a callback query handler should run for an event.
func CallbackData ¶
func CallbackData(data string) CallbackQueryMatcher
CallbackData matches callback query data by exact value.
func CallbackDataPrefix ¶
func CallbackDataPrefix(prefix string) CallbackQueryMatcher
CallbackDataPrefix matches callback query data by prefix.
type ChatBoostHandler ¶
type ChatBoostHandler func(ctx context.Context, event *events.ChatBoostEvent) error
ChatBoostHandler is a function that handles a chat boost event.
type ChatJoinRequestHandler ¶
type ChatJoinRequestHandler func(ctx context.Context, event *events.ChatJoinRequestEvent) error
ChatJoinRequestHandler is a function that handles a chat join request event.
type ChatMemberHandler ¶
type ChatMemberHandler func(ctx context.Context, event *events.ChatMemberEvent) error
ChatMemberHandler is a function that handles a chat member event.
type ChosenInlineResultHandler ¶
type ChosenInlineResultHandler func(ctx context.Context, event *events.ChosenInlineResultEvent) error
ChosenInlineResultHandler is a function that handles a chosen inline result event.
type CommandHandler ¶
type CommandHandler func(ctx context.Context, event *events.CommandEvent) error
CommandHandler is a function that handles a command event.
type CommandMatcher ¶
type CommandMatcher func(event *events.CommandEvent) bool
CommandMatcher reports whether a command handler should run for an event.
func CommandAny ¶
func CommandAny(names ...string) CommandMatcher
CommandAny matches any of the provided command names.
func CommandName ¶
func CommandName(name string) CommandMatcher
CommandName matches a command by exact name.
type DeletedBusinessMessagesHandler ¶
type DeletedBusinessMessagesHandler func(ctx context.Context, event *events.DeletedBusinessMessagesEvent) error
DeletedBusinessMessagesHandler is a function that handles a deleted business messages event.
type InlineQueryHandler ¶
type InlineQueryHandler func(ctx context.Context, event *events.InlineQueryEvent) error
InlineQueryHandler is a function that handles an inline query event.
type ManagedBotHandler ¶
type ManagedBotHandler func(ctx context.Context, event *events.ManagedBotEvent) error
ManagedBotHandler is a function that handles a managed bot event.
type MessageHandler ¶
type MessageHandler func(ctx context.Context, event *events.MessageEvent) error
MessageHandler is a function that handles a message event.
type MessageMatcher ¶
type MessageMatcher func(event *events.MessageEvent) bool
MessageMatcher reports whether a message handler should run for an event.
func MessageText ¶
func MessageText(text string) MessageMatcher
MessageText matches text messages by exact text.
func MessageTextPrefix ¶
func MessageTextPrefix(prefix string) MessageMatcher
MessageTextPrefix matches text messages by prefix.
func MessageType ¶
func MessageType(t messagetype.MessageType) MessageMatcher
MessageType matches messages by classified message type.
type MessageReactionCountHandler ¶
type MessageReactionCountHandler func(ctx context.Context, event *events.MessageReactionCountEvent) error
MessageReactionCountHandler is a function that handles a message reaction count event.
type MessageReactionHandler ¶
type MessageReactionHandler func(ctx context.Context, event *events.MessageReactionEvent) error
MessageReactionHandler is a function that handles a message reaction event.
type PollAnswerHandler ¶
type PollAnswerHandler func(ctx context.Context, event *events.PollAnswerEvent) error
PollAnswerHandler is a function that handles a poll answer event.
type PollHandler ¶
PollHandler is a function that handles a poll event.
type PreCheckoutQueryHandler ¶
type PreCheckoutQueryHandler func(ctx context.Context, event *events.PreCheckoutQueryEvent) error
PreCheckoutQueryHandler is a function that handles a pre-checkout query event.
type PurchasedPaidMediaHandler ¶
type PurchasedPaidMediaHandler func(ctx context.Context, event *events.PurchasedPaidMediaEvent) error
PurchasedPaidMediaHandler is a function that handles a purchased paid media event.
type Registry ¶
type Registry struct {
// contains filtered or unexported fields
}
Registry manages the subscription of handlers to events.
func NewRegistry ¶
func NewRegistry(em eventemitter.EventEmitter, l logger.Logger) *Registry
NewRegistry creates a new Registry.
func (*Registry) OnBusinessConnection ¶
func (r *Registry) OnBusinessConnection(handler BusinessConnectionHandler) eventemitter.UnsubscribeFunc
OnBusinessConnection registers a handler for business connection events.
func (*Registry) OnBusinessMessage ¶
func (r *Registry) OnBusinessMessage(handler MessageHandler) eventemitter.UnsubscribeFunc
OnBusinessMessage registers a handler for business messages.
func (*Registry) OnCallbackData ¶
func (r *Registry) OnCallbackData(data string, handler CallbackQueryHandler) eventemitter.UnsubscribeFunc
OnCallbackData registers a handler for callback queries with exact data.
func (*Registry) OnCallbackDataPrefix ¶
func (r *Registry) OnCallbackDataPrefix(prefix string, handler CallbackQueryHandler) eventemitter.UnsubscribeFunc
OnCallbackDataPrefix registers a handler for callback queries with data prefix.
func (*Registry) OnCallbackQuery ¶
func (r *Registry) OnCallbackQuery(handler CallbackQueryHandler) eventemitter.UnsubscribeFunc
OnCallbackQuery registers a handler for callback query events.
func (*Registry) OnCallbackQueryMatch ¶
func (r *Registry) OnCallbackQueryMatch( match CallbackQueryMatcher, handler CallbackQueryHandler, ) eventemitter.UnsubscribeFunc
OnCallbackQueryMatch registers a handler for callback queries matching the given predicate.
func (*Registry) OnChannelPost ¶
func (r *Registry) OnChannelPost(handler MessageHandler) eventemitter.UnsubscribeFunc
OnChannelPost registers a handler for channel posts.
func (*Registry) OnChatBoost ¶
func (r *Registry) OnChatBoost(handler ChatBoostHandler) eventemitter.UnsubscribeFunc
OnChatBoost registers a handler for chat boost events.
func (*Registry) OnChatJoinRequest ¶
func (r *Registry) OnChatJoinRequest(handler ChatJoinRequestHandler) eventemitter.UnsubscribeFunc
OnChatJoinRequest registers a handler for chat join request events.
func (*Registry) OnChatMember ¶
func (r *Registry) OnChatMember(handler ChatMemberHandler) eventemitter.UnsubscribeFunc
OnChatMember registers a handler for chat member events.
func (*Registry) OnChosenInlineResult ¶
func (r *Registry) OnChosenInlineResult(handler ChosenInlineResultHandler) eventemitter.UnsubscribeFunc
OnChosenInlineResult registers a handler for chosen inline result events.
func (*Registry) OnCommand ¶
func (r *Registry) OnCommand(handler CommandHandler) eventemitter.UnsubscribeFunc
OnCommand registers a handler for the OnCommand event.
func (*Registry) OnCommandMatch ¶
func (r *Registry) OnCommandMatch(match CommandMatcher, handler CommandHandler) eventemitter.UnsubscribeFunc
OnCommandMatch registers a handler for commands matching the given predicate.
func (*Registry) OnCommandName ¶
func (r *Registry) OnCommandName(name string, handler CommandHandler) eventemitter.UnsubscribeFunc
OnCommandName registers a handler for a specific command name.
func (*Registry) OnDeletedBusinessMessages ¶
func (r *Registry) OnDeletedBusinessMessages(handler DeletedBusinessMessagesHandler) eventemitter.UnsubscribeFunc
OnDeletedBusinessMessages registers a handler for deleted business messages events.
func (*Registry) OnEditedBusinessMessage ¶
func (r *Registry) OnEditedBusinessMessage(handler MessageHandler) eventemitter.UnsubscribeFunc
OnEditedBusinessMessage registers a handler for edited business messages.
func (*Registry) OnEditedChannelPost ¶
func (r *Registry) OnEditedChannelPost(handler MessageHandler) eventemitter.UnsubscribeFunc
OnEditedChannelPost registers a handler for edited channel posts.
func (*Registry) OnEditedMessage ¶
func (r *Registry) OnEditedMessage(handler MessageHandler) eventemitter.UnsubscribeFunc
OnEditedMessage registers a handler for edited messages.
func (*Registry) OnGuestMessage ¶
func (r *Registry) OnGuestMessage(handler MessageHandler) eventemitter.UnsubscribeFunc
OnGuestMessage registers a handler for guest messages.
func (*Registry) OnInlineQuery ¶
func (r *Registry) OnInlineQuery(handler InlineQueryHandler) eventemitter.UnsubscribeFunc
OnInlineQuery registers a handler for inline query events.
func (*Registry) OnManagedBot ¶
func (r *Registry) OnManagedBot(handler ManagedBotHandler) eventemitter.UnsubscribeFunc
OnManagedBot registers a handler for managed bot events.
func (*Registry) OnMessage ¶
func (r *Registry) OnMessage(handler MessageHandler) eventemitter.UnsubscribeFunc
OnMessage registers a handler for the OnMessageReceived event.
func (*Registry) OnMessageMatch ¶
func (r *Registry) OnMessageMatch(match MessageMatcher, handler MessageHandler) eventemitter.UnsubscribeFunc
OnMessageMatch registers a handler for messages matching the given predicate.
func (*Registry) OnMessageReaction ¶
func (r *Registry) OnMessageReaction(handler MessageReactionHandler) eventemitter.UnsubscribeFunc
OnMessageReaction registers a handler for message reaction events.
func (*Registry) OnMessageReactionCount ¶
func (r *Registry) OnMessageReactionCount(handler MessageReactionCountHandler) eventemitter.UnsubscribeFunc
OnMessageReactionCount registers a handler for message reaction count events.
func (*Registry) OnMessageType ¶
func (r *Registry) OnMessageType(t messagetype.MessageType, handler MessageHandler) eventemitter.UnsubscribeFunc
OnMessageType registers a handler for the OnMessageReceived event with a specific message type.
func (*Registry) OnMyChatMember ¶
func (r *Registry) OnMyChatMember(handler ChatMemberHandler) eventemitter.UnsubscribeFunc
OnMyChatMember registers a handler for the bot's chat member events.
func (*Registry) OnPoll ¶
func (r *Registry) OnPoll(handler PollHandler) eventemitter.UnsubscribeFunc
OnPoll registers a handler for poll events.
func (*Registry) OnPollAnswer ¶
func (r *Registry) OnPollAnswer(handler PollAnswerHandler) eventemitter.UnsubscribeFunc
OnPollAnswer registers a handler for poll answer events.
func (*Registry) OnPreCheckoutQuery ¶
func (r *Registry) OnPreCheckoutQuery(handler PreCheckoutQueryHandler) eventemitter.UnsubscribeFunc
OnPreCheckoutQuery registers a handler for pre-checkout query events.
func (*Registry) OnPurchasedPaidMedia ¶
func (r *Registry) OnPurchasedPaidMedia(handler PurchasedPaidMediaHandler) eventemitter.UnsubscribeFunc
OnPurchasedPaidMedia registers a handler for purchased paid media events.
func (*Registry) OnRemovedChatBoost ¶
func (r *Registry) OnRemovedChatBoost(handler RemovedChatBoostHandler) eventemitter.UnsubscribeFunc
OnRemovedChatBoost registers a handler for removed chat boost events.
func (*Registry) OnShippingQuery ¶
func (r *Registry) OnShippingQuery(handler ShippingQueryHandler) eventemitter.UnsubscribeFunc
OnShippingQuery registers a handler for shipping query events.
func (*Registry) OnUpdate ¶
func (r *Registry) OnUpdate(handler UpdateHandler) eventemitter.UnsubscribeFunc
OnUpdate registers a handler for the OnUpdateReceived event.
type RemovedChatBoostHandler ¶
type RemovedChatBoostHandler func(ctx context.Context, event *events.RemovedChatBoostEvent) error
RemovedChatBoostHandler is a function that handles a removed chat boost event.
type ShippingQueryHandler ¶
type ShippingQueryHandler func(ctx context.Context, event *events.ShippingQueryEvent) error
ShippingQueryHandler is a function that handles a shipping query event.
type UpdateHandler ¶
type UpdateHandler func(ctx context.Context, event *events.UpdateEvent) error
UpdateHandler is a function that handles an update event.
Source Files