client

package
v0.0.0-...-7cedb2b Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 16, 2016 License: GPL-3.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ErrorKindTwoFactorRequired = "two-factor-required"
	ErrorKindTwoFactorFailed   = "two-factor-failed"
	ErrorKindLoginRequired     = "login-required"
)
View Source 
const (
	StatusAvailable = "available"
	StatusInstalled = "installed"
	StatusActive    = "active"
	StatusRemoved   = "removed"

	TypeApp    = "app"
	TypeKernel = "kernel"
	TypeGadget = "gadget"
	TypeOS     = "os"

	StrictConfinement  = "strict"
	DevmodeConfinement = "devmode"
)

Statuses and types a snap may have.

Variables

View Source 
var ErrNoData = fmt.Errorf("data entry not found")

Functions

func IsTwoFactorError 

func IsTwoFactorError(err error) bool

IsTwoFactorError returns whether the given error is due to problems in two-factor authentication.

func MockDoRetry 

func MockDoRetry(retry, timeout time.Duration) (restore func())

MockDoRetry mocks the delays used by the do retry loop.

Types

type AppInfo 

type AppInfo struct {
	Name string `json:"name"`
}

type BuyResult 

type BuyResult struct {
	State string `json:"state"`
}

type Change 

type Change struct {
	ID      string  `json:"id"`
	Kind    string  `json:"kind"`
	Summary string  `json:"summary"`
	Status  string  `json:"status"`
	Tasks   []*Task `json:"tasks,omitempty"`
	Ready   bool    `json:"ready"`
	Err     string  `json:"err,omitempty"`

	SpawnTime time.Time `json:"spawn-time,omitempty"`
	ReadyTime time.Time `json:"ready-time,omitempty"`
	// contains filtered or unexported fields
}

A Change is a modification to the system state.

func (*Change) Get 

func (c *Change) Get(key string, value interface{}) error

Get unmarshals into value the kind-specific data with the provided key.

type ChangeSelector 

type ChangeSelector uint8
const (
	ChangesInProgress ChangeSelector = 1 << iota
	ChangesReady
	ChangesAll = ChangesReady | ChangesInProgress
)

func (ChangeSelector) String 

func (c ChangeSelector) String() string

type ChangesOptions 

type ChangesOptions struct {
	SnapName string // if empty, no filtering by name is done
	Selector ChangeSelector
}

type Client 

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

A Client knows how to talk to the snappy daemon.

func New 

func New(config *Config) *Client

New returns a new instance of Client

func (*Client) Abort 

func (client *Client) Abort(id string) (*Change, error)

Abort attempts to abort a change that is in not yet ready.

func (*Client) Ack 

func (client *Client) Ack(b []byte) error

Ack tries to add an assertion to the system assertion database. To succeed the assertion must be valid, its signature verified with a known public key and the assertion consistent with and its prerequisite in the database.

func (*Client) Buy 

func (client *Client) Buy(opts *store.BuyOptions) (*BuyResult, error)

func (*Client) Change 

func (client *Client) Change(id string) (*Change, error)

Change fetches information about a Change given its ID

func (*Client) Changes 

func (client *Client) Changes(opts *ChangesOptions) ([]*Change, error)

func (*Client) Connect 

func (client *Client) Connect(plugSnapName, plugName, slotSnapName, slotName string) (changeID string, err error)

Connect establishes a connection between a plug and a slot. The plug and the slot must have the same interface.

func (*Client) CreateUser 

func (client *Client) CreateUser(mail string) (*CreateUserResult, error)

CreateUser creates a user from the given mail address

func (*Client) Disable 

func (client *Client) Disable(name string, options *SnapOptions) (changeID string, err error)

func (*Client) Disconnect 

func (client *Client) Disconnect(plugSnapName, plugName, slotSnapName, slotName string) (changeID string, err error)

Disconnect breaks the connection between a plug and a slot.

func (*Client) Enable 

func (client *Client) Enable(name string, options *SnapOptions) (changeID string, err error)

