docs

Documentation

Index

• func Carbon() *nimbusdocs.Client
• func For(product nimbusdocs.Product) *nimbusdocs.Client
• func Sigma() *nimbusdocs.Client
• type Plugin
  • func New() *Plugin
  • func (p *Plugin) Boot(app *nimbus.App) error
  • func (p *Plugin) Register(app *nimbus.App) error

Functions

func Carbon

func Carbon() *nimbusdocs.Client

Carbon is the document client, or nil when CARBON_API_KEY is unset.

func For

func For(product nimbusdocs.Product) *nimbusdocs.Client

For returns the client for a product, or nil when its key is not set.

func Sigma

func Sigma() *nimbusdocs.Client

Sigma is the spreadsheet client, or nil when SIGMA_API_KEY is unset.

Types

type Plugin

type Plugin struct {
	nimbus.BasePlugin
}

Plugin registers document clients for whichever products have keys.

func New

func New() *Plugin

New creates the plugin.

func (*Plugin) Boot

func (p *Plugin) Boot(app *nimbus.App) error

Boot is a no-op.

func (*Plugin) Register

func (p *Plugin) Register(app *nimbus.App) error

Register builds a client per configured key.