$root.$libs.LIB.$remotetasks.REMOTETASK

Parent: $root.$libs.LIB.$remotetasks
 
Children 

Instance notation

Properties Methods 

Properties

Object specific 
$collectperformancedataThis property is only applied when $root.$prefs.$collectperformancedata has the value kCPDmarkedClasses.If true,method execution performance data is collected for all methods in the class
kFalse kTrue
$editorThe name of the add-in tool library used to edit this class
$editordataEditor data stored with the class.Typically used by the library identified by $editor
$htmltemplateThe name of the template file (which must exist in the html folder) to use when testing a remote form using this remote task as its design task.If $htmltemplate is empty,Omnis uses the default template (jsctempl.htm)
$localtestdataData used for locally testing remote forms with the local webserver
$localtimeIf true,the JavaScript client and the Omnis Server exchange date-time values as local time rather than UTC time. All omnisobjects on the same HTML page must use the same value for $localtime
$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
$maxusersMaximum number of remote users connected to this task (number of instances)
$pathnameThe path to the class in the folder tree
$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
$stringtableThe string table (tab-separated value .tsv file in library folder) shared by all JavaScript client remote form instances in the remote task.Omnis automatically loads it and names it using the library name and file name
$suspendconditionsA sum of zero or more kSuspendCondition... constants that specify the conditions under which the remote task will apply the $suspendedtimeout.
$suspendedtimeoutThe time (in minutes) after which the remote task will time out if the client is suspended (e.g. in back/forward cache). 0 means do not suspend, -1 means continue standard $timeout.
$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$canremotedebugwhenlocked $classdata $classtype $componenticon $componentinfo $componenttype $createdate $desc $disksize $external $ident $issupercomponent $moddate $name $parentfolder $showascheckedout $superclass $userinfo $vcsrevision $version

Methods

$clearperformancedata$clearperformancedata() Clears the performance data for all methods in the class
$findandreplace$findandreplace(cFind,cRep[,bIgnCase=kTrue,bWholeWord=kFalse,bRegExp=kFalse,bClearLog=kFalse,bReturnLog=kFalse]) If cRep is #NULL,finds all instances of cFind;otherwise,replaces all instances of cFind with cRep.Returns status row
$isa$isa(rClass|rExternalObject) Returns true if the class or instance is a subclass of the specified class or external object
$makeperformancedatalist$makeperformancedatalist() Returns a list containing the performance data collected for all methods in the class
$makesubclass$makesubclass(cName[,bAddLibPrefixForClib=kFalse]) creates a new subclass of the class,with the specified name (which can be prefixed by a library);bAddLibPrefixForClib controls whether $superclass of the new class has a library name prefix
$removecodefolding$removecodefolding() Removes code folding from all methods in the class. Returns the number of methods from which code folding was removed

Children

Top 

$cvardefs$cvars$insts$ivardefs
$methods$tvardefs