OCP App SDK / ChannelDeliverResult

ChannelDeliverResult

Result of deliver.

Index

Properties

• failureCount
• failureReason
• retryAfterSeconds
• success
• toasts

Properties

failureCount?

number

The number of times this batch has failed.

Defined in: src/app/Channel.ts:292

failureReason?

string

If the call failed, an internal reason for the failure (not necessarily human-readable). This must include any
information that a subsequent retry would need to perform its recovery logic.

Defined in: src/app/Channel.ts:288

retryAfterSeconds?

number

If the failure is retriable, the number of seconds to wait before retrying.

Defined in: src/app/Channel.ts:296

success

boolean

Whether the call succeeded.

Defined in: src/app/Channel.ts:283

toasts?

{

`intent`: [`Intent`](app-sdk-api-reference-types-intent);
`message`: `string`;

}[]

An array of messages to display to the user.
This should only be set when testing delivery (i.e ChannelDeliverOptions.test is true).

Defined in: src/app/Channel.ts:302