func (*Client) Find 

func (client *Client) Find(opts *FindOptions) ([]*Snap, *ResultInfo, error)

Find returns a list of snaps available for install from the store for this system and that match the query

func (*Client) Icon 

func (c *Client) Icon(pkgID string) (*Icon, error)

Icon returns the Icon belonging to an installed snap

func (*Client) Install 

func (client *Client) Install(name string, options *SnapOptions) (changeID string, err error)

Install adds the snap with the given name from the given channel (or the system default channel if not).

func (*Client) InstallPath 

func (client *Client) InstallPath(path string, options *SnapOptions) (changeID string, err error)

InstallPath sideloads the snap with the given path, returning the UUID of the background operation upon success.

func (*Client) Interfaces 

func (client *Client) Interfaces() (interfaces Interfaces, err error)

Interfaces returns all plugs, slots and their connections.

func (*Client) Known 

func (client *Client) Known(assertTypeName string, headers map[string]string) ([]asserts.Assertion, error)

Known queries assertions with type assertTypeName and matching assertion headers.

func (*Client) List 

func (client *Client) List(names []string) ([]*Snap, error)

List returns the list of all snaps installed on the system with names in the given list; if the list is empty, all snaps.

func (*Client) LoggedIn 

func (client *Client) LoggedIn() bool

LoggedIn returns whether the client has authentication data available.

func (*Client) Login 

func (client *Client) Login(username, password, otp string) (*User, error)

Login logs user in.

func (*Client) Logout 

func (client *Client) Logout() error

Logout logs the user out.

func (*Client) PaymentMethods 

func (client *Client) PaymentMethods() (*store.PaymentInformation, error)

func (*Client) Refresh 

func (client *Client) Refresh(name string, options *SnapOptions) (changeID string, err error)

Refresh refreshes the snap with the given name (switching it to track the given channel if given).

func (*Client) Remove 

func (client *Client) Remove(name string, options *SnapOptions) (changeID string, err error)

Remove removes the snap with the given name.

func (*Client) Revert 

func (client *Client) Revert(name string, options *SnapOptions) (changeID string, err error)

Revert rolls the snap back to the previous on-disk state

func (*Client) ServerVersion 

func (client *Client) ServerVersion() (*ServerVersion, error)

func (*Client) Snap 

func (client *Client) Snap(name string) (*Snap, *ResultInfo, error)

Snap returns the most recently published revision of the snap with the provided name.

func (*Client) SysInfo 

func (client *Client) SysInfo() (*SysInfo, error)

SysInfo gets system information from the REST API.

func (*Client) Try 

func (client *Client) Try(path string, options *SnapOptions) (changeID string, err error)

Try

type Config 

type Config struct {
	// BaseURL contains the base URL where snappy daemon is expected to be.
	// It can be empty for a default behavior of talking over a unix socket.
	BaseURL string
}

Config allows to customize client behavior.

type CreateUserResult 

type CreateUserResult struct {
	Username string `json:"username"`
}

CreateUserResult holds the result of a user creation

type Error 

type Error struct {
	Kind    string `json:"kind"`
	Message string `json:"message"`

	StatusCode int
}

Error is the real value of response.Result when an error occurs.

func (*Error) Error 

func (e *Error) Error() string

type FindOptions 

type FindOptions struct {
	Refresh bool
	Query   string
}

FindOptions supports exactly one of the following options: - Refresh: only return snaps that are refreshable - Query: only return snaps that match the query string

type Icon 

type Icon struct {
	Filename string
	Content  []byte
}

Icon represents the icon of an installed snap

type InterfaceAction 

type InterfaceAction struct {
	Action string `json:"action"`
	Plugs  []Plug `json:"plugs,omitempty"`
	Slots  []Slot `json:"slots,omitempty"`
}

InterfaceAction represents an action performed on the interface system.

type Interfaces 

type Interfaces struct {
	Plugs []Plug `json:"plugs"`
	Slots []Slot `json:"slots"`
}

