plugin

package
v1.0.11 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 16, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const DefaultMessageTemplate = `` /* 249-byte string literal not displayed */

Variables

View Source 
var ErrAuthSourceNotSet = errors.New("either username and password or userid and accesstoken are required")

Functions

func Flags added in v1.0.11 

func Flags(settings *Settings, category string) []cli.Flag

Flags returns a slice of CLI flags for the plugin.

Types

type Plugin 

type Plugin struct {
	*plugin_base.Plugin
	Settings *Settings
}

Plugin implements provide the plugin.

func New 

func New(e plugin_base.ExecuteFunc, build ...string) *Plugin

func (*Plugin) CreateMessage added in v1.0.11 

func (p *Plugin) CreateMessage() (string, error)

CreateMessage generates a message string based on the plugin's template and metadata.

func (*Plugin) Execute 

func (p *Plugin) Execute() error

Execute provides the implementation of the plugin.

func (*Plugin) Validate 

func (p *Plugin) Validate() error

Validate handles the settings validation of the plugin.

type Settings 

type Settings struct {
	Username       string
	Password       string
	UserID         string
	AccessToken    string
	Homeserver     string
	RoomID         string
	Template       string
	TemplateUnsafe bool
}

Settings for the plugin.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.