ClientHookApi
Defined in: hooks.ts:129
Properties
Section titled “Properties”desktopNotify
Section titled “desktopNotify”desktopNotify: (
title,body,icon?) =>void
Defined in: hooks.ts:138
Parameters
Section titled “Parameters”string
string
string
Returns
Section titled “Returns”void
getSettings
Section titled “getSettings”getSettings: () =>
Record<string,unknown>
Defined in: hooks.ts:145
Notification-relevant app settings only (keys starting with notify,
sound, haptics, desktopNotification, quietHours, volume). Hooks never see
the full settings object — fetch your own plugin’s settings via
/api/plugin-settings/:pluginId if you need more.
Returns
Section titled “Returns”Record<string, unknown>
haptic
Section titled “haptic”haptic:
object
Defined in: hooks.ts:132
error: () =>
void
Returns
Section titled “Returns”void
success
Section titled “success”success: () =>
void
Returns
Section titled “Returns”void
tap: () =>
void
Returns
Section titled “Returns”void
warning
Section titled “warning”warning: () =>
void
Returns
Section titled “Returns”void
isWindowFocused
Section titled “isWindowFocused”isWindowFocused: () =>
boolean
Defined in: hooks.ts:146
Returns
Section titled “Returns”boolean
playSound
Section titled “playSound”playSound: (
name) =>void
Defined in: hooks.ts:130
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
showToast
Section titled “showToast”showToast: (
opts,type?) =>void
Defined in: hooks.ts:131
Parameters
Section titled “Parameters”actions?
Section titled “actions?”unknown[]
description?
Section titled “description?”string
groupKey?
Section titled “groupKey?”string
string
string
"error" | "warning" | "info" | "success"
Returns
Section titled “Returns”void