Skip to content
StudioCMS Docs
Main Site
Live Demo

lib/notifier/client

Type Aliases

Section titled “Type Aliases”

UserNotificationOptions

Section titled “UserNotificationOptions”
type UserNotificationOptions = typeof notificationOptions[number];

Defined in: studiocms/packages/studiocms/src/lib/notifier/client.ts:14

Functions

Section titled “Functions”

formatNotificationOptions()

Section titled “formatNotificationOptions()”
function formatNotificationOptions(options: (
  | "account_updated"
  | "page_updated"
  | "page_deleted"
  | "new_page"
  | "folder_updated"
  | "folder_deleted"
  | "new_folder"
  | "user_updated"
  | "user_deleted"
  | "new_user")[]): string

Defined in: studiocms/packages/studiocms/src/lib/notifier/client.ts:21

Parameters

Section titled “Parameters”
options
Section titled “options”

( | "account_updated" | "page_updated" | "page_deleted" | "new_page" | "folder_updated" | "folder_deleted" | "new_folder" | "user_updated" | "user_deleted" | "new_user")[]

Returns

Section titled “Returns”

string

getEnabledNotificationCheckboxes()

Section titled “getEnabledNotificationCheckboxes()”
function getEnabledNotificationCheckboxes(formData: FormData): (
  | "account_updated"
  | "page_updated"
  | "page_deleted"
  | "new_page"
  | "folder_updated"
  | "folder_deleted"
  | "new_folder"
  | "user_updated"
  | "user_deleted"
  | "new_user")[]

Defined in: studiocms/packages/studiocms/src/lib/notifier/client.ts:16

Parameters

Section titled “Parameters”
formData
Section titled “formData”

FormData

Returns

Section titled “Returns”

( | "account_updated" | "page_updated" | "page_deleted" | "new_page" | "folder_updated" | "folder_deleted" | "new_folder" | "user_updated" | "user_deleted" | "new_user")[]