notification

Documentation

Index

• type Notification
  • func (n *Notification) Clone() couchdb.Doc
  • func (n *Notification) DocType() string
  • func (n *Notification) Fetch(field string) []string
  • func (n *Notification) ID() string
  • func (n *Notification) Rev() string
  • func (n *Notification) SetID(id string)
  • func (n *Notification) SetRev(rev string)
  • func (n *Notification) Source() string
• type Properties
  • func (p *Properties) Clone() *Properties

Types

type Notification

type Notification struct {
	NID  string `json:"_id,omitempty"`
	NRev string `json:"_rev,omitempty"`

	SourceID   string `json:"source_id"`
	Originator string `json:"originator,omitempty"`
	Slug       string `json:"slug,omitempty"`
	Category   string `json:"category"`
	CategoryID string `json:"category_id,omitempty"`

	CreatedAt time.Time `json:"created_at"`
	LastSent  time.Time `json:"last_sent"`

	Title    string                 `json:"title,omitempty"`
	Message  string                 `json:"message,omitempty"`
	Priority string                 `json:"priority,omitempty"`
	Sound    string                 `json:"sound,omitempty"`
	State    interface{}            `json:"state,omitempty"`
	Data     map[string]interface{} `json:"data,omitempty"`

	PreferredChannels []string `json:"preferred_channels,omitempty"`
	At                string   `json:"at,omitempty"`

	// XXX retro-compatible fields for sending rich mail
	Content     string `json:"content,omitempty"`
	ContentHTML string `json:"content_html,omitempty"`
}

Notification data containing associated to an application a list of actions

func (*Notification) Clone

func (n *Notification) Clone() couchdb.Doc

Clone implements couchdb.Doc

func (*Notification) DocType

func (n *Notification) DocType() string

DocType is used to implement the couchdb.Doc interface

func (*Notification) Fetch

func (n *Notification) Fetch(field string) []string

Fetch implements permissions.Fetcher

func (*Notification) ID

func (n *Notification) ID() string

ID is used to implement the couchdb.Doc interface

func (*Notification) Rev

func (n *Notification) Rev() string

Rev is used to implement the couchdb.Doc interface

func (*Notification) SetID

func (n *Notification) SetID(id string)

SetID is used to implement the couchdb.Doc interface

func (*Notification) SetRev

func (n *Notification) SetRev(rev string)

SetRev is used to implement the couchdb.Doc interface

func (*Notification) Source

func (n *Notification) Source() string

Source returns the complete normalized source value. This should be recorded in the `source_id` field.

type Properties

type Properties struct {
	Description     string            `json:"description,omitempty"`
	Collapsible     bool              `json:"collapsible,omitempty"`
	Multiple        bool              `json:"multiple,omitempty"`
	Stateful        bool              `json:"stateful,omitempty"`
	DefaultPriority string            `json:"default_priority,omitempty"`
	TimeToLive      time.Duration     `json:"time_to_live,omitempty"`
	Templates       map[string]string `json:"templates,omitempty"`
	MinInterval     time.Duration     `json:"min_interval,omitempty"`

	MailTemplate string `json:"-"`
}

Properties is a notification type parameters, describing how a specific notification group should behave.

func (*Properties) Clone

func (p *Properties) Clone() *Properties

Clone returns a cloned Properties struct pointer.