Interface NotificationsAPI

interface NotificationsAPI {
    clearCache: () => void;
    getNotifications: (
        query: {
            locale?: string;
            manageableInHub?: boolean;
            subscribable?: boolean;
        },
        options?: ApiCallOptions,
    ) => Promise<GetNotificationsHttpResponse>;
}
Index

Properties

clearCache getNotifications

Properties

clearCache: () => void

Clears the cache for notifications api requests.

Type Declaration

    • (): void

    • Clears the cache for notifications api requests.

      Returns void

getNotifications: (
    query: {
        locale?: string;
        manageableInHub?: boolean;
        subscribable?: boolean;
    },
    options?: ApiCallOptions,
) => Promise<GetNotificationsHttpResponse>

List all supported notifications

Type Declaration

    • (
          query: {
              locale?: string;
              manageableInHub?: boolean;
              subscribable?: boolean;
          },
          options?: ApiCallOptions,
      ): Promise<GetNotificationsHttpResponse>

    • List all supported notifications

      Parameters

      • query: { locale?: string; manageableInHub?: boolean; subscribable?: boolean }

        an object with query parameters

        • Optionallocale?: string

          If present, idenfies the language of the returned 'friendlyName' property.

        • OptionalmanageableInHub?: boolean

          If present, represents the 'manageableInHub' value to filter by.

        • Optionalsubscribable?: boolean

          If present, represents the 'subscribable' value to filter by.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetNotificationsHttpResponse>

      GetNotificationsHttpError

an object with query parameters

GetNotificationsHttpError

Settings

Member Visibility

On This Page

Properties