Class NotificationsClient

Implements

NotificationsApi

Index

Constructors

Methods

getNotification getNotifications getNotificationSettings getStatus getTopics updateNotifications updateNotificationSettings

Constructors

constructor

new NotificationsClient(
options: { discoveryApi: DiscoveryApi; fetchApi: FetchApi },
): NotificationsClient
Parameters
- options: { discoveryApi: DiscoveryApi; fetchApi: FetchApi }
Returns NotificationsClient
- Defined in plugins/notifications/src/api/NotificationsClient.ts:38

Methods

getNotification

getNotification(id: string): Promise<Notification>
Parameters
- id: string
Returns Promise<Notification>
Implementation of NotificationsApi.getNotification
- Defined in plugins/notifications/src/api/NotificationsClient.ts:74

getNotifications

getNotifications(
options?: GetNotificationsOptions,
): Promise<GetNotificationsResponse>
Parameters
- Optionaloptions: GetNotificationsOptions
Returns Promise<GetNotificationsResponse>
Implementation of NotificationsApi.getNotifications
- Defined in plugins/notifications/src/api/NotificationsClient.ts:46

getNotificationSettings

getNotificationSettings(): Promise<NotificationSettings>
Returns Promise<NotificationSettings>
Implementation of NotificationsApi.getNotificationSettings
- Defined in plugins/notifications/src/api/NotificationsClient.ts:94

getStatus

getStatus(): Promise<NotificationStatus>
Returns Promise<NotificationStatus>
Implementation of NotificationsApi.getStatus
- Defined in plugins/notifications/src/api/NotificationsClient.ts:80

getTopics

getTopics(options?: GetNotificationsCommonOptions): Promise<GetTopicsResponse>
Parameters
- Optionaloptions: GetNotificationsCommonOptions
Returns Promise<GetTopicsResponse>
Implementation of NotificationsApi.getTopics
- Defined in plugins/notifications/src/api/NotificationsClient.ts:108

updateNotifications

updateNotifications(
options: UpdateNotificationsOptions,
): Promise<Notification[]>
Parameters
- options: UpdateNotificationsOptions
Returns Promise<Notification[]>
Implementation of NotificationsApi.updateNotifications
- Defined in plugins/notifications/src/api/NotificationsClient.ts:84

updateNotificationSettings

updateNotificationSettings(
settings: NotificationSettings,
): Promise<NotificationSettings>
Parameters
- settings: NotificationSettings
Returns Promise<NotificationSettings>
Implementation of NotificationsApi.updateNotificationSettings
- Defined in plugins/notifications/src/api/NotificationsClient.ts:98