Documentation
¶
Index ¶
- Constants
- Variables
- func Bind(app *runtime.App, manager *Manager) error
- func Close() error
- func PhoneKey(req Request) string
- func RegisterDriver(driver string, factory pkgsms.DriverFactory)
- func SetDefault(manager *Manager)
- type AttemptResult
- type Config
- type Manager
- func (m *Manager) Close() error
- func (m *Manager) Config(name string) (pkgsms.ProviderConfig, error)
- func (m *Manager) DefaultName() string
- func (m *Manager) Send(ctx context.Context, to []string, msg Message) (*SendResult, error)
- func (m *Manager) SendVia(ctx context.Context, to []string, msg Message, providers ...string) (*SendResult, error)
- func (m *Manager) Use(name string) (pkgsms.Provider, error)
- func (m *Manager) UseMiddleware(middleware ...Middleware)
- type Message
- type Middleware
- type NoProviderAvailableError
- type Param
- type Payload
- type Provider
- type ProviderConfig
- type ProviderMessage
- type ProviderRequest
- type ProviderResult
- type RateLimitRule
- type RateLimiter
- type Request
- type SendResult
- type Sender
- type SenderFunc
- type TemplateMessage
Constants ¶
View Source
const DefaultProviderName = "default"
View Source
const KeySMS runtime.Key = "sms"
Variables ¶
View Source
var ( ErrNotConfigured = errors.New("sms: not configured") ErrDefaultRequired = errors.New("sms: default provider is required") ErrProviderNotFound = errors.New("sms: provider not found") ErrDriverRequired = pkgsms.ErrDriverRequired ErrUnknownDriver = pkgsms.ErrUnknownDriver ErrNoProviderAvailable = errors.New("sms: no provider available") ErrProviderFailed = errors.New("sms: provider send failed") ErrRateLimited = errors.New("sms: rate limited") )
Functions ¶
func RegisterDriver ¶
func RegisterDriver(driver string, factory pkgsms.DriverFactory)
func SetDefault ¶
func SetDefault(manager *Manager)
Types ¶
type AttemptResult ¶
type AttemptResult = pkgsms.AttemptResult
type Config ¶
type Config struct {
Default string `mapstructure:"default" yaml:"default"`
Providers map[string]pkgsms.ProviderConfig `mapstructure:"providers" yaml:"providers"`
}
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
func ManagerDefault ¶
func NewManager ¶
func NewManager(cfg Config, middleware ...Middleware) (*Manager, error)
func (*Manager) DefaultName ¶
func (*Manager) UseMiddleware ¶
func (m *Manager) UseMiddleware(middleware ...Middleware)
type Middleware ¶
type Middleware = pkgsms.Middleware
func RateLimitMiddleware ¶
func RateLimitMiddleware(limiter RateLimiter, rule RateLimitRule) Middleware
type NoProviderAvailableError ¶
type NoProviderAvailableError struct {
Attempts []AttemptResult
}
func (*NoProviderAvailableError) Error ¶
func (e *NoProviderAvailableError) Error() string
func (*NoProviderAvailableError) Is ¶
func (e *NoProviderAvailableError) Is(target error) bool
func (*NoProviderAvailableError) LastError ¶
func (e *NoProviderAvailableError) LastError() error
type ProviderConfig ¶
type ProviderConfig = pkgsms.ProviderConfig
type ProviderMessage ¶
type ProviderMessage = pkgsms.ProviderMessage
type ProviderRequest ¶
type ProviderRequest = pkgsms.ProviderRequest
type ProviderResult ¶
type ProviderResult = pkgsms.ProviderResult
type RateLimitRule ¶
type RateLimiter ¶
type SendResult ¶
type SendResult = pkgsms.SendResult
type SenderFunc ¶
type SenderFunc = pkgsms.SenderFunc
type TemplateMessage ¶
type TemplateMessage = pkgsms.TemplateMessage
Source Files
¶
Click to show internal directories.
Click to hide internal directories.