plugins

package

v5.0.7 Latest Latest Go to latest Published: Oct 29, 2023 License: MIT Imports: 7 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/greboid/irc-bot

Links

Open Source Insights

Documentation ¶

Index ¶

type PluginHelper
- func NewHelper(target string, rpctoken string) (*PluginHelper, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type PluginHelper ¶

type PluginHelper struct {
	RPCTarget string
	RPCToken  string
	// contains filtered or unexported fields
}

func NewHelper ¶

func NewHelper(target string, rpctoken string) (*PluginHelper, error)

NewHelper returns a PluginHelper that simplifies writing plugins by managing grpc connections and exposing a simple interface. It returns a PluginHelper or any errors encountered whilst creating

func (*PluginHelper) HTTPClient ¶

func (h *PluginHelper) HTTPClient() (rpc.HTTPPluginClient, error)

func (*PluginHelper) HTTPClientWithContext ¶

func (h *PluginHelper) HTTPClientWithContext(ctx context.Context) (rpc.HTTPPluginClient, error)

func (*PluginHelper) IRCClient ¶

func (h *PluginHelper) IRCClient() (rpc.IRCPluginClient, error)

func (*PluginHelper) IRCClientWithContext ¶

func (h *PluginHelper) IRCClientWithContext(ctx context.Context) (rpc.IRCPluginClient, error)

func (*PluginHelper) Ping ¶

func (h *PluginHelper) Ping() error

func (*PluginHelper) PingWithContext ¶

func (h *PluginHelper) PingWithContext(ctx context.Context) error

func (*PluginHelper) RegisterChannelMessageHandler ¶

func (h *PluginHelper) RegisterChannelMessageHandler(channel string, handler func(message *rpc.ChannelMessage)) error

func (*PluginHelper) RegisterChannelMessageHandlerWithContext ¶

func (h *PluginHelper) RegisterChannelMessageHandlerWithContext(ctx context.Context, channel string, handler func(message *rpc.ChannelMessage)) error

func (*PluginHelper) RegisterWebhook ¶

func (h *PluginHelper) RegisterWebhook(path string, handler func(request *rpc.HttpRequest) *rpc.HttpResponse) error

func (*PluginHelper) RegisterWebhookWithContext ¶

func (h *PluginHelper) RegisterWebhookWithContext(ctx context.Context, path string, handler func(request *rpc.HttpRequest) *rpc.HttpResponse) error

func (*PluginHelper) SendChannelMessage ¶

func (h *PluginHelper) SendChannelMessage(channel string, messages ...string) error

func (*PluginHelper) SendChannelMessageWithContext ¶

func (h *PluginHelper) SendChannelMessageWithContext(ctx context.Context, channel string, messages ...string) error

func (*PluginHelper) SendRawMessage ¶

func (h *PluginHelper) SendRawMessage(messages ...string) error

func (*PluginHelper) SendRawMessageWithContext ¶

func (h *PluginHelper) SendRawMessageWithContext(ctx context.Context, messages ...string) error

func (*PluginHelper) SendRelayMessage ¶ added in v5.0.4

func (h *PluginHelper) SendRelayMessage(channel string, nickname string, messages ...string) error

func (*PluginHelper) SendRelayMessageWithContext ¶ added in v5.0.4

func (h *PluginHelper) SendRelayMessageWithContext(ctx context.Context, channel string, nickname string, messages ...string) error

Source Files ¶

View all Source files

helper.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL