notification

package

v1.15.1 Latest Latest Go to latest Published: Feb 15, 2026 License: BSD-3-Clause Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/getarcaneapp/arcane

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AppriseResponse ¶

type AppriseResponse struct {
	// ID is the unique identifier of the Apprise settings.
	//
	// Required: true
	ID uint `json:"id"`

	// APIURL is the URL of the Apprise API endpoint.
	//
	// Required: false
	APIURL string `json:"apiUrl"`

	// Enabled indicates if Apprise is enabled.
	//
	// Required: true
	Enabled bool `json:"enabled"`

	// ImageUpdateTag is the tag to use for image update notifications.
	//
	// Required: false
	ImageUpdateTag string `json:"imageUpdateTag"`

	// ContainerUpdateTag is the tag to use for container update notifications.
	//
	// Required: false
	ContainerUpdateTag string `json:"containerUpdateTag"`
}

type AppriseUpdate ¶

type AppriseUpdate struct {
	// APIURL is the URL of the Apprise API endpoint.
	//
	// Required: false
	APIURL string `json:"apiUrl"`

	// Enabled indicates if Apprise is enabled.
	//
	// Required: true
	Enabled bool `json:"enabled"`

	// ImageUpdateTag is the tag to use for image update notifications.
	//
	// Required: false
	ImageUpdateTag string `json:"imageUpdateTag"`

	// ContainerUpdateTag is the tag to use for container update notifications.
	//
	// Required: false
	ContainerUpdateTag string `json:"containerUpdateTag"`
}

type Provider ¶

type Provider string

Provider is the type for notification provider identifiers.

const (
	// NotificationProviderDiscord is the builtin Discord notification provider.
	NotificationProviderDiscord Provider = "discord"

	// NotificationProviderEmail is the builtin Email notification provider.
	NotificationProviderEmail Provider = "email"

	// NotificationProviderTelegram is the builtin Telegram notification provider.
	NotificationProviderTelegram Provider = "telegram"

	// NotificationProviderSignal is the builtin Signal notification provider.
	NotificationProviderSignal Provider = "signal"

	// NotificationProviderSlack is the builtin Slack notification provider.
	NotificationProviderSlack Provider = "slack"

	// NotificationProviderNtfy is the builtin Ntfy notification provider.
	NotificationProviderNtfy Provider = "ntfy"

	// NotificationProviderPushover is the builtin Pushover notification provider.
	NotificationProviderPushover Provider = "pushover"

	// NotificationProviderMatrix is the builtin Matrix webhook notification provider.
	NotificationProviderMatrix Provider = "matrix"

	// NotificationProviderGeneric is the builtin Generic webhook notification provider.
	NotificationProviderGeneric Provider = "generic"
)

type Response ¶

type Response struct {
	// ID is the unique identifier of the notification settings.
	//
	// Required: true
	ID uint `json:"id"`

	// Provider is the notification provider type.
	//
	// Required: true
	Provider Provider `json:"provider"`

	// Enabled indicates if the notification provider is enabled.
	//
	// Required: true
	Enabled bool `json:"enabled"`

	// Config contains the provider-specific configuration.
	//
	// Required: true
	Config base.JsonObject `json:"config"`
}

type Update ¶

type Update struct {
	// Provider is the notification provider type.
	//
	// Required: true
	Provider Provider `json:"provider" binding:"required"`

	// Enabled indicates if the notification provider is enabled.
	//
	// Required: true
	Enabled bool `json:"enabled"`

	// Config contains the provider-specific configuration.
	//
	// Required: true
	Config base.JsonObject `json:"config" binding:"required"`
}

Source Files ¶

View all Source files

notification.go

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