NotificationService

Hierarchy

• TransactionBaseService

  ↳ NotificationService

Constructors

constructor

new NotificationService(container)

Parameters

Name
container

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/notification.ts:34

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

medusa/src/interfaces/transaction-base-service.ts:14

---

__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

medusa/src/interfaces/transaction-base-service.ts:13

---

__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15

---

attachmentGenerator_

Protected attachmentGenerator_: unknown = null

Defined in

medusa/src/services/notification.ts:25

---

container_

Protected Readonly container_: InjectedDependencies & {}

Defined in

medusa/src/services/notification.ts:26

---

logger_

Protected Readonly logger_: Logger

Defined in

medusa/src/services/notification.ts:29

---

manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

---

notificationProviderRepository_

Protected Readonly notificationProviderRepository_: Repository<NotificationProvider>

Defined in

medusa/src/services/notification.ts:32

---

notificationRepository_

Protected Readonly notificationRepository_: Repository<Notification>

Defined in

medusa/src/services/notification.ts:30

---

subscribers_

Protected subscribers_: object = {}

Defined in

medusa/src/services/notification.ts:24

---

transactionManager_

Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

Accessors

activeManager_

Protected get activeManager_(): EntityManager

Returns

EntityManager

-EntityManager:

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

Methods

atomicPhase_

Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Name
TResult
TError

Parameters

Name	Description
work	(transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

-Promise: the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56

---

handleEvent

handleEvent(eventName, data): Promise<undefined | void | Notification[]>

Handles an event by relaying the event data to the subscribing providers. The result of the notification send will be persisted in the database in order to allow for resends. Will log any errors that are encountered.

Parameters

Name	Description
eventName	string
data	Record<string, unknown>

Returns

Promise<undefined | void | Notification[]>

-Promise: the result of notification subscribed -undefined \| void \| Notification[]: (optional)

Defined in

medusa/src/services/notification.ts:185

---

list

list(selector, config?): Promise<Notification[]>

Retrieves a list of notifications.

Parameters

Name	Description
selector	Selector<Notification>
config	FindConfig<Notification>

Returns

Promise<Notification[]>

-Promise: the notifications that satisfy the query. -Notification[]: -Notification:

Defined in

medusa/src/services/notification.ts:78

---

listAndCount

listAndCount(selector, config?): Promise<[Notification[], number]>

Retrieves a list of notifications and total count.

Parameters

Name	Description
selector	Selector<Notification>
config	FindConfig<Notification>

Returns

Promise<[Notification[], number]>

-Promise: the notifications that satisfy the query as well as the count. -Notification[]: -number: (optional)

Defined in

medusa/src/services/notification.ts:97

---

registerAttachmentGenerator

registerAttachmentGenerator(service): void

Registers an attachment generator to the service. The generator can be used to generate on demand invoices or other documents.

Parameters

Name	Description
service	unknown

Returns

void

-void: (optional)

Defined in

medusa/src/services/notification.ts:52

---

registerInstalledProviders

registerInstalledProviders(providerIds): Promise<void>

Takes a list of notification provider ids and persists them in the database.

Parameters

Name	Description
providerIds	string[]

Returns

Promise<void>

-Promise:

Defined in

medusa/src/services/notification.ts:60

---

resend

resend(id, config?): Promise<Notification>

Resends a notification by retrieving a prior notification and calling the underlying provider's resendNotification method.

Parameters

Name	Description
id	string
config	FindConfig<Notification>

Returns

Promise<Notification>

-Promise: the newly created notification -Notification:

Defined in

medusa/src/services/notification.ts:265

---

retrieve

retrieve(id, config?): Promise<Notification>

Retrieves a notification with a given id

Parameters

Name	Description
id	string
config	FindConfig<Notification>

Returns

Promise<Notification>

-Promise: the notification -Notification:

Defined in

medusa/src/services/notification.ts:118

---

retrieveProvider_

Protected retrieveProvider_(id): AbstractNotificationService

Finds a provider with a given id. Will throw a NOT_FOUND error if the resolution fails.

Parameters

Name	Description
id	string

Returns

AbstractNotificationService

-AbstractNotificationService: the notification provider

Defined in

medusa/src/services/notification.ts:166

---

send

send(event, eventData, providerId): Promise<undefined | Notification>

Sends a notification, by calling the given provider's sendNotification method. Persists the Notification in the database.

Parameters

Name	Description
event	string
eventData	Record<string, unknown>
providerId	string

Returns

Promise<undefined | Notification>

-Promise: the created notification -undefined \| Notification: (optional)

Defined in

medusa/src/services/notification.ts:217

---

shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

Name
err

Returns

boolean

-boolean: (optional)

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

---

subscribe

subscribe(eventName, providerId): void

Subscribes a given provider to an event.

Parameters

Name	Description
eventName	string
providerId	string

Returns

void

-void: (optional)

Defined in

medusa/src/services/notification.ts:145

---

withTransaction

withTransaction(transactionManager?): NotificationService

Parameters

Name
transactionManager?

Returns

NotificationService

-NotificationService:

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20