Package io.github.pimak.ntfy.core

Interface NtfyAction

All Known Implementing Classes:

NtfyAction.Broadcast, NtfyAction.Http, NtfyAction.View

public sealed interface NtfyAction
permits NtfyAction.View, NtfyAction.Http, NtfyAction.Broadcast

A single ntfy notification action button, modeled as a sealed hierarchy so each action type carries only the fields it needs (mirroring the AuthMode pattern). Actions are rendered into ntfy's Actions HTTP header by NtfyActionSerializer; ntfy allows at most three per notification.

All three ntfy action types are modeled: NtfyAction.View (open a URL — e.g. a dashboard or log link), NtfyAction.Http (fire an HTTP request — e.g. an acknowledge webhook, with optional typed NtfyAction.HttpHeaders), and NtfyAction.Broadcast (send an Android broadcast intent with optional typed NtfyAction.BroadcastExtras — only actioned by ntfy's Android app).

label and url are validated non-blank at construction: a malformed action is a programming error surfaced immediately, never a silent runtime publish failure.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	NtfyAction.Broadcast	Sends an Android broadcast intent when tapped (only actioned by ntfy's Android app).
static final record	NtfyAction.BroadcastExtra	A single intent extra (name/value) carried by a NtfyAction.Broadcast action.
static final record	NtfyAction.Http	Sends an HTTP request to url when tapped.
static final record	NtfyAction.HttpHeader	A single request header (name/value) carried by an NtfyAction.Http action.
static final record	NtfyAction.View	Opens url in the browser/app when the action button is tapped.

Method Summary

Modifier and Type	Method	Description
static NtfyAction.Broadcast	broadcast(String label, NtfyAction.BroadcastExtra... extras)	A broadcast action sending ntfy's default intent, with optional extras.
static NtfyAction.Broadcast	broadcast(String label, String intent, boolean clear, NtfyAction.BroadcastExtra... extras)	A broadcast action sending intent (blank uses ntfy's default) with an explicit clear flag dismissing the notification on tap, plus optional extras.
static NtfyAction.Broadcast	broadcast(String label, String intent, NtfyAction.BroadcastExtra... extras)	A broadcast action sending intent (blank uses ntfy's default), with extras.
static NtfyAction.Http	http(String label, String url)	An http action sending a GET to url when tapped.
static NtfyAction.Http	http(String label, String url, String method, String body)	An http action sending method (with optional body) to url.
static NtfyAction.Http	http(String label, String url, String method, String body, boolean clear, NtfyAction.HttpHeader... headers)	An http action as http(String, String, String, String, HttpHeader...) but with an explicit clear flag dismissing the notification on tap.
static NtfyAction.Http	http(String label, String url, String method, String body, NtfyAction.HttpHeader... headers)	An http action sending method (with optional body) to url, carrying the given request headers (e.g.
String	label()	The button label shown in the notification.
static NtfyAction.View	view(String label, String url)	A view action opening url when tapped.
static NtfyAction.View	view(String label, String url, boolean clear)	A view action opening url; clear dismisses the notification on tap.

Method Details

label

String label()

The button label shown in the notification.

view

static NtfyAction.View view(String label,
 String url)

A view action opening url when tapped.

view

static NtfyAction.View view(String label,
 String url,
 boolean clear)

A view action opening url; clear dismisses the notification on tap.

http

static NtfyAction.Http http(String label,
 String url)

An http action sending a GET to url when tapped.

http

static NtfyAction.Http http(String label,
 String url,
 String method,
 String body)

An http action sending method (with optional body) to url.

http

static NtfyAction.Http http(String label,
 String url,
 String method,
 String body,
 NtfyAction.HttpHeader... headers)

An http action sending method (with optional body) to url, carrying the given request headers (e.g. Authorization).

http

static NtfyAction.Http http(String label,
 String url,
 String method,
 String body,
 boolean clear,
 NtfyAction.HttpHeader... headers)

An http action as http(String, String, String, String, HttpHeader...) but with an explicit clear flag dismissing the notification on tap.

broadcast

static NtfyAction.Broadcast broadcast(String label,
 NtfyAction.BroadcastExtra... extras)

A broadcast action sending ntfy's default intent, with optional extras.

broadcast

static NtfyAction.Broadcast broadcast(String label,
 String intent,
 NtfyAction.BroadcastExtra... extras)

A broadcast action sending intent (blank uses ntfy's default), with extras.

broadcast

static NtfyAction.Broadcast broadcast(String label,
 String intent,
 boolean clear,
 NtfyAction.BroadcastExtra... extras)

A broadcast action sending intent (blank uses ntfy's default) with an explicit clear flag dismissing the notification on tap, plus optional extras.