notifications

Documentation

Index

• func SetDB(database database.Database)
• type Notification
  • func Find(method string) (*Notification, error)
  • func (n *Notification) AfterCreate()
  • func (n *Notification) AfterDelete()
  • func (n *Notification) AfterFind() (err error)
  • func (n *Notification) AfterUpdate()
  • func (n *Notification) CanSend() bool
  • func (n *Notification) Close()
  • func (n *Notification) Create() error
  • func (n *Notification) GetValue(dbField string) string
  • func (n *Notification) IsRunning() bool
  • func (n *Notification) LastSent() time.Duration
  • func (n *Notification) Logger() *logrus.Logger
  • func (n *Notification) Name() string
  • func (n *Notification) Start()
  • func (n *Notification) Update() error
  • func (n *Notification) UpdateFields(notif *Notification) *Notification
• type NotificationForm
• type NotificationOrder
  • func (c NotificationOrder) Len() int
  • func (c NotificationOrder) Less(i, j int) bool
  • func (c NotificationOrder) Swap(i, j int)
• type RunFunc

Functions

func SetDB

func SetDB(database database.Database)

Types

type Notification

type Notification struct {
	Id          int64         `gorm:"primary_key;column:id" json:"id"`
	Method      string        `gorm:"column:method" json:"method"`
	Host        string        `gorm:"not null;column:host" json:"host,omitempty"`
	Port        int           `gorm:"not null;column:port" json:"port,omitempty"`
	Username    string        `gorm:"not null;column:username" json:"username,omitempty"`
	Password    string        `gorm:"not null;column:password" json:"password,omitempty"`
	Var1        string        `gorm:"not null;column:var1" json:"var1,omitempty"`
	Var2        string        `gorm:"not null;column:var2" json:"var2,omitempty"`
	ApiKey      string        `gorm:"not null;column:api_key" json:"api_key,omitempty"`
	ApiSecret   string        `gorm:"not null;column:api_secret" json:"api_secret,omitempty"`
	Enabled     null.NullBool `gorm:"column:enabled;type:boolean;default:false" json:"enabled,omitempty"`
	Limits      int           `gorm:"not null;column:limits" json:"limits"`
	Removable   bool          `gorm:"column:removable" json:"removable"`
	SuccessData string        `gorm:"type:text;column:success_data" json:"success_data,omitempty"`
	FailureData string        `gorm:"type:text;column:failure_data" json:"failure_data,omitempty"`
	DataType    string        `gorm:"-" json:"data_type,omitempty"`
	RequestInfo string        `gorm:"-" json:"request_info,omitempty"`
	CreatedAt   time.Time     `gorm:"column:created_at" json:"created_at"`
	UpdatedAt   time.Time     `gorm:"column:updated_at" json:"updated_at"`
	Title       string        `gorm:"-" json:"title"`
	Description string        `gorm:"-" json:"description"`
	Author      string        `gorm:"-" json:"author"`
	AuthorUrl   string        `gorm:"-" json:"author_url"`
	Icon        string        `gorm:"-" json:"icon"`
	Delay       time.Duration `gorm:"-" json:"delay,string"`
	Running     chan bool     `gorm:"-" json:"-"`

	Form []NotificationForm `gorm:"-" json:"form"`
	// contains filtered or unexported fields
}

Notification contains all the fields for a Statping Notifier.

func Find

func Find(method string) (*Notification, error)

func (*Notification) AfterCreate

func (n *Notification) AfterCreate()

func (*Notification) AfterDelete

func (n *Notification) AfterDelete()

func (*Notification) AfterFind

func (n *Notification) AfterFind() (err error)

AfterFind for Notification will set the timezone

func (*Notification) AfterUpdate

func (n *Notification) AfterUpdate()

func (*Notification) CanSend

func (n *Notification) CanSend() bool

func (*Notification) Close

func (n *Notification) Close()

close will stop the go routine for queue

func (*Notification) Create

func (n *Notification) Create() error

func (*Notification) GetValue

func (n *Notification) GetValue(dbField string) string

GetValue returns the database value of a accept DbField value.

func (*Notification) IsRunning

func (n *Notification) IsRunning() bool

IsRunning will return true if the notifier is currently running a queue

func (*Notification) LastSent

func (n *Notification) LastSent() time.Duration

LastSent returns a time.Duration of the last sent notification for the notifier

func (*Notification) Logger

func (n *Notification) Logger() *logrus.Logger

func (*Notification) Name

func (n *Notification) Name() string

func (*Notification) Start

func (n *Notification) Start()

start will start the go routine for the notifier queue

func (*Notification) Update

func (n *Notification) Update() error

func (*Notification) UpdateFields

func (n *Notification) UpdateFields(notif *Notification) *Notification

type NotificationForm

type NotificationForm struct {
	Type        string   `json:"type"`        // the html input type (text, password, email)
	Title       string   `json:"title"`       // include a title for ease of use
	Placeholder string   `json:"placeholder"` // add a placeholder for the input
	DbField     string   `json:"field"`       // true variable key for input
	SmallText   string   `json:"small_text"`  // insert small text under a html input
	Required    bool     `json:"required"`    // require this input on the html form
	IsHidden    bool     `json:"hidden"`      // hide this form element from end user
	ListOptions []string `json:"list_options,omitempty"`
}

NotificationForm contains the HTML fields for each variable/input you want the notifier to accept.

type NotificationOrder

type NotificationOrder []Notification

NotificationOrder will reorder the services based on 'order_id' (Order)

func (NotificationOrder) Len

func (c NotificationOrder) Len() int

Sort interface for resorting the Notifications in order

func (NotificationOrder) Less

func (c NotificationOrder) Less(i, j int) bool

func (NotificationOrder) Swap

func (c NotificationOrder) Swap(i, j int)

type RunFunc

type RunFunc func(interface{}) error