html5_notify

README

HTML5 Plugin

Documentation

Documentation

Index

• Constants
• Variables
• func New() supervisor.Pluggable
• func NewMessageParams() m.Attributes
• func NewSettings() map[string]*m.Attribute
• type Notification
• type NotificationAction
• type NotificationOptions

Constants

const (
	// Name ...
	Name = "html5_notify"

	AttrTitle              = "title"
	AttrUserIDS            = "userIDS"
	AttrActions            = "actions"
	AttrBadge              = "badge"
	AttrBody               = "body"
	AttrData               = "data"
	AttrDir                = "dir"
	AttrIcon               = "icon"
	AttrImage              = "image"
	AttrLang               = "lang"
	AttrRenotify           = "renotify"
	AttrRequireInteraction = "requireInteraction"
	AttrSilent             = "silent"
	AttrTag                = "tag"
	AttrTimestamp          = "timestamp"

	Version = "0.0.1"
)

Variables

var F embed.FS

Functions

func New

func New() supervisor.Pluggable

New ...

func NewMessageParams

func NewMessageParams() m.Attributes

NewMessageParams ...

func NewSettings

func NewSettings() map[string]*m.Attribute

NewSettings ...

Types

type Notification

type Notification struct {
	Title   string               `json:"title"`
	Options *NotificationOptions `json:"options,omitempty"`
}

type NotificationAction

type NotificationAction struct {
	Action string `json:"action"`
	Icon   string `json:"icon"`
	Title  string `json:"title"`
}

type NotificationOptions

type NotificationOptions struct {
	Actions            []NotificationAction `json:"actions,omitempty"`
	Badge              string               `json:"badge,omitempty"`
	Body               string               `json:"body,omitempty"`
	Data               any                  `json:"data,omitempty"`
	Dir                string               `json:"dir,omitempty"`
	Icon               string               `json:"icon,omitempty"`
	Image              string               `json:"image,omitempty"`
	Lang               string               `json:"lang,omitempty"`
	Renotify           bool                 `json:"renotify,omitempty"`
	RequireInteraction bool                 `json:"requireInteraction,omitempty"`
	Silent             bool                 `json:"silent,omitempty"`
	Tag                string               `json:"tag,omitempty"`
	Timestamp          int64                `json:"timestamp,omitempty"`
}