OCP App SDK

OCP App SDK / ChannelPreviewResult

Defined in: src/app/lib/ChannelPreviewResult.ts:26

Result of Channel.preview. All previews must be a full HTML page. There must be exactly one preview per recipient, and they must be added to this result in the same order as the recipients were given to Channel.preview.

Defined in: src/app/lib/ChannelPreviewResult.ts:33

string[]

the complete set of HTML previews, if already known

ChannelPreviewResult

FormResult.constructor

Defined in: src/app/lib/FormResult.ts:4

[field: string]: string[]

FormResult.errors

Defined in: src/app/lib/FormResult.ts:5

FormResult.toasts

Defined in: src/app/lib/ChannelPreviewResult.ts:72

Add an error to display to the user for a particular form field

the type of content form that the error applies to (settings or template)

"settings" | "template"

string

the section within the form that the error applies to

string

the field within the section that the error applies to

string

message to display to the user

this

Defined in: src/app/lib/ChannelPreviewResult.ts:42

Add a single HTML preview

string

to add

this

Defined in: src/app/lib/FormResult.ts:13

Display a toast to user, such as, "Successfully authenticated with <Integration>" or "Authentication failed, please check your credentials and try again."

Intent

one of the supported intents that will affect how the toast is displayed

string

to display in the toast

this

FormResult.addToast

Defined in: src/app/lib/ChannelPreviewResult.ts:60

Set options to control how the preview is displayed

PreviewDisplayOptions

to control the preview

this

Defined in: src/app/lib/ChannelPreviewResult.ts:51

Provide the complete set of HTML previews

string[]

to provide

this