yao/messenger/types/interfaces.go
Max ffc666c4de Enhance messenger service with message handler registration and webhook processing
- Introduced OnReceive method to register multiple message handlers for processing received messages.
- Added RemoveReceiveHandler method to unregister specific message handlers.
- Implemented TriggerWebhook method to process incoming webhook data and trigger registered handlers.
- Updated existing tests to reflect changes in provider types from 'smtp' to 'mailer' for consistency.
2025-09-28 10:00:38 +08:00

65 lines
2.2 KiB
Go

package types
import "context"
// MessageHandler defines a callback function for handling received messages
type MessageHandler func(ctx context.Context, message *Message) error
// Provider defines the interface for message providers
type Provider interface {
// Send sends a message using the provider
Send(ctx context.Context, message *Message) error
// SendBatch sends multiple messages in batch
SendBatch(ctx context.Context, messages []*Message) error
// Receive processes incoming messages/responses from the provider
Receive(ctx context.Context, data map[string]interface{}) error
// GetType returns the provider type (smtp, twilio, mailgun, etc.)
GetType() string
// GetName returns the provider name/identifier
GetName() string
// Validate validates the provider configuration
Validate() error
// Close closes the provider connection if needed
Close() error
}
// Messenger defines the main messenger interface
type Messenger interface {
// Send sends a message using the specified channel or default provider
Send(ctx context.Context, channel string, message *Message) error
// SendWithProvider sends a message using a specific provider
SendWithProvider(ctx context.Context, providerName string, message *Message) error
// SendBatch sends multiple messages in batch
SendBatch(ctx context.Context, channel string, messages []*Message) error
// GetProvider returns a provider by name
GetProvider(name string) (Provider, error)
// GetProviders returns all providers for a channel type
GetProviders(channelType string) []Provider
// GetChannels returns all available channels
GetChannels() []string
// OnReceive registers a message handler for received messages
// Multiple handlers can be registered and will be called in order
OnReceive(handler MessageHandler) error
// RemoveReceiveHandler removes a previously registered message handler
RemoveReceiveHandler(handler MessageHandler) error
// TriggerWebhook processes incoming webhook data and triggers OnReceive handlers
// This is used by OPENAPI endpoints to handle incoming messages
TriggerWebhook(ctx context.Context, providerName string, data map[string]interface{}) error
// Close closes all provider connections
Close() error
}