ITMSMCPCustomCloudImageAI.ExtractPollData Method
Reads the polling target out of a response, for services that answer a generate request with a job reference.
API unit family: TMS.MCP.CloudImageAI
Declaring type: ITMSMCPCustomCloudImageAI
Syntax
function ExtractPollData(const ARequestResult: TJSONValue; var AURL: string; var AID: string): Boolean;
Remarks
Returning False stops the operation without producing either a result or an error, so an implementation that reports that it polls must be able to answer this call.
Parameters
| Name | Description |
|---|---|
ARequestResult |
Parsed response body to read the polling information from. |
AURL |
Receives the absolute address to poll, or an empty string when the service polls a fixed address derived from the identifier. |
AID |
Receives the job identifier, or an empty string when the service does not use one. |
Returns
True when polling information was found and polling should start; False when it was not.