ChannelTargetResult
OCP App SDK / ChannelTargetResult
Class: ChannelTargetResult
Defined in: src/app/lib/ChannelTargetResult.ts:16
Result of Channel.target.
Extends
Constructors
Constructor
Defined in: src/app/lib/ChannelTargetResult.ts:22
Parameters
targeting?
the complete set of targeting requirements, if already known
Returns
ChannelTargetResult
Overrides
Properties
errors
Defined in: src/app/lib/FormResult.ts:4
Index Signature
[field: string]: string[]
Inherited from
toasts
Defined in: src/app/lib/FormResult.ts:5
intent
message
Inherited from
Methods
addError()
Defined in: src/app/lib/ChannelTargetResult.ts:51
Add an error to display to the user for a particular form field (implicitly scoped to the content settings form)
Parameters
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
Returns
this
addTargeting()
Defined in: src/app/lib/ChannelTargetResult.ts:31
Add a single targeting requirement
Parameters
targeting
requirement to add
Returns
this
addToast()
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."
Parameters
intent
one of the supported intents that will affect how the toast is displayed
message
string
to display in the toast
Returns
this
Inherited from
setTargeting()
Defined in: src/app/lib/ChannelTargetResult.ts:40
Provide the complete set of targeting requirements
Parameters
targeting
requirements to provide
Returns
this