docs: TSDoc + reference of fulfillment service (#5761)

This commit is contained in:
Shahed Nasser
2023-11-29 11:58:08 +00:00
committed by GitHub
parent 8f25ed8a10
commit f802e2460f
1479 changed files with 30259 additions and 16135 deletions

View File

@@ -10,13 +10,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [INotificationService](../interfaces/INotificationService.mdx)
## Constructors
#### constructor
## constructor
`Protected **new AbstractNotificationService**(__container__, __configModule__?, __moduleDeclaration__?)`
##### Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -48,6 +46,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Properties
<ParameterTypes parameters={[
@@ -107,15 +107,35 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Accessors
#### activeManager\_
### activeManager\_
`Protected` **activeManager\_**: [object Object]
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
## Methods
#### atomicPhase\_
### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -123,7 +143,7 @@ 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
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -146,7 +166,7 @@ transaction manager is created.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -178,7 +198,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
Promise&#60;TResult&#62;
@@ -196,11 +216,11 @@ Promise&#60;TResult&#62;
___
#### getIdentifier
### getIdentifier
`**getIdentifier**(): string`
##### Returns
#### Returns
`string`
@@ -218,11 +238,11 @@ ___
___
#### resendNotification
### resendNotification
`Abstract **resendNotification**(notification, config, attachmentGenerator): Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -254,7 +274,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;
@@ -272,11 +292,11 @@ Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;
___
#### sendNotification
### sendNotification
`Abstract **sendNotification**(event, data, attachmentGenerator): Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -308,7 +328,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;
@@ -326,11 +346,11 @@ Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -344,7 +364,7 @@ ___
}
]} />
##### Returns
#### Returns
`boolean`
@@ -362,11 +382,11 @@ ___
___
#### withTransaction
### withTransaction
`**withTransaction**(transactionManager?): [AbstractNotificationService](AbstractNotificationService.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -380,7 +400,7 @@ ___
}
]} />
##### Returns
#### Returns
[AbstractNotificationService](AbstractNotificationService.mdx)