OCP App SDK

OCP App SDK / ChannelContentResult

Defined in: src/app/lib/ChannelContentResult.ts:14

Result of Channel.validate and Channel.publish.

ChannelContentResult

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/ChannelContentResult.ts:22

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/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