plugins

Documentation

Index

• type Category
• type Export
  • func NewPlugin(name, version, description string) *Export
  • func (p *Export) AddCategory(categoryName string)
  • func (p *Export) AddChildObject(categoryName, parentID, childID, childExport string) error
  • func (p *Export) AddObject(categoryName, objectID, export string) error
  • func (p *Export) GetAllObjects() []*Object
  • func (p *Export) GetCategory(categoryName string) (*Category, error)
  • func (p *Export) GetObjects(export *Export) []*Object
• type Object

Types

type Category

type Category struct {
	Name    string    `json:"name"`
	Objects []*Object `json:"objects,omitempty"`
}

type Export

type Export struct {
	Name        string      `json:"name"`
	Version     string      `json:"version"`
	Path        string      `json:"path"` // its file name
	Description string      `json:"description"`
	Categories  []*Category `json:"categories,omitempty"`
}

func NewPlugin

func NewPlugin(name, version, description string) *Export

func (*Export) AddCategory

func (p *Export) AddCategory(categoryName string)

func (*Export) AddChildObject

func (p *Export) AddChildObject(categoryName, parentID, childID, childExport string) error

func (*Export) AddObject

func (p *Export) AddObject(categoryName, objectID, export string) error

func (*Export) GetAllObjects

func (p *Export) GetAllObjects() []*Object

func (*Export) GetCategory

func (p *Export) GetCategory(categoryName string) (*Category, error)

func (*Export) GetObjects

func (p *Export) GetObjects(export *Export) []*Object

type Object

type Object struct {
	ID       string    `json:"id"`
	Export   string    `json:"export"`
	Children []*Object `json:"children,omitempty"`
}