git.roojs.org Git - roojs1/blob - docs/symbols/Roo.util.TaskRunner.json

   1 {
   2   "name" : "Roo.util.TaskRunner",
   3   "augments" : [],
   4   "childClasses" : {  },
   5   "tree_children" : [],
   6   "tree_parent" : [],
   7   "desc" : "Manage background tasks - not sure why this is better that setInterval?",
   8   "isSingleton" : false,
   9   "isStatic" : true,
  10   "isBuiltin" : false,
  11   "isAbstract" : false,
  12   "isBuilderTop" : false,
  13   "memberOf" : "TaskRunner",
  14   "example" : "",
  15   "deprecated" : "",
  16   "since" : "",
  17   "see" : "",
  18   "params" : [],
  19   "returns" : [],
  20   "throws" : "",
  21   "requires" : "",
  22   "config" : [],
  23   "methods" : [
  24     {
  25       "name" : "stop",
  26       "type" : "function",
  27       "desc" : "Stop  new task.",
  28       "sig" : "(task)",
  29       "static" : false,
  30       "memberOf" : "",
  31       "isStatic" : false,
  32       "isConstructor" : false,
  33       "isPrivate" : false,
  34       "example" : "",
  35       "deprecated" : "",
  36       "since" : "",
  37       "see" : "",
  38       "exceptions" : "",
  39       "requires" : "",
  40       "params" : [
  41         {
  42           "name" : "task",
  43           "type" : "Object",
  44           "desc" : "",
  45           "isOptional" : false
  46         }
  47       ],
  48       "returns" : []
  49     },
  50     {
  51       "name" : "stopAll",
  52       "type" : "function",
  53       "desc" : "Stop all Tasks",
  54       "sig" : "()\n{\n\n}",
  55       "static" : false,
  56       "memberOf" : "",
  57       "isStatic" : false,
  58       "isConstructor" : false,
  59       "isPrivate" : false,
  60       "example" : "",
  61       "deprecated" : "",
  62       "since" : "",
  63       "see" : "",
  64       "exceptions" : "",
  65       "requires" : "",
  66       "params" : [],
  67       "returns" : []
  68     },
  69     {
  70       "name" : "start",
  71       "type" : "function",
  72       "desc" : "Queues a new task.",
  73       "sig" : "(task)",
  74       "static" : false,
  75       "memberOf" : "",
  76       "isStatic" : false,
  77       "isConstructor" : false,
  78       "isPrivate" : false,
  79       "example" : "",
  80       "deprecated" : "",
  81       "since" : "",
  82       "see" : "",
  83       "exceptions" : "",
  84       "requires" : "",
  85       "params" : [
  86         {
  87           "name" : "task",
  88           "type" : "Object",
  89           "desc" : "Task property : interval = how frequent to run.\nTask object should implement\nfunction run()\nTask object may implement\nfunction onStop()",
  90           "isOptional" : false
  91         }
  92       ],
  93       "returns" : []
  94     }
  95   ],
  96   "events" : []
  97 }