twilio

README

TWILIO Plugin

Documentation

Documentation

Index

• Constants
• Variables
• func New() supervisor.Pluggable
• func NewAttr() m.Attributes
• func NewMessageParams() m.Attributes
• func NewSettings() m.Attributes
• type Actor
  • func NewActor(entity *m.Entity, service supervisor.Service) *Actor
  • func (e *Actor) Balance() (balance Balance, err error)
  • func (e *Actor) Destroy()
  • func (e *Actor) GetStatus(smsId string) (string, error)
  • func (e *Actor) MessageParams() m.Attributes
  • func (e *Actor) Save(msg notifyCommon.Message) (addresses []string, message *m.Message)
  • func (e *Actor) Send(phone string, message *m.Message) (err error)
  • func (e *Actor) Spawn()
  • func (e *Actor) UpdateBalance() (err error)
• type Balance

Constants

const (
	// Name ...
	Name = "twilio"
	// AttrFrom ...
	AttrFrom = "from"
	// AttrSid ...
	AttrSid = "sid"
	// AttrAuthToken ...
	AttrAuthToken = "authToken"
	// AttrPhone ...
	AttrPhone = "phone"
	// AttrBody ...
	AttrBody = "body"
	// AttrAmount ...
	AttrAmount = "amount"
	// AttrCurrency ...
	AttrCurrency = "currency"

	Version = "0.0.1"
)

const (
	// StatusAccepted ...
	StatusAccepted = "accepted"
	// StatusQueued ...
	StatusQueued = "queued"
	// StatusSending ...
	StatusSending = "sending"
	// StatusReceiving ...
	StatusReceiving = "receiving"
	// StatusReceived ...
	StatusReceived = "received"
	// StatusDelivered ...
	StatusDelivered = "delivered"
	// StatusUndelivered ...
	StatusUndelivered = "undelivered"
	// StatusSent ...
	StatusSent = "sent"
	// StatusFailed ...
	StatusFailed = "failed"
)

Variables

var F embed.FS

Functions

func New

func New() supervisor.Pluggable

New ...

func NewAttr

func NewAttr() m.Attributes

NewAttr ...

func NewMessageParams

func NewMessageParams() m.Attributes

NewMessageParams ...

func NewSettings

func NewSettings() m.Attributes

NewSettings ...

Types

type Actor

type Actor struct {
	*supervisor.BaseActor
	// contains filtered or unexported fields
}

Actor ...

func NewActor

func NewActor(entity *m.Entity,
	service supervisor.Service) *Actor

NewActor ...

func (*Actor) Balance

func (e *Actor) Balance() (balance Balance, err error)

Balance ...

func (*Actor) Destroy

func (e *Actor) Destroy()

func (*Actor) GetStatus

func (e *Actor) GetStatus(smsId string) (string, error)

GetStatus ...

func (*Actor) MessageParams

func (e *Actor) MessageParams() m.Attributes

MessageParams ...

func (*Actor) Save

func (e *Actor) Save(msg notifyCommon.Message) (addresses []string, message *m.Message)

Save ...

func (*Actor) Send

func (e *Actor) Send(phone string, message *m.Message) (err error)

Send ...

func (*Actor) Spawn

func (e *Actor) Spawn()

func (*Actor) UpdateBalance

func (e *Actor) UpdateBalance() (err error)

UpdateBalance ...

type Balance

type Balance struct {
	Currency   string `json:"currency"`
	Balance    string `json:"balance"`
	AccountSid string `json:"account_sid"`
}

Balance ...