OCP App SDK

---

OCP App SDK / ChannelDeliverResult

Interface: ChannelDeliverResult

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

Result of Channel.deliver.

Properties

failureCount?

optional failureCount: number

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

The number of times this batch has failed.

---

failureReason?

optional failureReason: string

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

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.

---

retryAfterSeconds?

optional retryAfterSeconds: number

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

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

---

success

success: boolean

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

Whether the call succeeded.

---

toasts?

optional toasts: object[]

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

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

intent

intent: Intent

message

message: string