OCP App SDK / ChannelContentResult

ChannelContentResult

Result of validate and publish.

Hierarchy

new ChannelContentResult(): ChannelContentResult;

Protected object = {}

[field: string]: string[]

Inherited from: FormResult.errors

Protected {

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

}[] = []

Inherited from: FormResult.toasts

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

addError(
  form: "settings" | "template",
  section: string,
  field: string,
  error: string): ChannelContentResult;

Name	Type	Description
`form`	`"settings"` \| `"template"`	the type of content form that the error applies to (settings or template)
`section`	`string`	the section within the form that the error applies to
`field`	`string`	the field within the section that the error applies to
`error`	`string`	message to display to the user

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

addToast(intent: Intent, message: string): ChannelContentResult;

Name	Type	Description
`intent`	`Intent`	one of the supported intents that will affect how the toast is displayed
`message`	`string`	to display in the toast