Interfaces contains information about all plugs, slots and their connections

type OSRelease 

type OSRelease struct {
	ID        string `json:"id"`
	VersionID string `json:"version-id,omitempty"`
}

OSRelease contains information about the system extracted from /etc/os-release.

type Plug 

type Plug struct {
	Snap        string                 `json:"snap"`
	Name        string                 `json:"plug"`
	Interface   string                 `json:"interface,omitempty"`
	Attrs       map[string]interface{} `json:"attrs,omitempty"`
	Apps        []string               `json:"apps,omitempty"`
	Label       string                 `json:"label,omitempty"`
	Connections []SlotRef              `json:"connections,omitempty"`
}

Plug represents the potential of a given snap to connect to a slot.

type PlugRef 

type PlugRef struct {
	Snap string `json:"snap"`
	Name string `json:"plug"`
}

PlugRef is a reference to a plug.

type ResultInfo 

type ResultInfo struct {
	SuggestedCurrency string `json:"suggested-currency"`
}

type ServerVersion 

type ServerVersion struct {
	Version     string
	Series      string
	OSID        string
	OSVersionID string
}

type Slot 

type Slot struct {
	Snap        string                 `json:"snap"`
	Name        string                 `json:"slot"`
	Interface   string                 `json:"interface,omitempty"`
	Attrs       map[string]interface{} `json:"attrs,omitempty"`
	Apps        []string               `json:"apps,omitempty"`
	Label       string                 `json:"label,omitempty"`
	Connections []PlugRef              `json:"connections,omitempty"`
}

Slot represents a capacity offered by a snap.

type SlotRef 

type SlotRef struct {
	Snap string `json:"snap"`
	Name string `json:"slot"`
}

SlotRef is a reference to a slot.

type Snap 

type Snap struct {
	ID            string        `json:"id"`
	Summary       string        `json:"summary"`
	Description   string        `json:"description"`
	DownloadSize  int64         `json:"download-size"`
	Icon          string        `json:"icon"`
	InstalledSize int64         `json:"installed-size"`
	InstallDate   time.Time     `json:"install-date"`
	Name          string        `json:"name"`
	Developer     string        `json:"developer"`
	Status        string        `json:"status"`
	Type          string        `json:"type"`
	Version       string        `json:"version"`
	Channel       string        `json:"channel"`
	Revision      snap.Revision `json:"revision"`
	Confinement   string        `json:"confinement"`
	Private       bool          `json:"private"`
	DevMode       bool          `json:"devmode"`
	TryMode       bool          `json:"trymode"`
	Apps          []AppInfo     `json:"apps"`
	Broken        string        `json:"broken"`

	Prices map[string]float64 `json:"prices"`
}

Snap holds the data for a snap as obtained from snapd.

type SnapOptions 

type SnapOptions struct {
	Channel  string `json:"channel,omitempty"`
	DevMode  bool   `json:"devmode,omitempty"`
	JailMode bool   `json:"jailmode,omitempty"`
}

type SysInfo 

type SysInfo struct {
	Series    string    `json:"series,omitempty"`
	Version   string    `json:"version,omitempty"`
	OSRelease OSRelease `json:"os-release"`
	OnClassic bool      `json:"on-classic"`
}

SysInfo holds system information

type Task 

type Task struct {
	ID       string       `json:"id"`
	Kind     string       `json:"kind"`
	Summary  string       `json:"summary"`
	Status   string       `json:"status"`
	Log      []string     `json:"log,omitempty"`
	Progress TaskProgress `json:"progress"`

	SpawnTime time.Time `json:"spawn-time,omitempty"`
	ReadyTime time.Time `json:"ready-time,omitempty"`
}

A Task is an operation done to change the system's state.

type TaskProgress 

type TaskProgress struct {
	Done  int `json:"done"`
	Total int `json:"total"`
}

type User 

type User struct {
	Macaroon   string   `json:"macaroon,omitempty"`
	Discharges []string `json:"discharges,omitempty"`
}

User holds logged in user information.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.