DeliveryTrackingService
Defined in: packages/messaging/src/delivery-tracking/service.ts:231
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DeliveryTrackingService(
config):DeliveryTrackingService
Defined in: packages/messaging/src/delivery-tracking/service.ts:251
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”DeliveryTrackingService
Methods
Section titled “Methods”close()
Section titled “close()”close():
Promise<void>
Defined in: packages/messaging/src/delivery-tracking/service.ts:310
Stops polling and closes the store. A poll in progress, including one
still setting up the store, stops as if its signal had aborted, and
close() waits for it to store the statuses it has before closing the
store; status changes still being delivered to onStatusChange are not
waited for. The service does not poll again.
Returns
Section titled “Returns”Promise<void>
countBy()
Section titled “countBy()”countBy(
filter,groupBy):Promise<DeliveryTrackingCountByRow[]>
Defined in: packages/messaging/src/delivery-tracking/service.ts:418
Parameters
Section titled “Parameters”filter
Section titled “filter”groupBy
Section titled “groupBy”readonly DeliveryTrackingCountByField[]
Returns
Section titled “Returns”Promise<DeliveryTrackingCountByRow[]>
countRecords()
Section titled “countRecords()”countRecords(
filter):Promise<number>
Defined in: packages/messaging/src/delivery-tracking/service.ts:412
Parameters
Section titled “Parameters”filter
Section titled “filter”Returns
Section titled “Returns”Promise<number>
getRecord()
Section titled “getRecord()”getRecord(
messageId):Promise<TrackingRecord|undefined>
Defined in: packages/messaging/src/delivery-tracking/service.ts:399
Parameters
Section titled “Parameters”messageId
Section titled “messageId”string
Returns
Section titled “Returns”Promise<TrackingRecord | undefined>
init()
Section titled “init()”init():
Promise<void>
Defined in: packages/messaging/src/delivery-tracking/service.ts:279
Returns
Section titled “Returns”Promise<void>
listRecords()
Section titled “listRecords()”listRecords(
options):Promise<TrackingRecord[]>
Defined in: packages/messaging/src/delivery-tracking/service.ts:404
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<TrackingRecord[]>
recordSend()
Section titled “recordSend()”recordSend(
context,result):Promise<void>
Defined in: packages/messaging/src/delivery-tracking/service.ts:319
Parameters
Section titled “Parameters”context
Section titled “context”result
Section titled “result”Returns
Section titled “Returns”Promise<void>
runOnce()
Section titled “runOnce()”runOnce(
request?):Promise<void>
Defined in: packages/messaging/src/delivery-tracking/service.ts:450
Polls the records that are due once, or joins a poll already running.
It resolves once the poll’s status changes have been delivered to
onStatusChange. A callback may call it too, as may a callback of
another service: while this service is delivering, such a call resolves
once the poll’s changes are queued, since they may be delivered after
the callback. Work a callback starts without awaiting it counts as the
callback’s.
A runtime without AsyncLocalStorage, such as Workers without nodejs_compat on older compatibility dates, cannot tell those calls from others. There, a poll that ends while callbacks run delivers its changes at once, beside them rather than after them, and every call waits until its changes are delivered.
request goes to each status query of the poll this call starts, as
KMsg.send() passes it to the provider: a signal to cancel it and a
fetch to make it with. The signal also bounds the poll: once it
aborts, no more queries start, those still running are cancelled, and
the poll stores the statuses it has and ends. The records it did not
finish stay due. A call that joins a poll already running stops waiting
for it when its own signal aborts. After close(), it does nothing.
Parameters
Section titled “Parameters”request?
Section titled “request?”Returns
Section titled “Returns”Promise<void>
start()
Section titled “start()”start():
void
Defined in: packages/messaging/src/delivery-tracking/service.ts:283
Returns
Section titled “Returns”void
stop()
Section titled “stop()”stop():
void
Defined in: packages/messaging/src/delivery-tracking/service.ts:297
Returns
Section titled “Returns”void