Documentation
¶
Overview ¶
Package driver defines interfaces to be implemented by SMS drivers as used by package sms.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Conn ¶
type Conn interface {
// Send an SMS from one number to another. It's up to each individual
// SMS driver to specify the format of the numbers.
Send(from, to, msg string) error
// Close the connection.
Close() error
}
Conn is a connection to the external SMS service.
type Driver ¶
type Driver interface {
// Open returns a new connection to the SMS server. The name is a string
// in a driver-specific format.
Open(name string, e *echo.Echo) (Conn, error)
}
Driver is the interface that must be implemented by an SMS driver.
type PhoneNumber ¶
type PhoneNumber interface {
// Valid determines if a specific phone number is valid for a given
// SMS driver.
Valid() bool
}
PhoneNumber defines an interface by which phone numbers can be validated.
type SMS ¶
type SMS interface {
// From is the sending phone number.
From() string
// To are all of the receiving phone numbers.
To() []string
// Content is the body of the message. Currently there is no support for
// MMS, but we'd like to add it.
Content() string
}
SMS defines an interface with basic getters to interact with an SMS message.
Click to show internal directories.
Click to hide internal directories.