| 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 |
| $inherited | Used when referring to a method or variable defined in a superclass |
| $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 |
| $order | An integer that uniquely identifies the remote task instance within the lifetime of the Omnis Server. The value will not be re-used for a different remote task until the Omnis Server is restarted. Also, values are unlikely to be incremental |
| $remotedebug | If true,remote debugging is allowed for this task instance and instances belonging to this task instance.Defaults to false in a new task instance |
| $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 |
| $restful | If true,the remote task is RESTful.It can have URI objects,and be part of a RESTful API if $restfulapiname is set for the class.Read-only for instances;can only be set to kFalse in class when the remote task and superclasses have no URI objects |
| $restfulapiname | If not empty,the name of the RESTful API in the library containing the remote task (cannot equal $webservice for remote tasks in lib).Starts with a-z and can only contain a-z,0-9 and _ |
| $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() |
| $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 |
| $unknownquerystringparams | If unknown query string parameters are allowed,then this property is a row with a character column for each unknown parameter (the column name is the parameter name in lower case and the column value is the parameter value) |
| Standard | $classtype $ident $isprivate $name |
| 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 |
| $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(vData[,bChunk=kFalse]) Sends vData to client for a RESTful remote task (not closed see $restfulapiwillclose),optionally formatted as a chunk.vData can be bin,char,list or row (char converted to UTF-8,JSON if list or row) |
| $sethttpstatus | $sethttpstatus(iStatusCode[,cStatusText]) sets the HTTP status code and text when executing a RESTful Web Service request. Status defaults to 200 OK if there is no call to $sethttpstatus |
| Standard | $canclose $close |
$root.$iremotetasks.RESTful_REMOTETASK