BulkMessageSender
Defined in: packages/messaging/src/sender/bulk.sender.ts:22
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BulkMessageSender(
kmsg):BulkMessageSender
Defined in: packages/messaging/src/sender/bulk.sender.ts:26
Parameters
Section titled “Parameters”Returns
Section titled “Returns”BulkMessageSender
Methods
Section titled “Methods”cancelBulkJob()
Section titled “cancelBulkJob()”cancelBulkJob(
requestId):Promise<boolean>
Defined in: packages/messaging/src/sender/bulk.sender.ts:373
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
Returns
Section titled “Returns”Promise<boolean>
cleanup()
Section titled “cleanup()”cleanup():
void
Defined in: packages/messaging/src/sender/bulk.sender.ts:439
Returns
Section titled “Returns”void
getBulkStatus()
Section titled “getBulkStatus()”getBulkStatus(
requestId):Promise<BulkMessageResult|null>
Defined in: packages/messaging/src/sender/bulk.sender.ts:368
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
Returns
Section titled “Returns”Promise<BulkMessageResult | null>
retryFailedBatch()
Section titled “retryFailedBatch()”retryFailedBatch(
requestId,batchId):Promise<BulkBatchResult|null>
Defined in: packages/messaging/src/sender/bulk.sender.ts:392
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
batchId
Section titled “batchId”string
Returns
Section titled “Returns”Promise<BulkBatchResult | null>
sendBulk()
Section titled “sendBulk()”sendBulk(
request):Promise<BulkMessageResult>
Defined in: packages/messaging/src/sender/bulk.sender.ts:30
Parameters
Section titled “Parameters”request
Section titled “request”Returns
Section titled “Returns”Promise<BulkMessageResult>