public abstract class SimpleClientApi extends Object implements ClientApi
TemplateId annotation defines the friendly name of the SimpleClientAPI when called from the Component Plugin.
Client APIs are re-instantiated per request. Therefore, each call to
execute(SimpleClientApiRequest, ExecutionContext) is on a new instance of the class.
Client APIs are immediately available once deployed. They do not require any additional configuration in Appian.
|Constructor and Description|
|Modifier and Type||Method and Description|
Defines the behavior of the Client API.
protected abstract ClientApiResponse execute(SimpleClientApiRequest request, ExecutionContext executionContext)
request- A non-null
executionContext- Contains all of the contextual information needed to execute the Client API including Designer information, Designer locale, and proxy configuration.
Copyright © 2018-present Appian Corporation. All Rights Reserved.