alertoverbee

package
v0.4.0 Latest Latest
Warning

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

Go to latest
Published: Apr 12, 2020 License: AGPL-3.0 Imports: 4 Imported by: 4

README

AlertOverbee

This bee can push notification to your iOS or Android device or extension in Chrome as an action to some event.

You can get your SOURCE-KEY and RECEIVER-KEY from: https://www.alertover.com/pages/api

APP

Configuration

The SOURCE-KEY, RECEIVER-KEY and message content are mandatory. If the message's title is empty, it would be replaced by AlertOver.

The priority of the message is option, 0 for normal and 1 for emergency, 0 and 1 is string.

Options
"Bees": [
  {
    "Name": "alertover example",
    "Class": "alertoverbee",
    "Description": "This is example of alertoverbee",
    "Options": [
      {
        "Name": "source",
        "Value": "SOURCE-KEY"
      }
    ]
  },
]
Actions
"Actions": [
    {
      "Bee": "alertover example",
      "Name": "send",
      "Options": [
        {
          "Name": "receiver",
          "Type": "string",
          "Value": "RECEIVER-KEY"
        },
        {
          "Name": "title",
          "Type": "string",
          "Value": ""
        },
        {
          "Name": "content",
          "Type": "string",
          "Value": ""
        },
        {
          "Name": "url",
          "Type": "string",
          "Value": ""
        },
        {
          "Name": "priority",
          "Type": "string",
          "Value": ""
        }
      ]
    },
]

Documentation

Overview

Package alertoverbee is able to send notifications on AlertOver.

Package alertoverbee is able to send notifications on AlertOver.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AlertOverBee

type AlertOverBee struct {
	bees.Bee
	// contains filtered or unexported fields
}

AlertOverBee is a Bee that is able to send notifications on AlertOver.

func (*AlertOverBee) Action

func (mod *AlertOverBee) Action(action bees.Action) []bees.Placeholder

Action triggers the action passed to it.

func (*AlertOverBee) ReloadOptions

func (mod *AlertOverBee) ReloadOptions(options bees.BeeOptions)

ReloadOptions parses the config options and initializes the Bee.

type AlertOverBeeFactory

type AlertOverBeeFactory struct {
	bees.BeeFactory
}

AlertOverBeeFactory is a factory for AlertOverBees.

func (*AlertOverBeeFactory) Actions

func (factory *AlertOverBeeFactory) Actions() []bees.ActionDescriptor

Actions describes the available actions provided by this Bee.

func (*AlertOverBeeFactory) Description

func (factory *AlertOverBeeFactory) Description() string

Description returns the description of this Bee.

func (*AlertOverBeeFactory) Events

func (factory *AlertOverBeeFactory) Events() []bees.EventDescriptor

Events describes the available events provided by this Bee.

func (*AlertOverBeeFactory) ID

func (factory *AlertOverBeeFactory) ID() string

ID returns the ID of this Bee.

func (*AlertOverBeeFactory) Image

func (factory *AlertOverBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*AlertOverBeeFactory) LogoColor

func (factory *AlertOverBeeFactory) LogoColor() string

LogoColor returns the preferred logo background color (used by the admin interface).

func (*AlertOverBeeFactory) Name

func (factory *AlertOverBeeFactory) Name() string

Name returns the name of this Bee.

func (*AlertOverBeeFactory) New

func (factory *AlertOverBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface

New returns a new Bee instance configured with the supplied options.

func (*AlertOverBeeFactory) Options

func (factory *AlertOverBeeFactory) Options() []bees.BeeOptionDescriptor

Options returns the options available to configure this Bee.

Jump to

Keyboard shortcuts

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