Skip to main content

CnNotificationPreferences

A self-contained NcAppSettingsSection that lets the current user turn the notifications declared by their accessible schemas on or off. It is the default content of CnAppRoot's #user-settings slot, so apps adopting the manifest shell get a working notification-preferences panel for free.

What it does​

CnNotificationPreferences reads the effective preferences (each schema's default merged with the user's overrides) and writes override-only values, both through OpenRegister's notification-preferences endpoint:

GET  /apps/openregister/api/notification-preferences
→ { results: [{ schema, schemaTitle, notification, enabled, channels, source }], total }

PUT /apps/openregister/api/notification-preferences
→ { schema, notification, enabled } // set an override
→ { schema, notification, reset: true } // clear the override

Preferences are override-only: leaving an item unchanged keeps the app default, so apps that add new schemas or notifications keep working with no per-user migration. A "Reset to default" action appears on any item the user has overridden, removing the override.

The panel groups the flat preference list by schema (schemaTitle as the heading) and renders one switch per notification. It degrades gracefully:

  • Loading — a spinner while the GET is in flight.
  • Unavailable — an empty state when OpenRegister can't be reached (the feature is OpenRegister-provided, so the panel is optional per instance).
  • No notifications — an empty state when the user's schemas declare none.

Props, events, slots​

This component is self-contained: it needs no props, emits no events, and exposes no named slots — it fetches and persists its own state.

PropTypeDefaultDescription
labelsObjectnullOptional labels for the notification rules, keyed <schema>.<key> or <key>; values are strings or per-locale maps. Wins over the cnNotificationLabels map a CnAppRoot ancestor provides from its notificationLabels prop. See notificationRuleLabel for the full order.
via CnAppRoot's #user-settings slot, which mounts it by default).

Usage​

<template>
<NcAppSettingsDialog v-model:open="open" :name="t('myapp', 'Settings')">
<CnNotificationPreferences />
</NcAppSettingsDialog>
</template>

<script>
import { CnNotificationPreferences } from '@conduction/nextcloud-vue'

export default {
components: { CnNotificationPreferences },
data() {
return { open: false }
},
}
</script>
  • CnAppRoot — mounts this component in its #user-settings slot by default.

When to reach for CnNotificationMatrix instead​

CnNotificationMatrix answers the same question with more of the answer: four levels rather than two, a channel axis, a scope per row, a digest and a test send. Most usefully, it shows a preference an administrator has forced and a channel the platform refuses for this recipient, neither of which this pane can express. A person reading this pane can therefore switch something off, keep receiving it, and see nothing that says why.

This pane is not deprecated and is not going away on its own: CnAppRoot mounts it as the default of its #user-settings slot, so every app adopting the manifest shell gets it without passing anything. Prefer the matrix for a NEW screen where the host owns the catalogue.

The migration is not a rename. The matrix renders what it is given and fetches nothing, so moving means the host reads the preferences itself and maps them onto events, channels, groupValues, personalValues, forcedValues and refusals. useNotificationPreferencesStore does the reading and writing, and dossiq's src/services/notificationPreferenceProps.js is a worked example of the mapping, including what to do when the platform answers without a channel axis.