Skip to main content

NotificationService

@webda/core • Readme | API

Interface: NotificationService

Define a service that can notify a user based on his info It can use email or SMS or any other media

Extended by​

Methods​

handleNotificationFor()​

handleNotificationFor(userOrIdent): Promise<boolean>

Check if the service can deliver notification to this user

Parameters​

• userOrIdent: User | Ident

Returns​

Promise<boolean>

Source​

packages/core/src/services/notificationservice.ts:18

hasNotification()​

hasNotification(notification): Promise<boolean>

Check if this type of notification is available

Parameters​

• notification: string

Returns​

Promise<boolean>

Source​

packages/core/src/services/notificationservice.ts:13

sendNotification()​

sendNotification(user, notification, replacements): Promise<void>

Send the notification to the user

Parameters​

• user: User | Ident

• notification: string

• replacements: any

Returns​

Promise<void>

Source​

packages/core/src/services/notificationservice.ts:25