plugin

Documentation

Index

• func AddAuthToken(ctx context.Context, req *http.Request) error
• func GetAPIClient(ctx context.Context) (*egapi.Client, error)
• func Redirect(path string) (*plugin_protos.Response, error)
• func WritePage(ctx context.Context, request *plugin_protos.Request, page Page) (*plugin_protos.Response, error)
• type Endpoint
  • func AlwaysRedirect(path string) Endpoint
• type Error
  • func (e Error) Error() string
• type MenuItem
• type Page
• type Plugin
  • func (p Plugin) HandleRequest(ctx context.Context, request *plugin_protos.Request) (*plugin_protos.Response, error)
  • func (p *Plugin) ListenAndServe()
  • func (p Plugin) Settings(ctx context.Context, _ *plugin_protos.Empty) (*plugin_protos.Plugin, error)

Functions

func AddAuthToken

func AddAuthToken(ctx context.Context, req *http.Request) error

AddAuthToken adds the auth token from the context to an outgoing request

func GetAPIClient

func GetAPIClient(ctx context.Context) (*egapi.Client, error)

func Redirect

func Redirect(path string) (*plugin_protos.Response, error)

func WritePage

func WritePage(ctx context.Context, request *plugin_protos.Request, page Page) (*plugin_protos.Response, error)

Types

type Endpoint

type Endpoint func(ctx context.Context, request *plugin_protos.Request) (*plugin_protos.Response, error)

func AlwaysRedirect

func AlwaysRedirect(path string) Endpoint

type Error

type Error struct {
	Err         error
	ErrTitle    string
	Description string
}

func (Error) Error

func (e Error) Error() string

type MenuItem

type MenuItem struct {
	Name  string
	Path  string
	Items []MenuItem
}

type Page

type Page interface {
	Title() string
	StreamTitle(*quicktemplate.Writer)
	WriteTitle(io.Writer)
	Body() string
	StreamBody(*quicktemplate.Writer)
	WriteBody(io.Writer)
}

type Plugin

type Plugin struct {
	plugin_protos.UnimplementedPluginServiceServer

	Name      string
	Extension string

	Endpoints map[string]map[string]Endpoint // map[path]map[method]Endpoint
	Menu      *plugin_protos.MenuItem
}

func (Plugin) HandleRequest

func (p Plugin) HandleRequest(ctx context.Context, request *plugin_protos.Request) (*plugin_protos.Response, error)

func (*Plugin) ListenAndServe

func (p *Plugin) ListenAndServe()

func (Plugin) Settings

func (p Plugin) Settings(ctx context.Context, _ *plugin_protos.Empty) (*plugin_protos.Plugin, error)