Commit 0880654 1 parent 7f3bbef commit 0880654 Copy full SHA for 0880654
File tree 2 files changed +9
-1
lines changed
packages/lib/delivery/src/notifications
2 files changed +9
-1
lines changed Original file line number Diff line number Diff line change @@ -50,7 +50,8 @@ export const _setupNotficationBroker = (
50
50
51
51
/**
52
52
* Creates a notification broker based on the provided notification channels.
53
- * @param {DeliveryServiceProperties } options - Delivery service properties including notification channels.
53
+ * @param {NotificationChannel[] } notificationChannel - All notification channels of a delivery service.
54
+ * @param {NotificationType } notificationType - Specifies type of notifications like : New message , OTP etc..
54
55
* @returns {INotificationBroker } An instance of the notification broker.
55
56
* @throws {Error } If an unsupported channel type is encountered.
56
57
*/
Original file line number Diff line number Diff line change 1
1
import { DeliveryInformation } from '@dm3-org/dm3-lib-messaging' ;
2
2
3
3
//Every notification channel that is supported by the delivery service must be listed here
4
+ // Notification channel is medium of getting notified. It can be email, phone no. push notification etc...
4
5
export enum NotificationChannelType {
5
6
EMAIL = 'EMAIL' ,
6
7
}
7
8
9
+ /**
10
+ * Notification type describes which kind of notification it is :
11
+ * 1. New Message
12
+ * 2. Verification OTP
13
+ * etc...
14
+ */
8
15
export enum NotificationType {
9
16
NEW_MESSAGE = 'NEW_MESSAGE' ,
10
17
OTP = 'OTP' ,
You can’t perform that action at this time.
0 commit comments