@openfin/cloud-notification-core-api 0.0.1-alpha.95e2c08 → 0.0.1-alpha.9608686

package/README.md

@@ -1,13 +1,13 @@
 # @openfin/cloud-notification-core-api
 
-This package contains the core notification library that handles all interactions with the Here™ Cloud Notification Service.
+This package contains the core notification library that handles all interactions with the HERE Cloud Notification Service.
 
 It is callable via browser or node applications.
 
 
 ## Authentication
 
-The library supports authentication with the Here™ Cloud Notification Service using the following methods:
+The library supports authentication with the HERE Cloud Notification Service using the following methods:
  - Basic Authentication
  - JWT Token Authentication
  - Default Authentication i.e. Interactive session based authentication using cookies

package/bundle.d.ts

@@ -85,13 +85,13 @@ export declare class CloudNotificationAPI {
           /**
            * Posts a notification event to the Cloud Notification service.
            *
-           * @param notificationId - The ID of the notification.
+           * @param notificationId - The ID of the notification or an array of notification IDs.
            * @param event - The event details, including category, type, and optional payload.
            * @returns A promise that resolves when the event is posted.
            * @throws {@link SessionNotConnectedError} If the session is not connected.
                * @throws {@link PublishError} If an error occurs during publishing.
                    */
-               postNotificationEvent(notificationId: string, event: {
+               postNotificationEvent(notificationId: string | string[], event: {
                    category: string;
                    type: string;
                    payload?: unknown;
@@ -107,22 +107,22 @@ export declare class CloudNotificationAPI {
                /**
                 * Post a notification-reminder-created event to the Cloud Notification service.
                 *
-                * @param notificationId - The ID of the notification to mark as a reminder.
+                * @param notificationId - The ID of the notification or an array of notification IDs to mark as a reminder.
                 * @param payload - The payload of the reminder.
                 * @returns A promise that resolves when the notification-reminder-created event is posted.
                 * @throws {@link SessionNotConnectedError} If the session is not connected.
                     */
                 setReminder<T extends {
                     reminderDate: Date;
-                }>(notificationId: string, payload: T, targets: NotificationTargets): Promise<void>;
+                }>(notificationId: string | string[], payload: T, targets: NotificationTargets): Promise<void>;
                 /**
                  * Post a notification-reminder-removed event to the Cloud Notification service.
                  *
-                 * @param notificationId - The ID of the notification to cancel the reminder for.
+                 * @param notificationId - The ID of the notification or an array of notification IDs to cancel the reminder for.
                  * @returns A promise that resolves when the notification-reminder-removed event is posted.
                  * @throws {@link SessionNotConnectedError} If the session is not connected.
                      */
-                 cancelReminder(notificationId: string, targets: NotificationTargets): Promise<void>;
+                 cancelReminder(notificationId: string | string[], targets: NotificationTargets): Promise<void>;
                  /**
                   * Raises a notification to the Cloud Notification service.
                   *
@@ -152,7 +152,7 @@ export declare class CloudNotificationAPI {
                             * @returns A promise that resolves when the notification is deleted.
                             * @throws {@link SessionNotConnectedError} If the session is not connected.
                                 */
-                            deleteNotification(notificationId: string): Promise<void>;
+                            deleteNotification(notificationId: string | string[]): Promise<void>;
                             /**
                              * Replays notifications from the Cloud Notification service.
                              *
@@ -420,6 +420,10 @@ export declare class CloudNotificationAPI {
                                   * The source identifier
                                   */
                                  sourceId: string;
+                                 /**
+                                  * The originating session identifier
+                                  */
+                                 originatingSessionId: string;
                                  /**
                                   * The platform identifier
                                   */