UNPKG

sgtcloud-html5-sdk

Version:

A html5 out-of-box sdk for damn cool mbaas

1,544 lines (477 loc) 24 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: Achievement</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: Achievement</h1> <section> <header> <h2> <span class="ancestors"><a href="global.html#SgtApi">SgtApi</a><a href="global.html#SgtApi#entity">.entity</a>.</span> Achievement </h2> </header> <article> <div class="container-overview"> <dt> <h4 class="name" id="Achievement"><span class="type-signature"></span>new Achievement<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#line587">line 587</a> </li></ul></dd> </dl> </dd> </div> <h3 class="subsection-title">Members</h3> <dl> <dt> <h4 class="name" id="currentProgress"><span class="type-signature"></span>currentProgress<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#line592">line 592</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="customCondition"><span class="type-signature"></span>customCondition<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#line598">line 598</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="description"><span class="type-signature"></span>description<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#line604">line 604</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="goal"><span class="type-signature"></span>goal<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#line610">line 610</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"> 主键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#line616">line 616</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="level"><span class="type-signature"></span>level<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#line622">line 622</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#line628">line 628</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="overMaxProgress"><span class="type-signature"></span>overMaxProgress<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> 是否允许当前进度超越最大进度,默认不允许 </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</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#line634">line 634</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="preAchievementId"><span class="type-signature"></span>preAchievementId<span class="type-signature"> :null</span></h4> </dt> <dd> <div class="description"> 前置成就ID </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#line640">line 640</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="PROGRESS_DONE"><span class="type-signature"></span>PROGRESS_DONE<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#line682">line 682</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="PROGRESS_GOT_REWARD"><span class="type-signature"></span>PROGRESS_GOT_REWARD<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#line688">line 688</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="PROGRESS_NOT_ACHIEVED"><span class="type-signature"></span>PROGRESS_NOT_ACHIEVED<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#line694">line 694</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="reward"><span class="type-signature"></span>reward<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#line646">line 646</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="showDone"><span class="type-signature"></span>showDone<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> 是否允许成就完成后仍然显示在列表,默认显示,0为不显示,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#line652">line 652</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="status"><span class="type-signature"></span>status<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> 状态(禁用0,启用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#line658">line 658</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="STATUS_DISABLE"><span class="type-signature"></span>STATUS_DISABLE<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#line700">line 700</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="STATUS_ENABLE"><span class="type-signature"></span>STATUS_ENABLE<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#line706">line 706</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="type"><span class="type-signature"></span>type<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#line664">line 664</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="updateUnfinished"><span class="type-signature"></span>updateUnfinished<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> 是否在前置成就没完成之前同时更新后置任务,默认不允许 </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</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#line670">line 670</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="visibility"><span class="type-signature"></span>visibility<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> 成就的可见性 [0 不可见,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#line676">line 676</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="VISIBILITY_INVISIBLE"><span class="type-signature"></span>VISIBILITY_INVISIBLE<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#line712">line 712</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:31 GMT+0800 (中国标准时间) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>