shrutigo

package module

v0.0.0-...-d86a8be Latest Latest Go to latest Published: Jul 27, 2015 License: MIT Imports: 6 Imported by: 4

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/omie/shruti-go

Links

Open Source Insights

README ¶

shruti-go

wrapper around shruti API

Documentation ¶

Constants ¶

View Source

const (
	// Priorities
	PRIO_LOW  = 10
	PRIO_MED  = 20
	PRIO_HIGH = 30

	// Actions
	ACT_POLL = 10
	ACT_PUSH = 20

	// Heard status
	HRD_UNHEARD = 10
	HRD_HEARD   = 20
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	Protocol string
	Host     string
}

each model implements methods to consume Shruti API using this client

func (*Client) DeleteProvider ¶

func (client *Client) DeleteProvider(pname string) (err error)

func (*Client) GetAllProviders ¶

func (client *Client) GetAllProviders() (providers []*Provider, err error)

func (*Client) GetNotificationsSince ¶

func (client *Client) GetNotificationsSince(since *time.Time) (n []*Notification, err error)

func (*Client) GetSingleNotification ¶

func (client *Client) GetSingleNotification(id int) (n *Notification, err error)

func (*Client) GetSingleProvider ¶

func (client *Client) GetSingleProvider(providerName string) (p *Provider, err error)

func (*Client) GetUnheardNotifications ¶

func (client *Client) GetUnheardNotifications() (n []*Notification, err error)

func (*Client) PushNotification ¶

func (client *Client) PushNotification(n Notification) (err error)

func (*Client) RegisterProvider ¶

func (client *Client) RegisterProvider(p Provider) (err error)

func (*Client) UpdateProvider ¶

func (client *Client) UpdateProvider(p Provider) (err error)

type Notification ¶

type Notification struct {
	Id           int       `json:"id"`
	Title        string    `json:"title"`
	Url          string    `json:"url, omitempty"`
	Key          string    `json:"key"`
	Heard        int       `json:"heard"`
	Provider     int       `json:"provider"`
	CreatedOn    time.Time `json:"created_on, omitempty"`
	Priority     int       `json:"priority"`
	Action       int       `json:"action"`
	ProviderName string    `json:"provider_name, omitempty"`
}

type Provider ¶

type Provider struct {
	Id          int    `json:"id, omitempty"`
	Name        string `json:"name"`
	DisplayName string `json:"display_name"`
	Description string `json:"description, omitempty"`
	WebURL      string `json:"web_url, omitempty"`
	IconURL     string `json:"icon_url, omitempty"`
	Active      bool   `json:"active, omitempty"`
	Voice       string `json:"voice"`
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
Godeps
_workspace/src/github.com/parnurzeal/gorequest Package gorequest inspired by Nodejs SuperAgent provides easy-way to write http client	Package gorequest inspired by Nodejs SuperAgent provides easy-way to write http client
_workspace/src/golang.org/x/net/publicsuffix Package publicsuffix provides a public suffix list based on data from http://publicsuffix.org/.	Package publicsuffix provides a public suffix list based on data from http://publicsuffix.org/.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL