getDataPage
Retrieves data page information from the clipboard in JSON format.
Signature
getDataPage(options)
Returns
JSON object with data from the clipboard.
Parameters
Name | Description | Type | Required |
name | Specifies the name of the target data page. | String | ✅ |
parameters | Specifies the parameters for the data page in an array. | JSON object | ❌ |
callback | Specifies the callback function that you call with the data from the data page. | String | ✅ |
event | Specifies the event that launches the activity. | DOM event object | ✅ |
JSON objects
- dataTransform
- Includes an array of parameter objects.
isProperty
indicates whether the parameter is a property or a literal constant. The default value ofisProperty
isfalse
, which means that the parameter is a constant.{ "name":"dataTransformName", "parameters":[ { "name":"param1", "value":"Page1.prop1", "isProperty":true }, { "name":"param2", "value":123, "isProperty":false } ] }
var options = {
name: "dataPageName",
parameters: [{name: "param1", value: "Page1.prop1", isProperty: true}, {name: "param2", value: 123, isProperty: false}],
callback: callbackFunc,
event: eventObject
};
function callbackFunc(resultJSON){
console.log(resultJSON)
}
pega.api.ui.actions.getDataPage(options);
Previous topic editListItem Next topic launchHarness