new $k.ActionResponse()
Methods
setData(data) → {$k.ActionResponse}
Data function
Parameters:
| Name | Type | Description |
|---|---|---|
data | object |
- Since
- 4.1.0
Returns:
This object.
- Type:
- $k.
ActionResponse
setFollowup(followup) → {$k.ActionResponse}
Followup function
Parameters:
| Name | Type | Description |
|---|---|---|
followup | string |
- Since
- 4.1.0
Returns:
This object.
- Type:
- $k.
ActionResponse
setGlobalContext(globalContext) → {$k.ActionResponse}
Set global context object
Parameters:
| Name | Type | Description |
|---|---|---|
globalContext | Array.<object> |
- Since
- 4.1.0
- Deprecated
- This function is deprecated and might be removed in future releases
Returns:
This object.
- Type:
- $k.
ActionResponse
setNotification(message, typeopt) → {$k.ActionResponse}
Notification function
Only supported in the following application environment(s): View-Configuration-Mapper
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message | string | ||
type | string | <optional> | Type of the notification that determines how it is presented in the web UI. Possible values are: 'success', 'info', 'warning ', and error'. |
- Since
- 4.1.0
Returns:
This object.
- Type:
- $k.
ActionResponse
setReceiverRole(receiverRole) → {$k.ActionResponse}
the view with the given role will receive the response
Parameters:
| Name | Type | Description |
|---|---|---|
receiverRole | string |
- Since
- 5.4.0
Returns:
This object.
- Type:
- $k.
ActionResponse
setSession(session) → {$k.ActionResponse}
Set the session
Parameters:
| Name | Type | Description |
|---|---|---|
session | object | Either a JSON object or a Session |
- Since
- 5.2.0
Returns:
This object.
- Type:
- $k.
ActionResponse
toJSON() → {object}
- Since
- 4.1.0
- Deprecated
- This function is deprecated and might be removed in future releases
Returns:
- Type:
- object