pushgateway

Documentation

Index

• Variables
• type BaseDevice
• type Device
• type NotificationCounts
• type PushKey
  • func (pk *PushKey) Push(ctx context.Context, data *PushNotification) error
• type PushNotification
  • func (pn *PushNotification) Push(ctx context.Context, url string) error
• type PushPriority
• type ReqPush
• type RespPush
  • func (rp *RespPush) Error() string
  • func (rp *RespPush) Is(other error) bool

Variables

var ErrPushRejected error = &RespPush{}

Types

type BaseDevice

type BaseDevice struct {
	AppID     string         `json:"app_id"`
	PushKey   string         `json:"pushkey"`
	PushKeyTS int64          `json:"pushkey_ts,omitempty"`
	Data      map[string]any `json:"data,omitempty"`
}

type Device

type Device struct {
	BaseDevice
	Tweaks map[pushrules.PushActionTweak]any `json:"tweaks,omitempty"`
}

type NotificationCounts

type NotificationCounts struct {
	MissedCalls int `json:"missed_calls,omitempty"`
	Unread      int `json:"unread,omitempty"`
}

type PushKey

type PushKey struct {
	BaseDevice
	URL string `json:"url"`
}

func (*PushKey) Push

func (pk *PushKey) Push(ctx context.Context, data *PushNotification) error

type PushNotification

type PushNotification struct {
	Devices []Device `json:"devices"`

	Counts *NotificationCounts `json:"counts,omitempty"`

	EventID           id.EventID      `json:"event_id,omitempty"`
	Priority          PushPriority    `json:"prio,omitempty"`
	RoomAlias         id.RoomAlias    `json:"room_alias,omitempty"`
	RoomID            id.RoomID       `json:"room_id,omitempty"`
	RoomName          string          `json:"room_name,omitempty"`
	Sender            id.UserID       `json:"sender,omitempty"`
	SenderDisplayName string          `json:"sender_display_name,omitempty"`
	Type              string          `json:"type,omitempty"`
	Content           json.RawMessage `json:"content,omitempty"`
	UserIsTarget      bool            `json:"user_is_target,omitempty"`

	BeeperTTL *int `json:"com.beeper.ttl,omitempty"`
}

func (*PushNotification) Push

func (pn *PushNotification) Push(ctx context.Context, url string) error

type PushPriority

type PushPriority string

const (
	PushPriorityHigh PushPriority = "high"
	PushPriorityLow  PushPriority = "low"
)

type ReqPush

type ReqPush struct {
	Notification *PushNotification `json:"notification"`
}

type RespPush

type RespPush struct {
	Rejected []string `json:"rejected"`
}

func (*RespPush) Error

func (rp *RespPush) Error() string

func (*RespPush) Is

func (rp *RespPush) Is(other error) bool