README
¶
GotifyBee
This bee can push notification to the specified gotify application as an action to some event.
You can get your TOKEN for your specified gotify application by going to the APPS section of the gotify server instance and unhiding the token for your desired application.
APP
Configuration
The message field is required. If the message's title is empty, it would be replaced by Gotify.
The priority of the message is option.
Options
"Bees": [
{
"Name": "gotify example",
"Class": "gotify",
"Description": "This is example of gotify",
"Options": [
{
"Name": "token",
"Value": "TOKEN"
}
]
},
]
Actions
"Actions": [
{
"Bee": "gotify example",
"Name": "send",
"Options": [
{
"Name": "title",
"Type": "string",
"Value": ""
},
{
"Name": "message",
"Type": "string",
"Value": ""
},
{
"Name": "priority",
"Type": "string",
"Value": ""
}
]
},
]
Documentation
¶
Overview ¶
Package gotifybee is able to send notifications on Gotify.
Package gotifybee is able to send notifications on Gotify.
Index ¶
- type GotifyBee
- type GotifyBeeFactory
- func (factory *GotifyBeeFactory) Actions() []bees.ActionDescriptor
- func (factory *GotifyBeeFactory) Description() string
- func (factory *GotifyBeeFactory) Events() []bees.EventDescriptor
- func (factory *GotifyBeeFactory) ID() string
- func (factory *GotifyBeeFactory) Image() string
- func (factory *GotifyBeeFactory) LogoColor() string
- func (factory *GotifyBeeFactory) Name() string
- func (factory *GotifyBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface
- func (factory *GotifyBeeFactory) Options() []bees.BeeOptionDescriptor
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GotifyBee ¶
GotifyBee is a Bee that is able to send notifications on Gotify.
func (*GotifyBee) Action ¶
func (mod *GotifyBee) Action(action bees.Action) []bees.Placeholder
Action triggers the action passed to it.
func (*GotifyBee) ReloadOptions ¶
func (mod *GotifyBee) ReloadOptions(options bees.BeeOptions)
ReloadOptions parses the config options and initializes the Bee.
type GotifyBeeFactory ¶
type GotifyBeeFactory struct {
bees.BeeFactory
}
GotifyBeeFactory is a factory for GotifyBees.
func (*GotifyBeeFactory) Actions ¶
func (factory *GotifyBeeFactory) Actions() []bees.ActionDescriptor
Actions describes the available actions provided by this Bee.
func (*GotifyBeeFactory) Description ¶
func (factory *GotifyBeeFactory) Description() string
Description returns the description of this Bee.
func (*GotifyBeeFactory) Events ¶
func (factory *GotifyBeeFactory) Events() []bees.EventDescriptor
Events describes the available events provided by this Bee.
func (*GotifyBeeFactory) ID ¶
func (factory *GotifyBeeFactory) ID() string
ID returns the ID of this Bee.
func (*GotifyBeeFactory) Image ¶
func (factory *GotifyBeeFactory) Image() string
Image returns the filename of an image for this Bee.
func (*GotifyBeeFactory) LogoColor ¶
func (factory *GotifyBeeFactory) LogoColor() string
LogoColor returns the preferred logo background color (used by the admin interface).
func (*GotifyBeeFactory) Name ¶
func (factory *GotifyBeeFactory) Name() string
Name returns the name of this Bee.
func (*GotifyBeeFactory) New ¶
func (factory *GotifyBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface
New returns a new Bee instance configured with the supplied options.
func (*GotifyBeeFactory) Options ¶
func (factory *GotifyBeeFactory) Options() []bees.BeeOptionDescriptor
Options returns the options available to configure this Bee.
Source Files