ombi

Documentation

Index

• Constants
• type NotificationPref
• type Ombi
  • func NewOmbi(server, key string, timeoutHandler co.TimeoutHandler) *Ombi
  • func (ombi *Ombi) DeleteUser(id string) (err error)
  • func (ombi *Ombi) GetUsers() ([]map[string]interface{}, error)
  • func (ombi *Ombi) ModifyUser(user map[string]interface{}) (err error)
  • func (ombi *Ombi) NewUser(username, password, email string, template map[string]interface{}) ([]string, error)
  • func (ombi *Ombi) SetNotificationPrefs(user map[string]interface{}, discordID, telegramUser string) (result string, err error)
  • func (ombi *Ombi) SetTransport(t *http.Transport)
  • func (ombi *Ombi) TemplateByID(id string) (result map[string]interface{}, err error)
  • func (ombi *Ombi) UserByID(id string) (result map[string]interface{}, err error)

Constants

const (
	NotifAgentDiscord  = 1
	NotifAgentTelegram = 4
)

Types

type NotificationPref

type NotificationPref struct {
	Agent   int    `json:"agent"`
	UserID  string `json:"userId"`
	Value   string `json:"value"`
	Enabled bool   `json:"enabled"`
}

type Ombi

type Ombi struct {
	// contains filtered or unexported fields
}

Ombi represents a running Ombi instance.

func NewOmbi

func NewOmbi(server, key string, timeoutHandler co.TimeoutHandler) *Ombi

NewOmbi returns an Ombi object.

func (*Ombi) DeleteUser

func (ombi *Ombi) DeleteUser(id string) (err error)

DeleteUser deletes the user corresponding to the given ID.

func (*Ombi) GetUsers

func (ombi *Ombi) GetUsers() ([]map[string]interface{}, error)

GetUsers returns all users on the Ombi instance.

func (*Ombi) ModifyUser

func (ombi *Ombi) ModifyUser(user map[string]interface{}) (err error)

ModifyUser applies the given modified user object to the corresponding user.

func (*Ombi) NewUser

func (ombi *Ombi) NewUser(username, password, email string, template map[string]interface{}) ([]string, error)

NewUser creates a new user with the given username, password and email address.

func (*Ombi) SetNotificationPrefs

func (ombi *Ombi) SetNotificationPrefs(user map[string]interface{}, discordID, telegramUser string) (result string, err error)

func (*Ombi) SetTransport

func (ombi *Ombi) SetTransport(t *http.Transport)

SetTransport sets the http.Transport to use for requests. Can be used to set a proxy.

func (*Ombi) TemplateByID

func (ombi *Ombi) TemplateByID(id string) (result map[string]interface{}, err error)

TemplateByID returns a template based on the user corresponding to the provided ID's settings.

func (*Ombi) UserByID

func (ombi *Ombi) UserByID(id string) (result map[string]interface{}, err error)

UserByID returns the user corresponding to the provided ID.