DeliveryTrackingHooksOptions
Defined in: packages/messaging/src/delivery-tracking/hooks.ts:5
Properties
Section titled “Properties”onError?
Section titled “onError?”
optionalonError?: (error,context) =>void|Promise<void>
Defined in: packages/messaging/src/delivery-tracking/hooks.ts:17
Called when a send fails, as the KMsg onError hook.
Parameters
Section titled “Parameters”context
Section titled “context”Returns
Section titled “Returns”void | Promise<void>
onFinal?
Section titled “onFinal?”
optionalonFinal?: (context,state) =>void|Promise<void>
Defined in: packages/messaging/src/delivery-tracking/hooks.ts:24
Parameters
Section titled “Parameters”context
Section titled “context”unknown
unknown
Returns
Section titled “Returns”void | Promise<void>
onQueued?
Section titled “onQueued?”
optionalonQueued?: (context) =>void|Promise<void>
Defined in: packages/messaging/src/delivery-tracking/hooks.ts:18
Parameters
Section titled “Parameters”context
Section titled “context”unknown
Returns
Section titled “Returns”void | Promise<void>
onRecordError?
Section titled “onRecordError?”
optionalonRecordError?: (error,info) =>void|Promise<void>
Defined in: packages/messaging/src/delivery-tracking/hooks.ts:12
Called when a message the provider accepted could not be recorded for
tracking, so it will not be polled. The send still succeeds. Without
this option the error is thrown from the hook, and KMsg passes it to
onHookError, or to console.error without one.
Parameters
Section titled “Parameters”unknown
context
Section titled “context”result
Section titled “result”Returns
Section titled “Returns”void | Promise<void>
onRetryScheduled?
Section titled “onRetryScheduled?”
optionalonRetryScheduled?: (context,error,metadata) =>void|Promise<void>
Defined in: packages/messaging/src/delivery-tracking/hooks.ts:19
Parameters
Section titled “Parameters”context
Section titled “context”unknown
unknown
metadata
Section titled “metadata”unknown
Returns
Section titled “Returns”void | Promise<void>