$root.$iremotetasks.REMOTETASK

Parent: $root.$iremotetasks
Class notation

Properties

Object specific
$clientaddress TCP/IP address of client
$connectbytessent Number of bytes returned to client on connect
$connectionid Connection ID of remote task instance
$connectiontime Date and time when remote client connected to remote task instance
$issecure If true, communication between the client and the Web Server uses HTTPS. Assign $issecure at runtime, to change the type of connection used for subsequent requests (the response to the current request uses the value before assignment)
$lastresponse Date and time when remote client last communicated with remote task instance
$maxtime The maximum number of minutes for which the remote client is allowed to stay connected. Specify zero to indicate that there is no limit to the duration of the connection
$reqcurbytesreceived Bytes received for current event (set during evBusy)
$reqcurbytessent Bytes sent for current event (set during evIdle)
$reqmaxbytesreceived Largest block of bytes received (events only)
$reqmaxbytessent Largest block of bytes sent (events only)
$reqtotbytesreceived Total number of bytes received (events only)
$reqtotbytessent Total number of bytes sent (events only)
$requests Number of events executed
$restfulapiwillclose If true, the RESTful API remote task will close when the Omnis RESTful HTTP method returns. Defaults to kTrue in a new RESTful API remote task. kFalse only applies when the method executes successfully; you must eventually call $close()
$stringtablelocale Either empty, LL, or LL_CC (LL:2 character ISO 639 language code, CC:2 character ISO 3166 country code).If set to non-empty in remote task $construct, then it overrides the client locale when setting the initial client string table column
$timeout The maximum number of minutes for which the connection to the remote client is allowed to stay idle. Specify zero to allow the connection to remain permanently idle
$webservice If not empty, name of WSDL Web Service containing remote task (cannot equal $restfulapiname for remote tasks in lib); can only contain a-z,0-9 or _;cannot be prefixed with 'omnis'. Web Service contains $... methods marked as Web Service methods
Standard $classtype $ident $isprivate $name $order

Methods

Object specific
$addhttpresponseheader $addhttpresponseheader(cHeaderName, cHeaderValue) adds the specified HTTP header to the response that will be sent to a RESTful Web Service request. Note that Omnis automatically adds the Content-length header to the response
$changeform $changeform(cFormName) changes the clients remote form without closing the remote task instance
$closeform $closeform(cFormName) closes the form without closing the remote task instance or other forms open within the remote task
$openform $openform(cFormName) opens the form if necessary, and makes it the clients visible remote form, without closing the remote task instance or other forms open within the remote task
$removehttpresponseheader $removehttpresponseheader(cHeaderName [,bAll=kFalse]) removes either the last instance (or all instances) of the specified HTTP header from the response that will be sent to a RESTful Web Service request
$sendhttpcontent $sendhttpcontent(xData) Sends the next block of HTTP content (xData) to the client for a RESTful API remote task that did not close
$sethttpstatus $sethttpstatus(iStatusCode[,cStatusText]) sets the HTTP status code and text when executing a RESTful Web Service request
$showmessage $showmessage(cMessage[,cTitle]) displays an OK message on the client machine using the specified cMessage and cTitle
Standard $canclose $close

Events

evBusy

Remote connection has become busy
Parameters

pEventCode The event code
evIdle

Remote connection has become idle
Parameters

pEventCode The event code
evPost

Post or Get request from client
Parameters

pEventCode The event code
pPostData Row variable containing data from client
pPostResult Field Reference for returning result to client
evRejected

Connection has been rejected
Parameters

pEventCode The event code
pErrorText Error text

Children 

$iremoteforms $ivars $methods $tvars