sms

Documentation

Index

• Variables
• type SMS
  • func NewSMS(to, text string) SMS
• type SMSStore
  • func NewStore(freeze, interval int) *SMSStore
  • func (sms *SMSStore) GetCurrentSMSFromStore(ch int) ([]SMS, error)
  • func (sms *SMSStore) GetUnreadSMS(ch int) ([]SMS, error)
  • func (sms *SMSStore) GetUnsentSMS(ch int) ([]SMS, error)
  • func (sms *SMSStore) ParseSMS(body string) error
  • func (sms *SMSStore) SetRead(ch int, uid string) error
  • func (sms *SMSStore) SetSent(ch int, uid string) error
  • func (sms *SMSStore) Stop()

Variables

var (
	ErrInvalidSMS        = errors.New("sms content invalid")  // error for invalid single SMSs line of GSM channel
	ErrInvalidBody       = errors.New("invalid http body")    // error if http body content not contains required strings
	ErrNoContent         = errors.New("no sms available")     // error for storage if no messages saved
	ErrTimeInvalid       = errors.New("time string invalid")  // error for parsing sms if time string not parsable
	ErrSMSSentInProgress = errors.New("send sms in progress") // error for waiting sms send state
	ErrSMSSentFailed     = errors.New("send sms failed")      // error if sms send failed
	ErrSMSSSentNotFound  = errors.New("sms key not found")    // error id unique sms key not found
)

Types

type SMS

type SMS struct {
	Direction string    // messade direction. only in or out
	Date      time.Time // event time
	From      string    // sender id
	To        string    // receiver id
	Text      string    // sms content
	Read      bool      // sms was sent to user
	Sent      bool      // sms was sent to remote
	UID       string    // unique sms ID
}

SMS - universal for inbox or outbox struct of single SMS message

func NewSMS

func NewSMS(to, text string) SMS

NewSMS - create new SMS message. May used only with sending SMS

to - destination phone number
text - text of sms message

type SMSStore

type SMSStore struct {
	Store map[int][]SMS // sms inmemory storage
	// contains filtered or unexported fields
}

func NewStore

func NewStore(freeze, interval int) *SMSStore

NewStore - create new sms storage instance

func (*SMSStore) GetCurrentSMSFromStore

func (sms *SMSStore) GetCurrentSMSFromStore(ch int) ([]SMS, error)

GetCurrentSMSFromStore - get current inmemory stored sms messages of GSM channel

ch - channel number

func (*SMSStore) GetUnreadSMS

func (sms *SMSStore) GetUnreadSMS(ch int) ([]SMS, error)

GetUnreadSMS - get unread messages from SMSs storage of GSM channel

ch - channel number

func (*SMSStore) GetUnsentSMS

func (sms *SMSStore) GetUnsentSMS(ch int) ([]SMS, error)

GetUnsentSMS - get unsent messages from SMSs storage of GSM channel

ch - channel number

func (*SMSStore) ParseSMS

func (sms *SMSStore) ParseSMS(body string) error

ParseSMS - parse full html body from GoIP gateway

func (*SMSStore) SetRead

func (sms *SMSStore) SetRead(ch int, uid string) error

SetRead - set sms as read

func (*SMSStore) SetSent

func (sms *SMSStore) SetSent(ch int, uid string) error

SetSent - set sms as sent

func (*SMSStore) Stop

func (sms *SMSStore) Stop()

Stop - stops SMS processes such cleaner or getSMSfromline