medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.NotificationService.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: NotificationService

internal.internal.NotificationService

Hierarchy

• TransactionBaseService

  ↳ NotificationService

Properties

__configModule__

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.configModule

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:5

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.container

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:4

---

__moduleDeclaration__

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.moduleDeclaration

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:6

---

attachmentGenerator_

• Protected attachmentGenerator_: unknown

Defined in

packages/medusa/dist/services/notification.d.ts:17

---

container_

• Protected Readonly container_: InjectedDependencies & {}

Defined in

packages/medusa/dist/services/notification.d.ts:18

---

logger_

• Protected Readonly logger_: Logger

Defined in

packages/medusa/dist/services/notification.d.ts:21

---

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:7

---

notificationProviderRepository_

• Protected Readonly notificationProviderRepository_: Repository<NotificationProvider>

Defined in

packages/medusa/dist/services/notification.d.ts:23

---

notificationRepository_

• Protected Readonly notificationRepository_: Repository<Notification>

Defined in

packages/medusa/dist/services/notification.d.ts:22

---

subscribers_

• Protected subscribers_: Object

Defined in

packages/medusa/dist/services/notification.d.ts:16

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:8

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:9

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.

Type parameters

Name
TResult
TError

Parameters

Name	Type	Description
work	(transactionManager: EntityManager) => Promise<TResult>	the transactional work to be done
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>	the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>	Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:24

---

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	Type	Description
eventName	string	the event to handle
data	Record<string, unknown>	the data the event was sent with

Returns

Promise<undefined | void | Notification[]>

the result of notification subscribed

Defined in

packages/medusa/dist/services/notification.d.ts:78

---

list

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

Retrieves a list of notifications.

Parameters

Name	Type	Description
selector	Selector<Notification>	the params to select the notifications by.
config?	FindConfig<Notification>	the configuration to apply to the query

Returns

Promise<Notification[]>

the notifications that satisfy the query.

Defined in

packages/medusa/dist/services/notification.d.ts:42

---

listAndCount

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

Retrieves a list of notifications and total count.

Parameters

Name	Type	Description
selector	Selector<Notification>	the params to select the notifications by.
config?	FindConfig<Notification>	the configuration to apply to the query

Returns

Promise<[Notification[], number]>

the notifications that satisfy the query as well as the count.

Defined in

packages/medusa/dist/services/notification.d.ts:49

---

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	Type	Description
service	unknown	the service to assign to the attachmentGenerator

Returns

void

Defined in

packages/medusa/dist/services/notification.d.ts:30

---

registerInstalledProviders

▸ registerInstalledProviders(providerIds): Promise<void>

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

Parameters

Name	Type	Description
providerIds	string[]	a list of provider ids

Returns

Promise<void>

Defined in

packages/medusa/dist/services/notification.d.ts:35

---

resend

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

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

Parameters

Name	Type	Description
id	string	the id of the notification
config?	FindConfig<Notification>	any configuration that might override the previous send

Returns

Promise<Notification>

the newly created notification

Defined in

packages/medusa/dist/services/notification.d.ts:96

---

retrieve

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

Retrieves a notification with a given id

Parameters

Name	Type	Description
id	string	the id of the notification
config?	FindConfig<Notification>	the configuration to apply to the query

Returns

Promise<Notification>

the notification

Defined in

packages/medusa/dist/services/notification.d.ts:56

---

retrieveProvider_

▸ Protected retrieveProvider_(id): AbstractNotificationService

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

Parameters

Name	Type	Description
id	string	the id of the provider

Returns

AbstractNotificationService

the notification provider

Defined in

packages/medusa/dist/services/notification.d.ts:69

---

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	Type	Description
event	string	the name of the event
eventData	Record<string, unknown>	the data the event was sent with
providerId	string	the provider that should handle the event.

Returns

Promise<undefined | Notification>

the created notification

Defined in

packages/medusa/dist/services/notification.d.ts:87

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
err	Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:12

---

subscribe

▸ subscribe(eventName, providerId): void

Subscribes a given provider to an event.

Parameters

Name	Type	Description
eventName	string	the event to subscribe to
providerId	string	the provider that the event will be sent to

Returns

void

Defined in

packages/medusa/dist/services/notification.d.ts:62

---

withTransaction

▸ withTransaction(transactionManager?): NotificationService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

NotificationService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:11