sgtcloud-html5-sdk
Version:
A html5 out-of-box sdk for damn cool mbaas
950 lines (297 loc) • 16.7 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: TimerTask</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: TimerTask</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="global.html#SgtApi">SgtApi</a><a href="global.html#SgtApi#entity">.entity</a>.</span>
TimerTask
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="TimerTask"><span class="type-signature"></span>new TimerTask<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
定时器任务
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line2936">line 2936</a>
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"> :null</span></h4>
</dt>
<dd>
<div class="description">
className
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">null</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line2942">line 2942</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="createTime"><span class="type-signature"></span>createTime<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
定时任务创建时间
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line2948">line 2948</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="delay"><span class="type-signature"></span>delay<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
重复执行的时间间隔，repeat为不为0时生效
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line2954">line 2954</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="desc"><span class="type-signature"></span>desc<span class="type-signature"> :null</span></h4>
</dt>
<dd>
<div class="description">
描述该定时任务做什么事情
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">null</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line2960">line 2960</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="executeTime"><span class="type-signature"></span>executeTime<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
第一次执行定时器的时间点
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line2966">line 2966</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
主键，自增
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line2972">line 2972</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :null</span></h4>
</dt>
<dd>
<div class="description">
自定义的定时器名字
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">null</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line2978">line 2978</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="overdueTime"><span class="type-signature"></span>overdueTime<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
过期时间/为0为不失效
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line2984">line 2984</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="params"><span class="type-signature"></span>params<span class="type-signature"> :null</span></h4>
</dt>
<dd>
<div class="description">
定时器需要的参数，为json字符串，可选
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">null</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line2990">line 2990</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="repeat"><span class="type-signature"></span>repeat<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
是否重复执行，0为单次执行，1为多次执行，2为不限次数执行，默认为0
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line2996">line 2996</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="step"><span class="type-signature"></span>step<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
执行的次数，repeat为1时生效
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line3002">line 3002</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="timerId"><span class="type-signature"></span>timerId<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
关联到定时器的ID
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line3008">line 3008</a>
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-AccountService.html">AccountService</a></li><li><a href="module-AchievementService.html">AchievementService</a></li><li><a href="module-AnnouncementService.html">AnnouncementService</a></li><li><a href="module-BlackListService.html">BlackListService</a></li><li><a href="module-BossService.html">BossService</a></li><li><a href="module-CampaignService.html">CampaignService</a></li><li><a href="module-ChargePoint.html">ChargePoint</a></li><li><a href="module-CheckinBoardService.html">CheckinBoardService</a></li><li><a href="module-DailyTaskService.html">DailyTaskService</a></li><li><a href="module-DelegateDid.html">DelegateDid</a></li><li><a href="module-ErrorReportService.html">ErrorReportService</a></li><li><a href="module-FileStorage.html">FileStorage</a></li><li><a href="module-FriendshipExtra.html">FriendshipExtra</a></li><li><a href="module-FriendshipService.html">FriendshipService</a></li><li><a href="module-GachaBoxService.html">GachaBoxService</a></li><li><a href="module-GiftCode.html">GiftCode</a></li><li><a href="module-InvitationCodeService.html">InvitationCodeService</a></li><li><a href="module-LeaderboardService.html">LeaderboardService</a></li><li><a href="module-MailService.html">MailService</a></li><li><a href="module-Notification.html">Notification</a></li><li><a href="module-PaymentCallbackService.html">PaymentCallbackService</a></li><li><a href="module-PlayerExtraService.html">PlayerExtraService</a></li><li><a href="module-PlayerService.html">PlayerService</a></li><li><a href="module-PrivateChannel.html">PrivateChannel</a></li><li><a href="module-PublicChannelService.html">PublicChannelService</a></li><li><a href="module-Purchase.html">Purchase</a></li><li><a href="module-RouterService.html">RouterService</a></li><li><a href="module-StoreService.html">StoreService</a></li><li><a href="module-StructuredDataService.html">StructuredDataService</a></li><li><a href="module-TaskService.html">TaskService</a></li><li><a href="module-TicketService.html">TicketService</a></li><li><a href="module-TimestampService.html">TimestampService</a></li><li><a href="module-VersionDetailService.html">VersionDetailService</a></li></ul><h3>Classes</h3><ul><li><a href="sendCaptchaMessage.html">sendCaptchaMessage</a></li><li><a href="SgtApi.entity.Achievement.html">Achievement</a></li><li><a href="SgtApi.entity.Announcement.html">Announcement</a></li><li><a href="SgtApi.entity.Blacklist.html">Blacklist</a></li><li><a href="SgtApi.entity.Boss.html">Boss</a></li><li><a href="SgtApi.entity.Campaign.html">Campaign</a></li><li><a href="SgtApi.entity.CampaignDetail.html">CampaignDetail</a></li><li><a href="SgtApi.entity.Channel.html">Channel</a></li><li><a href="SgtApi.entity.ChargeLog.html">ChargeLog</a></li><li><a href="SgtApi.entity.ChargePoint.html">ChargePoint</a></li><li><a href="SgtApi.entity.CheckinBoard.html">CheckinBoard</a></li><li><a href="SgtApi.entity.CheckinResult.html">CheckinResult</a></li><li><a href="SgtApi.entity.DailyTask.html">DailyTask</a></li><li><a href="SgtApi.entity.ExternalCallbackBean.html">ExternalCallbackBean</a></li><li><a href="SgtApi.entity.FileItem.html">FileItem</a></li><li><a href="SgtApi.entity.Friendship.html">Friendship</a></li><li><a href="SgtApi.entity.FriendshipExtra.html">FriendshipExtra</a></li><li><a href="SgtApi.entity.GachaBox.html">GachaBox</a></li><li><a href="SgtApi.entity.GachaBoxResult.html">GachaBoxResult</a></li><li><a href="SgtApi.entity.Gift.html">Gift</a></li><li><a href="SgtApi.entity.GiftRecord.html">GiftRecord</a></li><li><a href="SgtApi.entity.Item.html">Item</a></li><li><a href="SgtApi.entity.LeaderBoard.html">LeaderBoard</a></li><li><a href="SgtApi.entity.LeaderBoardScore.html">LeaderBoardScore</a></li><li><a href="SgtApi.entity.Lottery.html">Lottery</a></li><li><a href="SgtApi.entity.Mail.html">Mail</a></li><li><a href="SgtApi.entity.MailsCollection.html">MailsCollection</a></li><li><a href="SgtApi.entity.MailTemplate.html">MailTemplate</a></li><li><a href="SgtApi.entity.Message.html">Message</a></li><li><a href="SgtApi.entity.Order.html">Order</a></li><li><a href="SgtApi.entity.Player.html">Player</a></li><li><a href="SgtApi.entity.PlayerExtra.html">PlayerExtra</a></li><li><a href="SgtApi.entity.Reward.html">Reward</a></li><li><a href="SgtApi.entity.Save.html">Save</a></li><li><a href="SgtApi.entity.Server.html">Server</a></li><li><a href="SgtApi.entity.Store.html">Store</a></li><li><a href="SgtApi.entity.StructuredData.html">StructuredData</a></li><li><a href="SgtApi.entity.Task.html">Task</a></li><li><a href="SgtApi.entity.Ticket.html">Ticket</a></li><li><a href="SgtApi.entity.TimerTask.html">TimerTask</a></li><li><a href="SgtApi.entity.User.html">User</a></li><li><a href="SgtApi.entity.VersionDetail.html">VersionDetail</a></li><li><a href="SgtApi.init.html">init</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a> on Wed Oct 14 2015 19:20:32 GMT+0800 (中国标准时间)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>