$root.$iremotetasks.REMOTETASK

Parent: $root.$iremotetasks
 
Children 

Class notation

Properties Methods Events 

Properties

Object specific 
$clientaddressTCP/IP address of client
$connectbytessentNumber of bytes returned to client on connect
$connectionidConnection ID of remote task instance
$connectiontimeDate and time when remote client connected to remote task instance
$inheritedUsed when referring to a method or variable defined in a superclass
$issecureIf 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)
$lastresponseDate and time when remote client last communicated with remote task instance
$maxtimeThe 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
$orderAn 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
$remotedebugIf true,remote debugging is allowed for this task instance and instances belonging to this task instance.Defaults to false in a new task instance
$reqcurbytesreceivedBytes received for current event (set during evBusy)
$reqcurbytessentBytes sent for current event (set during evIdle)
$reqmaxbytesreceivedLargest block of bytes received (events only)
$reqmaxbytessentLargest block of bytes sent (events only)
$reqtotbytesreceivedTotal number of bytes received (events only)
$reqtotbytessentTotal number of bytes sent (events only)
$requestsNumber of events executed
$restfulIf 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
$stringtablelocaleEither 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
$timeoutThe 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
Standard$classtype $ident $isprivate $name

Methods

Object specific 
$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
$pushdata$pushdata(wRow[,&cErrorText]) See $clientcommand openpush.Pushes row wRow to client.Results in a call to the client-executed method $pushed in the remote form instance on the client,passing wRow as the parameter.wRow must be JSON compatible
$showmessage$showmessage(cMessage[,cTitle]) displays an OK message on the client machine using the specified cMessage and cTitle
Standard$canclose $close

Events

evBusyRemote connection has become busy
Parameters
pEventCodeThe event code
evIdleRemote connection has become idle
Parameters
pEventCodeThe event code
evPostPost or Get request from client
Parameters
pEventCodeThe event code
pPostDataRow variable containing data from client
pPostResultField Reference for returning result to client
evRejectedConnection has been rejected
Parameters
pEventCodeThe event code
pErrorTextError text
evResumedRemote connection has been resumed from a suspended state
Parameters
pEventCodeThe event code
pSuspendConditionA kSuspendCondition... constant that indicates the reason why the remote task is suspended
evSuspendedRemote connection has been suspended
Parameters
pEventCodeThe event code
pSuspendConditionA kSuspendCondition... constant that indicates the reason why the remote task is suspended

Children

Top 

$iremoteforms$ivars$methods$tvars