Observe notification summary information

Overview #

This method allows you to observe summary information about the current user's notifications, including live updates.

import { notification } from '@cord-sdk/react';
const summary = notification.useSummary();

const ref = window.CordSDK.notification.observeSummary(callback);
window.CordSDK.notification.unobserveSummary(ref);

import { notification } from '@cord-sdk/react';
const summary = notification.useSummary();

Usage #

import { notification } from '@cord-sdk/react';
const summary = notification.useSummary();
return (
  <div>
    {!summary && "Loading..."}
    {summary && (
      <p>Unread notifications: {summary.unread}</p>
    )}
  </div>
);

const ref = window.CordSDK.notification.observeSummary(
  (summary) => {
    // Received an update!
    console.log("Unread notifications", summary.unread);
  });
);
// ... Later, when updates are no longer needed ...
window.CordSDK.notification.unobserveSummary(ref);

import { notification } from '@cord-sdk/react';
const summary = notification.useSummary();
return (
  <div>
    {!summary && "Loading..."}
    {summary && (
      <p>Unread notifications: {summary.unread}</p>
    )}
  </div>
);

Available Data #

The API provides an object which has the following fields:

What this function returns #

The hook will initially return undefined while the data loads from our API. Once it has loaded, your component will re-render and the hook will return an object containing the fields described under "Available Data" above. The component will automatically re-render if any of the data changes, i.e., this data is always "live".

Arguments this function takes #