Interface NotificationRecipientResolver

NotificationRecipientResolver interface is used to resolve the individual users to receive the notification.

The resolveNotificationRecipients is used to resolve notifications sent for entity references, and it should return object with a list of user entity references that should receive the notification. In case the function returns other than user entity references, those are ignored.

interface NotificationRecipientResolver {
    resolveNotificationRecipients(
        options: { entityRefs: string[]; excludedEntityRefs?: string[] },
    ): Promise<{ userEntityRefs: string[] }>;
}

Index

Methods

resolveNotificationRecipients

Methods

resolveNotificationRecipients

resolveNotificationRecipients(
options: { entityRefs: string[]; excludedEntityRefs?: string[] },
): Promise<{ userEntityRefs: string[] }>
Parameters
- options: { entityRefs: string[]; excludedEntityRefs?: string[] }
Returns Promise<{ userEntityRefs: string[] }>
- Defined in plugins/notifications-node/src/extensions.ts:115

Interface NotificationRecipientResolver

Index

Methods

Methods

resolveNotificationRecipients

Parameters

Returns Promise<{ userEntityRefs: string[] }>

Settings

On This Page