11 KiB
Class: NotificationService
Hierarchy
-
TransactionBaseService↳
NotificationService
Constructors
constructor
• new NotificationService(container)
Parameters
| Name | Type |
|---|---|
container |
InjectedDependencies |
Overrides
TransactionBaseService.constructor
Defined in
packages/medusa/src/services/notification.ts:36
Properties
__configModule__
• Protected Optional Readonly __configModule__: Record<string, unknown>
Inherited from
TransactionBaseService.__configModule__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:10
__container__
• Protected Readonly __container__: any
Inherited from
TransactionBaseService.__container__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:9
attachmentGenerator_
• Protected attachmentGenerator_: unknown = null
Defined in
packages/medusa/src/services/notification.ts:27
container_
• Protected Readonly container_: InjectedDependencies & {}
Defined in
packages/medusa/src/services/notification.ts:28
logger_
• Protected Readonly logger_: Logger
Defined in
packages/medusa/src/services/notification.ts:31
manager_
• Protected manager_: EntityManager
Overrides
TransactionBaseService.manager_
Defined in
packages/medusa/src/services/notification.ts:23
notificationProviderRepository_
• Protected Readonly notificationProviderRepository_: typeof NotificationProviderRepository
Defined in
packages/medusa/src/services/notification.ts:34
notificationRepository_
• Protected Readonly notificationRepository_: typeof NotificationRepository
Defined in
packages/medusa/src/services/notification.ts:32
subscribers_
• Protected subscribers_: Object = {}
Defined in
packages/medusa/src/services/notification.ts:26
transactionManager_
• Protected transactionManager_: undefined | EntityManager
Overrides
TransactionBaseService.transactionManager_
Defined in
packages/medusa/src/services/notification.ts:24
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/src/interfaces/transaction-base-service.ts:50
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/src/services/notification.ts:174
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/src/services/notification.ts:86
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/src/services/notification.ts:62
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/src/services/notification.ts:70
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/src/services/notification.ts:254
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/src/services/notification.ts:107
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/src/services/notification.ts:155
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 hande the event. |
Returns
Promise<undefined | Notification>
the created notification
Defined in
packages/medusa/src/services/notification.ts:206
shouldRetryTransaction_
▸ Protected shouldRetryTransaction_(err): boolean
Parameters
| Name | Type |
|---|---|
err |
Record<string, unknown> | { code: string } |
Returns
boolean
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:31
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/src/services/notification.ts:134
withTransaction
▸ withTransaction(transactionManager?): NotificationService
Parameters
| Name | Type |
|---|---|
transactionManager? |
EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:13