box

Documentation

Index

• type BoxClient
  • func NewBoxClient(opts *model.BoxClientOptions) (BoxClient, error)

Types

type BoxClient

type BoxClient interface {
	Provider() model.BoxProvider // TODO replace with generics
	Events() *event.EventBus
	Create(opts *model.CreateOptions) (*model.BoxInfo, error)
	Connect(opts *model.ConnectOptions) error
	Describe(name string) (*model.BoxDetails, error)
	List() ([]model.BoxInfo, error)
	Delete(names []string) ([]string, error) // empty "names" means all boxes
	Clean() error                            // TODO delete source in params: remove local and git cache
	Version() (string, error)                // TODO replace string with BoxVersion interface, return both client and server version
}

func NewBoxClient

func NewBoxClient(opts *model.BoxClientOptions) (BoxClient, error)