hello

Documentation

Overview

Package hello provides a hello page for an Ambient app.

Index

• type Plugin
  • func New() *Plugin
  • func (p *Plugin) Disable() error
  • func (p *Plugin) Enable(toolkit *ambient.Toolkit) error
  • func (p *Plugin) PluginName() string
  • func (p *Plugin) PluginVersion() string
  • func (p *Plugin) Routes()

Types

type Plugin

type Plugin struct {
	*ambient.PluginBase
}

Plugin represents an Ambient plugin.

func New

func New() *Plugin

New returns a new hello plugin.

func (*Plugin) Disable

func (p *Plugin) Disable() error

Disable the plugin background tasks.

func (*Plugin) Enable

func (p *Plugin) Enable(toolkit *ambient.Toolkit) error

Enable accepts the toolkit.

func (*Plugin) PluginName

func (p *Plugin) PluginName() string

PluginName returns the plugin name.

func (*Plugin) PluginVersion

func (p *Plugin) PluginVersion() string

PluginVersion returns the plugin version.

func (*Plugin) Routes

func (p *Plugin) Routes()

Routes sets routes for the plugin.