From fafd085a450666461a6fe48140c13a4dd926d30c Mon Sep 17 00:00:00 2001 From: 小川 费 <449111130@qq.com> Date: Tue, 24 Sep 2019 13:43:44 +0800 Subject: [PATCH] 1 --- inner/download.md | 2 +- inner/modules.md | 2 +- inner/share.md | 308 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------------------------------------------------------------------------------------------------- outer/download.md | 2 +- outer/modules.md | 2 +- outer/share.md | 308 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------------------------------------------------------------------------------------------------- tools/sdk-share-tools-1.0.0.zip | Bin 0 -> 4521 bytes tools/sdk-share-tools-1.0.1/SDKTools.ts | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ tools/sdk-share-tools-1.0.1/ShareVideoTools.ts | 150 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 9 files changed, 509 insertions(+), 314 deletions(-) create mode 100644 tools/sdk-share-tools-1.0.0.zip create mode 100644 tools/sdk-share-tools-1.0.1/SDKTools.ts create mode 100644 tools/sdk-share-tools-1.0.1/ShareVideoTools.ts diff --git a/inner/download.md b/inner/download.md index beac95d..52ee4c3 100644 --- a/inner/download.md +++ b/inner/download.md @@ -38,7 +38,7 @@ 1. config.js配置ShareData新增share_wxad_id参数：视频广告uid，配置此参数，推送看视频，不配置或者配置的uid无效则推送分享。 2. stat模块的addLogLevel拆分为多个接口：logLevelRelive、logLevelWin、logLevelFail、logLevelHide，addLogLevel继续保留。 3. data模块新增了三个控制交叉推广位动态控制显示/隐藏的api：IsCross、IsDrawer、IsGuessLike。 -4. share模块重新命名为：shareVideo，shareDispatch修改为dispatch、shareWithType修改为dispatchType、getShareType修改为getShareVideoType，原来的share模块还是能用。 +4. share模块重新命名为：shareVideo，原来的share模块还是能用；shareDispatch修改为dispatch、shareWithType修改为dispatchType、getShareType修改为getType。 ## [v1.0.0.0 下载](https://dep.miso-lab.com/sdkword/versions/sdk-out-v1.0.0.0.zip) diff --git a/inner/modules.md b/inner/modules.md index f4a8dbd..e44d9dd 100644 --- a/inner/modules.md +++ b/inner/modules.md @@ -84,4 +84,4 @@ dispatch：分享视频分发入口，传入功能点英文命名的分享/视频key - getShareVideoType：根据功能点在后台配置的分享/视频key，得到此功能点分享开关 + getType：根据功能点在后台配置的分享/视频key，得到此功能点分享开关 diff --git a/inner/share.md b/inner/share.md index 2f52757..58b8cfb 100644 --- a/inner/share.md +++ b/inner/share.md @@ -1,39 +1,37 @@ - # 分享视频模块 ------ #### **简介** -小游戏生态中，普遍把平台提供的分享/视频接口更多用于某个奖励领取、获取n倍奖励、游戏死亡复活、转盘额外次数获得等等一种有效途径（分享：拉取新用户，视频：赚钱广告费）；噗嗤游戏在分享or视频推送不断的探索迭代中，总结了一套分享/视频积分策略，集成在SDK中开放给开发者，开发者只需对游戏中分享视频功能点命名一个英文名称key（分享视频key），这个key关联分享文案、分享图、分享开关（推送类型）、视频uid等等在后台配置好，使用SDK提供的一个dispatch api传入英文名称key即可完成接入工作。 +小游戏生态中，普遍把平台提供的分享/视频接口更多用于某个奖励领取、获取n倍奖励、游戏死亡复活、转盘额外次数获得等等一种有效途径（分享：拉取新用户，视频：赚钱广告费）；噗嗤游戏在分享/视频推送不断的迭代中，总结了一套分享/视频积分策略，集成在SDK中开放给开发者，开发者只需对游戏中分享视频功能点命名一个英文名称key（分享视频key），在后台配置这个key关联的分享文案、分享图、分享开关（推送类型）、视频uid等等信息，使用SDK提供的一个dispatch api传入分享视频key即可完成接入工作。 -- 分享/视频配置可以让开发者在后台中动态修改相关功能点的分享/视频配置内容。 -- 新增某个功能的分享点配置、在线修改相关功能点的分享图或文案、在线切换某个功能点按钮的分享/视频推送类型。 +- 后台的【分享/视频配置】功能可以让开发者动态修改相关功能点的分享/视频配置的分享文案、分享图、分享开关（推送类型）、视频uid等等信息。 -- 调用SDK的dispatch api，dispatch会根据后台配置的分享开关（推送类型）自动进行分发：推送分享还是视频全权交由SDK去处理，开发者只需要传入成功/失败回调函数，成功回调函数处理发放领取奖励、n倍奖励、成功复活等操作，失败回调函数处理参数传递的msg信息。 +- 调用SDK的dispatch api，dispatch会根据后台配置的分享开关（推送类型）自动进行分发：推送分享or视频全权交由SDK去处理，开发者只需要传入成功/失败回调函数，成功回调函数处理成功后的逻辑，失败回调函数处理参数传递的错误msg信息。 #### **疑惑解答** 1. 为什么要引入这个模块？ - > 游戏中很多n倍奖励、复活、额外奖励等功能点通常需要分享或者视频才能额外获得，游戏上线后，运营很有可能会对某些功能点有额外的需求修改：a功能点获取由分享改成视频方式获取、b功能点由视频改成分享方式获取、c功能点需要在前面n次看视频获得后全是分享获得、为某某功能的分享图想换一个、拉取视频不成功自动切换分享等等；为了应对这些不同情形，我们把分享和视频点包装成一个模块，a功能点也不在局限于只是简单的分享、b功能只是视频，而是通过后台分享开关去灵活切换。所有功能点入口调用都是使用dispatch，每个功能点都是转化为一个分享视频key在后台管理。 + > 游戏中很多n倍奖励、复活、额外奖励等功能点通常需要分享或者视频才能额外获得。游戏上线后，运营可能会对这些功能点有修改需求：a功能点领取奖励由分享改成视频方式领取、b功能点由视频改成分享方式获取、c功能点需要在前面n次看视频领取过后，后面全是分享获得、某个分享点的分享图片和文案修改等等；为了应对这些不同情形，我们把分享和视频点包装成一个模块，每个功能点转成key在后台进行管理，功能点也不在局限于只是简单的推送分享，单一的推送视频，而是可以根据运营情况进行灵活切换。 2. 什么是分享视频key？ - > 分享视频key是一个功能点的英文名称，这个key配置在后台中，关联分享文案、分享图、分享开关（推送类型）、视频uid等等信息。某个功能点（不论是分享还是视频方式）调用dispatch传入这个key，SDK会读取这个key关联的信息，根据分享开关（推送类型）来推送分享（需要分享文案、分享图）还是推送视频（需要视频uid）。 + > 分享视频key是一个功能点的英文名称，这个key是开发者根据功能点命名的，开发者自己或者策划把这个key关联的分享文案、分享图、分享开关（推送类型）、视频uid等等信息配置在后台；完成配置后，使用PCSDK.shareVideo.dispatch传入这个key，PCSDK会读取这个key关联的信息，根据分享开关（推送类型）来推送分享（读取配置的分享文案、分享图）还是推送视频（读取配置的视频uid）。 3. 什么是分享视频分发？ - > 调用dispatch api传入分享视频key，SDK会查找这个key在后台配置的数据，SDK读取数据中分享开关（推送类型）的字段信息，通过这个开关类型来判断推给用户是分享还是视频，这个根据类型来推送的操作就是分发操作。 + > 使用PCSDK.shareVideo.dispatch传入分享视频key，SDK会查找这个key在后台配置的数据信息，SDK读取数据中分享开关（推送类型），通过推送类型来计算推给用户是分享还是视频，这个根据推送类型来推送的操作就是分发操作。 4. 游戏中之前是玩家分享n次后变成看视频或者是看视频n次后全是分享，dispatch能满足吗？ - > 上面的问题dispatch也同样支持，还是同样的调用方式，不需要做其他额外处理，dispatch是怎么做到的了：分享开关（推送类型）有一个分享积分选择项，这个选项就是通过积分策略实现了上面问题。 + > 上面的问题dispatch也同样支持，还是一样的调用方式，不需要额外的传递参数，只需在后台修改分享开关（推送类型） > #### **后台使用** -配置分享视频配置，登录后台->头部tab切换到【游戏数据】->【配置相关】->【分享/视频配置】可新增、编辑修改分享/视频内容： +配置分享视频，登录后台->头部tab切换到【游戏数据】->【配置相关】->【分享/视频配置】可新增、编辑修改分享/视频内容： ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_023.png "🔍点击查看大图") @@ -55,7 +53,7 @@ - 接入此模块前，请[**前往sdk/config.js文件中配置【IsUseShareModule: true 】开启分享视频模块功能**](install.md#config_env)，此参数配置为true，才能正常使用此模块的功能，SDK启动时会自动拉取后台配置所有功能点的分享/视频配置列表。 -- 微信小游戏开发者接入此模块，如果游戏有很多分享点，提审时避免触犯微信平台的[滥用分享行为](https://developers.weixin.qq.com/minigame/product/#_5-1-滥用分享行为)，在后台【配置参数】中配置了一个SDK内部使用的[配置参数](online.md)share_unlock，进行分享开关切换：1（开启）0（关闭），提审时设置为0，审核通过后设为1。share_unlock设置为0，所有的功能点不会分享完成、拉起看完视频后发放奖励，而是直接发放奖励，这样就能避免审核时，如果是推送分享拉起分享，被微信认为是诱导分享，被拒的可能性。 +- 微信小游戏开发者接入此模块，游戏有些分享点，提审时避免触犯微信平台的[滥用分享行为](https://developers.weixin.qq.com/minigame/product/#_5-1-滥用分享行为)，在后台【配置参数】中配置了一个SDK内部使用的[配置参数](online.md)share_unlock，进行分享开关切换：1（开启）0（关闭），提审时设置为0，审核通过后设为1。share_unlock设置为0，所有使用PCSDK.shareVideo.dispatch( key, { success: Function, fail: Function , context:any })的功能点不会触发调起平台的分享or拉取平台视频，而是会直接触发success回调函数。这样就能避免审核时，如果推送分享拉起分享发放奖励，被微信认为是诱导分享，被拒的可能性。 - sdk/config.js的配置参数ShareRightKey，表示右上角分享的分享视频key，请配置到后台【分享/视频配置】中。如果ShareRightKey配置不为空，SDK会自动调用微信的右上角分享接口(wx.onShareAppMessage)，实现右上角分享功能，注意的是开发者在游戏中已经有注册wx.onShareAppMessage需要删除掉，不然游戏中onShareAppMessage的注册事件会把SDK中的注册事件处理函数覆盖掉，导致还是使用的是开发者注册的右上角分享功能。 @@ -73,7 +71,7 @@ | ------------------------------- | ------------------------------------------------------------ | | PCSDK.shareVideo.share | 普通分享，不需要处理回调的场景，例如分享到群、分享到好友，这些普通的分享，而不用处理成功/失败回调函数。 | | PCSDK.shareVideo.dispatch | 分享视频分发入口，传入功能点英文命名的分享/视频key | -| PCSDK.shareVideo.getShareVideoType | 根据功能点在后台配置的分享/视频key，得到此功能点分享开关（推送类型）SDK计算得到最终推送类型：-1(无视频无分享)、0(分享）、1(异步分享）、5(分享积分)、2(视频)、3(无视频则分享)、4(视频和分享)(控制分享和视频两个按钮的显示) | +| PCSDK.shareVideo.getType | 根据功能点在后台配置的分享/视频key，得到此功能点分享开关（推送类型）SDK计算得到最终推送类型：-1(无视频无分享)、0(分享）、1(异步分享）、5(分享积分)、2(视频)、3(无视频则分享)、4(视频和分享)(控制分享和视频两个按钮的显示) | @@ -240,10 +238,10 @@ } ``` -3. ##### **getShareVideoType** +3. ##### **getType** ```javascript - PCSDK.shareVideo.getShareVideoType( key: string ): number + PCSDK.shareVideo.getType( key: string ): number ``` 定义：根据分享视频key获取此次shareVideo模块推送的分享视频类型值：-1（无视频无分享：提审时返回）、0（推送同步分享）、1（推送异步分享）、2（推送看视频）、3（无视频则分享）、4（视频和分享）、5（分享积分）；此api用于通过得到的类型值处理页面的ui状态（微信和QQ平台对按钮的icon有强制限制）：显示视频icon、显示分享icon、既没有分享icon，也没有视频icon。 @@ -276,81 +274,81 @@ ```javascript // DiamondDoublePopwin.ts文件 export default class DiamondDoublePopwin extends BaseView{ - protected addEvent() { - super.addEvent(); - // 免费领取双倍（应对微信审核，审核分享不能开放时候使用） - this.btnFree.on(Laya.Event.CLICK, this, this.onReward); - // 分享双倍 - this.btnShare.on(Laya.Event.CLICK, this, this.onReward); - // 视频双倍 - this.btnVideo.on(Laya.Event.CLICK, this, this.onReward); - } + protected addEvent() { + super.addEvent(); + // 免费领取双倍（应对微信审核，审核分享不能开放时候使用） + this.btnFree.on(Laya.Event.CLICK, this, this.onReward); + // 分享双倍 + this.btnShare.on(Laya.Event.CLICK, this, this.onReward); + // 视频双倍 + this.btnVideo.on(Laya.Event.CLICK, this, this.onReward); + } - protected removeEvent() { - super.removeEvent(); - this.btnFree.off(Laya.Event.CLICK, this, this.onReward); - this.btnShare.off(Laya.Event.CLICK, this, this.onReward); - this.btnVideo.off(Laya.Event.CLICK, this, this.onReward); + protected removeEvent() { + super.removeEvent(); + this.btnFree.off(Laya.Event.CLICK, this, this.onReward); + this.btnShare.off(Laya.Event.CLICK, this, this.onReward); + this.btnVideo.off(Laya.Event.CLICK, this, this.onReward); } - // 每次打开此popwin执行onOpen - protected onOpen(){ - super.onOpen(); - this.iniitRewardUI(); - } - - // 初始化/更新获得奖励按钮ui - private initRewardUI() { - let shareVideoType: ShareVideoType = PCSDK.shareVideo.getShareVideoType(ShareVideoKeys.DiamondDouble.toString()); - switch (shareVideoType) { - case ShareVideoType.Share: // 同步分享 - case ShareVideoType.ShareAysnc: // 异步分享 - case ShareVideoType.ShareIntegral: // 分享积分 - this.btnFree.visible = false; - this.btnShare.visible = true; - this.btnVideo.visible = false; - break; - - case ShareVideoType.Video: // 推送视频 - case ShareVideoType.VideoToShare: // 无视频则分享 - // 视频ui状态 - this.btnFree.visible = false; - this.btnShare.visible = false; - this.btnVideo.visible = true; - break; - - default: // 无视频和无分享 - // 既不显示分享ui又不显示视频ui，直接领奖ui状态 - this.btnFree.visible = true; - this.btnShare.visible = false; - this.btnVideo.visible = false; - break; - } - } - - // 领取奖励操作 - private onReward(){ - PCSDK.shareVideo.dispatch( ShareVideoKeys.DiamondDouble.toString(), { - success: this.handleReward, - fail: this.handleError, - context: this - } ); - } - - // 分享/视频成功后回调处理函数：发奖励 - private handleReward(from: ShareVideoFrom, ret: any | null){ - // 分享成功、视频成功、无视频无分享 - } + // 每次打开此popwin执行onOpen + protected onOpen(){ + super.onOpen(); + this.iniitRewardUI(); + } - // 分享/视频失败后回调处理函数：弹出提示 - private handleError(from: ShareVideoFrom, error: any | null){ - // 返回错误，处理错误msg信息，自定义处理 - if( error ){ - wx.showToast({ - title: error.msg - }); - } - } + // 初始化/更新获得奖励按钮ui + private initRewardUI() { + let shareVideoType: ShareVideoType = PCSDK.shareVideo.getType(ShareVideoKeys.DiamondDouble.toString()); + switch (shareVideoType) { + case ShareVideoType.Share: // 同步分享 + case ShareVideoType.ShareAysnc: // 异步分享 + case ShareVideoType.ShareIntegral: // 分享积分 + this.btnFree.visible = false; + this.btnShare.visible = true; + this.btnVideo.visible = false; + break; + + case ShareVideoType.Video: // 推送视频 + case ShareVideoType.VideoToShare: // 无视频则分享 + // 视频ui状态 + this.btnFree.visible = false; + this.btnShare.visible = false; + this.btnVideo.visible = true; + break; + + default: // 无视频和无分享 + // 既不显示分享ui又不显示视频ui，直接领奖ui状态 + this.btnFree.visible = true; + this.btnShare.visible = false; + this.btnVideo.visible = false; + break; + } + } + + // 领取奖励操作 + private onReward(){ + PCSDK.shareVideo.dispatch( ShareVideoKeys.DiamondDouble.toString(), { + success: this.handleReward, + fail: this.handleError, + context: this + } ); + } + + // 分享/视频成功后回调处理函数：发奖励 + private handleReward(from: ShareVideoFrom, ret: any | null){ + // 分享成功、视频成功、无视频无分享 + } + + // 分享/视频失败后回调处理函数：弹出提示 + private handleError(from: ShareVideoFrom, error: any | null){ + // 返回错误，处理错误msg信息，自定义处理 + if( error ){ + wx.showToast({ + title: error.msg + }); + } + } } // Enums.ts文件 @@ -383,7 +381,7 @@ ```
- 下面演示dispatch和getShareVideoType两个api的完整使用，Laya引擎开发： + 下面演示dispatch和getType两个api的完整使用，Laya引擎开发： 页面功能点按钮做三个状态： @@ -401,104 +399,104 @@ ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_027_4.png "🔍点击查看大图") - 例如，一个领取钻石双倍，页面的按钮ui通过下面的方式进行切换 + 例如：一个领取钻石双倍功能 - 1、页面做三个按钮：视频icon按钮、分享icon按钮、直接领取按钮 + 1、页面做三个按钮：看视频领取双倍按钮（视频图标）、分享领取双倍按钮（分享图标）、直接领取按钮（没有任何图标） 2、进入页面根据配置的key获取类型，显示对应类型ui：调用下面的initRewardUI(可随意命名) - 3、分享或者视频后，SDK会发送一个tactic.update的消息过来，使用PCSDK.event.add注册监听，PCSDK.event.remove移除监听（PCSDK.event详细了解请查看[事件模块](event.md)），监听事件处理下一次推送显示ui状态：执行一下initRewardUI。 + 3、分享或者视频后，SDK会发提供PCSDK.event模块发送一个'tactic.update'的消息，使用PCSDK.event.add注册消息监听，PCSDK.event.remove移除消息监听（PCSDK.event详细了解请查看[事件模块](event.md)），监听函数处理下一次推送显示ui状态：执行一下initRewardUI。 4、给三个按钮都注册事件：onReward ```javascript // DiamondDoublePopwin.ts文件 export default class DiamondDoublePopwin extends BaseView { - protected addEvent() { - super.addEvent(); - // 免费领取双倍（应对微信审核，审核分享不能开放时候使用） + protected addEvent() { + super.addEvent(); + // 免费领取双倍（应对微信审核，审核分享不能开放时候使用） this.btnFree.on(Laya.Event.CLICK, this, this.onReward); // 分享双倍 this.btnShare.on(Laya.Event.CLICK, this, this.onReward); // 视频双倍 this.btnVideo.on(Laya.Event.CLICK, this, this.onReward); - // PCSDK.event.add注册监听SDK发送的消息：tactic.update，更新获得奖励按钮ui - PCSDK.event.add('tactic.update', this.initRewardUI, this); - } + // PCSDK.event.add注册监听SDK发送的消息：tactic.update，更新获得奖励按钮ui + PCSDK.event.add('tactic.update', this.initRewardUI, this); + } - protected removeEvent() { + protected removeEvent() { super.removeEvent(); - this.btnFree.off(Laya.Event.CLICK, this, this.onReward); - this.btnShare.off(Laya.Event.CLICK, this, this.onReward); - this.btnVideo.off(Laya.Event.CLICK, this, this.onReward); - // PCSDK.event.remove移除监听SDK发送的消息：tactic.update - PCSDK.event.remove('tactic.update', this.initRewardUI, this); - } + this.btnFree.off(Laya.Event.CLICK, this, this.onReward); + this.btnShare.off(Laya.Event.CLICK, this, this.onReward); + this.btnVideo.off(Laya.Event.CLICK, this, this.onReward); + // PCSDK.event.remove移除监听SDK发送的消息：tactic.update + PCSDK.event.remove('tactic.update', this.initRewardUI, this); + } // 每次打开此popwin执行onOpen - protected onOpen(){ - super.onOpen(); - // 界面打开 - this.initRewardUI(); - } - - // 领取奖励操作 - private onReward(){ - PCSDK.shareVideo.dispatch( ShareVideoKeys.DiamondDouble.toString(), { - success: this.handleReward, - context: this - } ); - } + protected onOpen(){ + super.onOpen(); + // 界面打开 + this.initRewardUI(); + } + + // 领取奖励操作 + private onReward(){ + PCSDK.shareVideo.dispatch( ShareVideoKeys.DiamondDouble.toString(), { + success: this.handleReward, + context: this + } ); + } - // 分享/视频成功后回调处理函数：发奖励 - private handleReward(from: ShareVideoFrom, ret: any | null){ - // 分享成功、视频成功、无视频无分享 - } + // 分享/视频成功后回调处理函数：发奖励 + private handleReward(from: ShareVideoFrom, ret: any | null){ + // 分享成功、视频成功、无视频无分享 + } - // 分享/视频失败后回调处理函数：弹出提示 - private handleError(from: ShareVideoFrom, error: any | null){ + // 分享/视频失败后回调处理函数：弹出提示 + private handleError(from: ShareVideoFrom, error: any | null){ // 返回错误，处理错误msg信息，自定义处理 - if( error ){ - wx.showToast({ + if( error ){ + wx.showToast({ title: error.msg - }); - } - } + }); + } + } // 初始化/更新获得奖励按钮ui - private initRewardUI() { - let shareVideoType: ShareType = PCSDK.shareVideo.getShareVideoType(ShareVideoKeys.DiamondDouble.toString()); - switch (shareVideoType) { - case ShareVideoType.Share: // 同步分享 - case ShareVideoType.ShareAysnc: // 异步分享 - case ShareVideoType.ShareIntegral: // 分享积分 - // 分享ui状态 - this.stat_share.play(0,false); - // 等同于 + private initRewardUI() { + let shareVideoType: ShareType = PCSDK.shareVideo.getType(ShareVideoKeys.DiamondDouble.toString()); + switch (shareVideoType) { + case ShareVideoType.Share: // 同步分享 + case ShareVideoType.ShareAysnc: // 异步分享 + case ShareVideoType.ShareIntegral: // 分享积分 + // 分享ui状态 + this.stat_share.play(0,false); + // 等同于 // this.btnFree.visible = false; // this.btnShare.visible = true; // this.btnVideo.visible = false; - break; - - case ShareVideoType.Video: // 视频 - case ShareVideoType.VideoToShare: // 无视频则分享 - // 视频ui状态 - this.stat_video.play(0,false); - // 等同于 - // this.btnFree.visible = false; - // this.btnShare.visible = false; - // this.btnVideo.visible = true; - break; - - default: // 无视频和无分享 - // 既不显示分享ui又不显示视频ui，直接领奖ui状态 - this.stat_free.play(0,false); - // 等同于 + break; + + case ShareVideoType.Video: // 视频 + case ShareVideoType.VideoToShare: // 无视频则分享 + // 视频ui状态 + this.stat_video.play(0,false); + // 等同于 + // this.btnFree.visible = false; + // this.btnShare.visible = false; + // this.btnVideo.visible = true; + break; + + default: // 无视频和无分享 + // 既不显示分享ui又不显示视频ui，直接领奖ui状态 + this.stat_free.play(0,false); + // 等同于 // this.btnFree.visible = true; // this.btnShare.visible = false; // this.btnVideo.visible = false; - break; - } - } + break; + } + } } // Enums.ts文件 @@ -536,4 +534,4 @@ 这个模块的内容点比较多，接入的注意事项也比较多，望接入者细度使用说明和理解示例意图。 -噗嗤游戏的小伙伴在开发公司内部游戏中使用此模块，简单封装了SDK分享视频模块的几个通用方法，提供开发者参考，**[点击下载](https://dep.miso-lab.com/sdkword/tools/sdk-share-tools-1.0.0.zip)**。 +噗嗤游戏的小伙伴在开发公司内部游戏中使用此模块，简单封装了SDK分享视频模块的几个通用方法，提供开发者参考，**[点击下载](https://dep.miso-lab.com/sdkword/tools/sdk-share-tools-1.0.1.zip)**。 diff --git a/outer/download.md b/outer/download.md index 0004689..09d2b0d 100644 --- a/outer/download.md +++ b/outer/download.md @@ -38,7 +38,7 @@ 1. config.js配置ShareData新增share_wxad_id参数：视频广告uid，配置此参数，推送看视频，不配置或者配置的uid无效则推送分享。 2. stat模块的addLogLevel拆分为多个接口：logLevelRelive、logLevelWin、logLevelFail、logLevelHide，addLogLevel继续保留。 3. data模块新增了三个控制交叉推广位动态控制显示/隐藏的api：IsCross、IsDrawer、IsGuessLike。 -4. share模块重新命名为：shareVideo，shareDispatch修改为dispatch、shareWithType修改为dispatchType、getShareType修改为getShareVideoType，原来的share模块还是能用。 +4. share模块重新命名为：shareVideo，原来的share模块还是能用。shareDispatch修改为dispatch、shareWithType修改为dispatchType、getShareType修改为getType。 ## [v1.0.0.0 下载](https://dep.miso-lab.com/sdkword/versions/sdk-out-v1.0.0.0.zip) diff --git a/outer/modules.md b/outer/modules.md index f4a8dbd..e44d9dd 100644 --- a/outer/modules.md +++ b/outer/modules.md @@ -84,4 +84,4 @@ dispatch：分享视频分发入口，传入功能点英文命名的分享/视频key - getShareVideoType：根据功能点在后台配置的分享/视频key，得到此功能点分享开关 + getType：根据功能点在后台配置的分享/视频key，得到此功能点分享开关 diff --git a/outer/share.md b/outer/share.md index 2f52757..58b8cfb 100644 --- a/outer/share.md +++ b/outer/share.md @@ -1,39 +1,37 @@ - # 分享视频模块 ------ #### **简介** -小游戏生态中，普遍把平台提供的分享/视频接口更多用于某个奖励领取、获取n倍奖励、游戏死亡复活、转盘额外次数获得等等一种有效途径（分享：拉取新用户，视频：赚钱广告费）；噗嗤游戏在分享or视频推送不断的探索迭代中，总结了一套分享/视频积分策略，集成在SDK中开放给开发者，开发者只需对游戏中分享视频功能点命名一个英文名称key（分享视频key），这个key关联分享文案、分享图、分享开关（推送类型）、视频uid等等在后台配置好，使用SDK提供的一个dispatch api传入英文名称key即可完成接入工作。 +小游戏生态中，普遍把平台提供的分享/视频接口更多用于某个奖励领取、获取n倍奖励、游戏死亡复活、转盘额外次数获得等等一种有效途径（分享：拉取新用户，视频：赚钱广告费）；噗嗤游戏在分享/视频推送不断的迭代中，总结了一套分享/视频积分策略，集成在SDK中开放给开发者，开发者只需对游戏中分享视频功能点命名一个英文名称key（分享视频key），在后台配置这个key关联的分享文案、分享图、分享开关（推送类型）、视频uid等等信息，使用SDK提供的一个dispatch api传入分享视频key即可完成接入工作。 -- 分享/视频配置可以让开发者在后台中动态修改相关功能点的分享/视频配置内容。 -- 新增某个功能的分享点配置、在线修改相关功能点的分享图或文案、在线切换某个功能点按钮的分享/视频推送类型。 +- 后台的【分享/视频配置】功能可以让开发者动态修改相关功能点的分享/视频配置的分享文案、分享图、分享开关（推送类型）、视频uid等等信息。 -- 调用SDK的dispatch api，dispatch会根据后台配置的分享开关（推送类型）自动进行分发：推送分享还是视频全权交由SDK去处理，开发者只需要传入成功/失败回调函数，成功回调函数处理发放领取奖励、n倍奖励、成功复活等操作，失败回调函数处理参数传递的msg信息。 +- 调用SDK的dispatch api，dispatch会根据后台配置的分享开关（推送类型）自动进行分发：推送分享or视频全权交由SDK去处理，开发者只需要传入成功/失败回调函数，成功回调函数处理成功后的逻辑，失败回调函数处理参数传递的错误msg信息。 #### **疑惑解答** 1. 为什么要引入这个模块？ - > 游戏中很多n倍奖励、复活、额外奖励等功能点通常需要分享或者视频才能额外获得，游戏上线后，运营很有可能会对某些功能点有额外的需求修改：a功能点获取由分享改成视频方式获取、b功能点由视频改成分享方式获取、c功能点需要在前面n次看视频获得后全是分享获得、为某某功能的分享图想换一个、拉取视频不成功自动切换分享等等；为了应对这些不同情形，我们把分享和视频点包装成一个模块，a功能点也不在局限于只是简单的分享、b功能只是视频，而是通过后台分享开关去灵活切换。所有功能点入口调用都是使用dispatch，每个功能点都是转化为一个分享视频key在后台管理。 + > 游戏中很多n倍奖励、复活、额外奖励等功能点通常需要分享或者视频才能额外获得。游戏上线后，运营可能会对这些功能点有修改需求：a功能点领取奖励由分享改成视频方式领取、b功能点由视频改成分享方式获取、c功能点需要在前面n次看视频领取过后，后面全是分享获得、某个分享点的分享图片和文案修改等等；为了应对这些不同情形，我们把分享和视频点包装成一个模块，每个功能点转成key在后台进行管理，功能点也不在局限于只是简单的推送分享，单一的推送视频，而是可以根据运营情况进行灵活切换。 2. 什么是分享视频key？ - > 分享视频key是一个功能点的英文名称，这个key配置在后台中，关联分享文案、分享图、分享开关（推送类型）、视频uid等等信息。某个功能点（不论是分享还是视频方式）调用dispatch传入这个key，SDK会读取这个key关联的信息，根据分享开关（推送类型）来推送分享（需要分享文案、分享图）还是推送视频（需要视频uid）。 + > 分享视频key是一个功能点的英文名称，这个key是开发者根据功能点命名的，开发者自己或者策划把这个key关联的分享文案、分享图、分享开关（推送类型）、视频uid等等信息配置在后台；完成配置后，使用PCSDK.shareVideo.dispatch传入这个key，PCSDK会读取这个key关联的信息，根据分享开关（推送类型）来推送分享（读取配置的分享文案、分享图）还是推送视频（读取配置的视频uid）。 3. 什么是分享视频分发？ - > 调用dispatch api传入分享视频key，SDK会查找这个key在后台配置的数据，SDK读取数据中分享开关（推送类型）的字段信息，通过这个开关类型来判断推给用户是分享还是视频，这个根据类型来推送的操作就是分发操作。 + > 使用PCSDK.shareVideo.dispatch传入分享视频key，SDK会查找这个key在后台配置的数据信息，SDK读取数据中分享开关（推送类型），通过推送类型来计算推给用户是分享还是视频，这个根据推送类型来推送的操作就是分发操作。 4. 游戏中之前是玩家分享n次后变成看视频或者是看视频n次后全是分享，dispatch能满足吗？ - > 上面的问题dispatch也同样支持，还是同样的调用方式，不需要做其他额外处理，dispatch是怎么做到的了：分享开关（推送类型）有一个分享积分选择项，这个选项就是通过积分策略实现了上面问题。 + > 上面的问题dispatch也同样支持，还是一样的调用方式，不需要额外的传递参数，只需在后台修改分享开关（推送类型） > #### **后台使用** -配置分享视频配置，登录后台->头部tab切换到【游戏数据】->【配置相关】->【分享/视频配置】可新增、编辑修改分享/视频内容： +配置分享视频，登录后台->头部tab切换到【游戏数据】->【配置相关】->【分享/视频配置】可新增、编辑修改分享/视频内容： ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_023.png "🔍点击查看大图") @@ -55,7 +53,7 @@ - 接入此模块前，请[**前往sdk/config.js文件中配置【IsUseShareModule: true 】开启分享视频模块功能**](install.md#config_env)，此参数配置为true，才能正常使用此模块的功能，SDK启动时会自动拉取后台配置所有功能点的分享/视频配置列表。 -- 微信小游戏开发者接入此模块，如果游戏有很多分享点，提审时避免触犯微信平台的[滥用分享行为](https://developers.weixin.qq.com/minigame/product/#_5-1-滥用分享行为)，在后台【配置参数】中配置了一个SDK内部使用的[配置参数](online.md)share_unlock，进行分享开关切换：1（开启）0（关闭），提审时设置为0，审核通过后设为1。share_unlock设置为0，所有的功能点不会分享完成、拉起看完视频后发放奖励，而是直接发放奖励，这样就能避免审核时，如果是推送分享拉起分享，被微信认为是诱导分享，被拒的可能性。 +- 微信小游戏开发者接入此模块，游戏有些分享点，提审时避免触犯微信平台的[滥用分享行为](https://developers.weixin.qq.com/minigame/product/#_5-1-滥用分享行为)，在后台【配置参数】中配置了一个SDK内部使用的[配置参数](online.md)share_unlock，进行分享开关切换：1（开启）0（关闭），提审时设置为0，审核通过后设为1。share_unlock设置为0，所有使用PCSDK.shareVideo.dispatch( key, { success: Function, fail: Function , context:any })的功能点不会触发调起平台的分享or拉取平台视频，而是会直接触发success回调函数。这样就能避免审核时，如果推送分享拉起分享发放奖励，被微信认为是诱导分享，被拒的可能性。 - sdk/config.js的配置参数ShareRightKey，表示右上角分享的分享视频key，请配置到后台【分享/视频配置】中。如果ShareRightKey配置不为空，SDK会自动调用微信的右上角分享接口(wx.onShareAppMessage)，实现右上角分享功能，注意的是开发者在游戏中已经有注册wx.onShareAppMessage需要删除掉，不然游戏中onShareAppMessage的注册事件会把SDK中的注册事件处理函数覆盖掉，导致还是使用的是开发者注册的右上角分享功能。 @@ -73,7 +71,7 @@ | ------------------------------- | ------------------------------------------------------------ | | PCSDK.shareVideo.share | 普通分享，不需要处理回调的场景，例如分享到群、分享到好友，这些普通的分享，而不用处理成功/失败回调函数。 | | PCSDK.shareVideo.dispatch | 分享视频分发入口，传入功能点英文命名的分享/视频key | -| PCSDK.shareVideo.getShareVideoType | 根据功能点在后台配置的分享/视频key，得到此功能点分享开关（推送类型）SDK计算得到最终推送类型：-1(无视频无分享)、0(分享）、1(异步分享）、5(分享积分)、2(视频)、3(无视频则分享)、4(视频和分享)(控制分享和视频两个按钮的显示) | +| PCSDK.shareVideo.getType | 根据功能点在后台配置的分享/视频key，得到此功能点分享开关（推送类型）SDK计算得到最终推送类型：-1(无视频无分享)、0(分享）、1(异步分享）、5(分享积分)、2(视频)、3(无视频则分享)、4(视频和分享)(控制分享和视频两个按钮的显示) | @@ -240,10 +238,10 @@ } ``` -3. ##### **getShareVideoType** +3. ##### **getType** ```javascript - PCSDK.shareVideo.getShareVideoType( key: string ): number + PCSDK.shareVideo.getType( key: string ): number ``` 定义：根据分享视频key获取此次shareVideo模块推送的分享视频类型值：-1（无视频无分享：提审时返回）、0（推送同步分享）、1（推送异步分享）、2（推送看视频）、3（无视频则分享）、4（视频和分享）、5（分享积分）；此api用于通过得到的类型值处理页面的ui状态（微信和QQ平台对按钮的icon有强制限制）：显示视频icon、显示分享icon、既没有分享icon，也没有视频icon。 @@ -276,81 +274,81 @@ ```javascript // DiamondDoublePopwin.ts文件 export default class DiamondDoublePopwin extends BaseView{ - protected addEvent() { - super.addEvent(); - // 免费领取双倍（应对微信审核，审核分享不能开放时候使用） - this.btnFree.on(Laya.Event.CLICK, this, this.onReward); - // 分享双倍 - this.btnShare.on(Laya.Event.CLICK, this, this.onReward); - // 视频双倍 - this.btnVideo.on(Laya.Event.CLICK, this, this.onReward); - } + protected addEvent() { + super.addEvent(); + // 免费领取双倍（应对微信审核，审核分享不能开放时候使用） + this.btnFree.on(Laya.Event.CLICK, this, this.onReward); + // 分享双倍 + this.btnShare.on(Laya.Event.CLICK, this, this.onReward); + // 视频双倍 + this.btnVideo.on(Laya.Event.CLICK, this, this.onReward); + } - protected removeEvent() { - super.removeEvent(); - this.btnFree.off(Laya.Event.CLICK, this, this.onReward); - this.btnShare.off(Laya.Event.CLICK, this, this.onReward); - this.btnVideo.off(Laya.Event.CLICK, this, this.onReward); + protected removeEvent() { + super.removeEvent(); + this.btnFree.off(Laya.Event.CLICK, this, this.onReward); + this.btnShare.off(Laya.Event.CLICK, this, this.onReward); + this.btnVideo.off(Laya.Event.CLICK, this, this.onReward); } - // 每次打开此popwin执行onOpen - protected onOpen(){ - super.onOpen(); - this.iniitRewardUI(); - } - - // 初始化/更新获得奖励按钮ui - private initRewardUI() { - let shareVideoType: ShareVideoType = PCSDK.shareVideo.getShareVideoType(ShareVideoKeys.DiamondDouble.toString()); - switch (shareVideoType) { - case ShareVideoType.Share: // 同步分享 - case ShareVideoType.ShareAysnc: // 异步分享 - case ShareVideoType.ShareIntegral: // 分享积分 - this.btnFree.visible = false; - this.btnShare.visible = true; - this.btnVideo.visible = false; - break; - - case ShareVideoType.Video: // 推送视频 - case ShareVideoType.VideoToShare: // 无视频则分享 - // 视频ui状态 - this.btnFree.visible = false; - this.btnShare.visible = false; - this.btnVideo.visible = true; - break; - - default: // 无视频和无分享 - // 既不显示分享ui又不显示视频ui，直接领奖ui状态 - this.btnFree.visible = true; - this.btnShare.visible = false; - this.btnVideo.visible = false; - break; - } - } - - // 领取奖励操作 - private onReward(){ - PCSDK.shareVideo.dispatch( ShareVideoKeys.DiamondDouble.toString(), { - success: this.handleReward, - fail: this.handleError, - context: this - } ); - } - - // 分享/视频成功后回调处理函数：发奖励 - private handleReward(from: ShareVideoFrom, ret: any | null){ - // 分享成功、视频成功、无视频无分享 - } + // 每次打开此popwin执行onOpen + protected onOpen(){ + super.onOpen(); + this.iniitRewardUI(); + } - // 分享/视频失败后回调处理函数：弹出提示 - private handleError(from: ShareVideoFrom, error: any | null){ - // 返回错误，处理错误msg信息，自定义处理 - if( error ){ - wx.showToast({ - title: error.msg - }); - } - } + // 初始化/更新获得奖励按钮ui + private initRewardUI() { + let shareVideoType: ShareVideoType = PCSDK.shareVideo.getType(ShareVideoKeys.DiamondDouble.toString()); + switch (shareVideoType) { + case ShareVideoType.Share: // 同步分享 + case ShareVideoType.ShareAysnc: // 异步分享 + case ShareVideoType.ShareIntegral: // 分享积分 + this.btnFree.visible = false; + this.btnShare.visible = true; + this.btnVideo.visible = false; + break; + + case ShareVideoType.Video: // 推送视频 + case ShareVideoType.VideoToShare: // 无视频则分享 + // 视频ui状态 + this.btnFree.visible = false; + this.btnShare.visible = false; + this.btnVideo.visible = true; + break; + + default: // 无视频和无分享 + // 既不显示分享ui又不显示视频ui，直接领奖ui状态 + this.btnFree.visible = true; + this.btnShare.visible = false; + this.btnVideo.visible = false; + break; + } + } + + // 领取奖励操作 + private onReward(){ + PCSDK.shareVideo.dispatch( ShareVideoKeys.DiamondDouble.toString(), { + success: this.handleReward, + fail: this.handleError, + context: this + } ); + } + + // 分享/视频成功后回调处理函数：发奖励 + private handleReward(from: ShareVideoFrom, ret: any | null){ + // 分享成功、视频成功、无视频无分享 + } + + // 分享/视频失败后回调处理函数：弹出提示 + private handleError(from: ShareVideoFrom, error: any | null){ + // 返回错误，处理错误msg信息，自定义处理 + if( error ){ + wx.showToast({ + title: error.msg + }); + } + } } // Enums.ts文件 @@ -383,7 +381,7 @@ ```
- 下面演示dispatch和getShareVideoType两个api的完整使用，Laya引擎开发： + 下面演示dispatch和getType两个api的完整使用，Laya引擎开发： 页面功能点按钮做三个状态： @@ -401,104 +399,104 @@ ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_027_4.png "🔍点击查看大图") - 例如，一个领取钻石双倍，页面的按钮ui通过下面的方式进行切换 + 例如：一个领取钻石双倍功能 - 1、页面做三个按钮：视频icon按钮、分享icon按钮、直接领取按钮 + 1、页面做三个按钮：看视频领取双倍按钮（视频图标）、分享领取双倍按钮（分享图标）、直接领取按钮（没有任何图标） 2、进入页面根据配置的key获取类型，显示对应类型ui：调用下面的initRewardUI(可随意命名) - 3、分享或者视频后，SDK会发送一个tactic.update的消息过来，使用PCSDK.event.add注册监听，PCSDK.event.remove移除监听（PCSDK.event详细了解请查看[事件模块](event.md)），监听事件处理下一次推送显示ui状态：执行一下initRewardUI。 + 3、分享或者视频后，SDK会发提供PCSDK.event模块发送一个'tactic.update'的消息，使用PCSDK.event.add注册消息监听，PCSDK.event.remove移除消息监听（PCSDK.event详细了解请查看[事件模块](event.md)），监听函数处理下一次推送显示ui状态：执行一下initRewardUI。 4、给三个按钮都注册事件：onReward ```javascript // DiamondDoublePopwin.ts文件 export default class DiamondDoublePopwin extends BaseView { - protected addEvent() { - super.addEvent(); - // 免费领取双倍（应对微信审核，审核分享不能开放时候使用） + protected addEvent() { + super.addEvent(); + // 免费领取双倍（应对微信审核，审核分享不能开放时候使用） this.btnFree.on(Laya.Event.CLICK, this, this.onReward); // 分享双倍 this.btnShare.on(Laya.Event.CLICK, this, this.onReward); // 视频双倍 this.btnVideo.on(Laya.Event.CLICK, this, this.onReward); - // PCSDK.event.add注册监听SDK发送的消息：tactic.update，更新获得奖励按钮ui - PCSDK.event.add('tactic.update', this.initRewardUI, this); - } + // PCSDK.event.add注册监听SDK发送的消息：tactic.update，更新获得奖励按钮ui + PCSDK.event.add('tactic.update', this.initRewardUI, this); + } - protected removeEvent() { + protected removeEvent() { super.removeEvent(); - this.btnFree.off(Laya.Event.CLICK, this, this.onReward); - this.btnShare.off(Laya.Event.CLICK, this, this.onReward); - this.btnVideo.off(Laya.Event.CLICK, this, this.onReward); - // PCSDK.event.remove移除监听SDK发送的消息：tactic.update - PCSDK.event.remove('tactic.update', this.initRewardUI, this); - } + this.btnFree.off(Laya.Event.CLICK, this, this.onReward); + this.btnShare.off(Laya.Event.CLICK, this, this.onReward); + this.btnVideo.off(Laya.Event.CLICK, this, this.onReward); + // PCSDK.event.remove移除监听SDK发送的消息：tactic.update + PCSDK.event.remove('tactic.update', this.initRewardUI, this); + } // 每次打开此popwin执行onOpen - protected onOpen(){ - super.onOpen(); - // 界面打开 - this.initRewardUI(); - } - - // 领取奖励操作 - private onReward(){ - PCSDK.shareVideo.dispatch( ShareVideoKeys.DiamondDouble.toString(), { - success: this.handleReward, - context: this - } ); - } + protected onOpen(){ + super.onOpen(); + // 界面打开 + this.initRewardUI(); + } + + // 领取奖励操作 + private onReward(){ + PCSDK.shareVideo.dispatch( ShareVideoKeys.DiamondDouble.toString(), { + success: this.handleReward, + context: this + } ); + } - // 分享/视频成功后回调处理函数：发奖励 - private handleReward(from: ShareVideoFrom, ret: any | null){ - // 分享成功、视频成功、无视频无分享 - } + // 分享/视频成功后回调处理函数：发奖励 + private handleReward(from: ShareVideoFrom, ret: any | null){ + // 分享成功、视频成功、无视频无分享 + } - // 分享/视频失败后回调处理函数：弹出提示 - private handleError(from: ShareVideoFrom, error: any | null){ + // 分享/视频失败后回调处理函数：弹出提示 + private handleError(from: ShareVideoFrom, error: any | null){ // 返回错误，处理错误msg信息，自定义处理 - if( error ){ - wx.showToast({ + if( error ){ + wx.showToast({ title: error.msg - }); - } - } + }); + } + } // 初始化/更新获得奖励按钮ui - private initRewardUI() { - let shareVideoType: ShareType = PCSDK.shareVideo.getShareVideoType(ShareVideoKeys.DiamondDouble.toString()); - switch (shareVideoType) { - case ShareVideoType.Share: // 同步分享 - case ShareVideoType.ShareAysnc: // 异步分享 - case ShareVideoType.ShareIntegral: // 分享积分 - // 分享ui状态 - this.stat_share.play(0,false); - // 等同于 + private initRewardUI() { + let shareVideoType: ShareType = PCSDK.shareVideo.getType(ShareVideoKeys.DiamondDouble.toString()); + switch (shareVideoType) { + case ShareVideoType.Share: // 同步分享 + case ShareVideoType.ShareAysnc: // 异步分享 + case ShareVideoType.ShareIntegral: // 分享积分 + // 分享ui状态 + this.stat_share.play(0,false); + // 等同于 // this.btnFree.visible = false; // this.btnShare.visible = true; // this.btnVideo.visible = false; - break; - - case ShareVideoType.Video: // 视频 - case ShareVideoType.VideoToShare: // 无视频则分享 - // 视频ui状态 - this.stat_video.play(0,false); - // 等同于 - // this.btnFree.visible = false; - // this.btnShare.visible = false; - // this.btnVideo.visible = true; - break; - - default: // 无视频和无分享 - // 既不显示分享ui又不显示视频ui，直接领奖ui状态 - this.stat_free.play(0,false); - // 等同于 + break; + + case ShareVideoType.Video: // 视频 + case ShareVideoType.VideoToShare: // 无视频则分享 + // 视频ui状态 + this.stat_video.play(0,false); + // 等同于 + // this.btnFree.visible = false; + // this.btnShare.visible = false; + // this.btnVideo.visible = true; + break; + + default: // 无视频和无分享 + // 既不显示分享ui又不显示视频ui，直接领奖ui状态 + this.stat_free.play(0,false); + // 等同于 // this.btnFree.visible = true; // this.btnShare.visible = false; // this.btnVideo.visible = false; - break; - } - } + break; + } + } } // Enums.ts文件 @@ -536,4 +534,4 @@ 这个模块的内容点比较多，接入的注意事项也比较多，望接入者细度使用说明和理解示例意图。 -噗嗤游戏的小伙伴在开发公司内部游戏中使用此模块，简单封装了SDK分享视频模块的几个通用方法，提供开发者参考，**[点击下载](https://dep.miso-lab.com/sdkword/tools/sdk-share-tools-1.0.0.zip)**。 +噗嗤游戏的小伙伴在开发公司内部游戏中使用此模块，简单封装了SDK分享视频模块的几个通用方法，提供开发者参考，**[点击下载](https://dep.miso-lab.com/sdkword/tools/sdk-share-tools-1.0.1.zip)**。 diff --git a/tools/sdk-share-tools-1.0.0.zip b/tools/sdk-share-tools-1.0.0.zip new file mode 100644 index 0000000..7461a81 Binary files /dev/null and b/tools/sdk-share-tools-1.0.0.zip differ diff --git a/tools/sdk-share-tools-1.0.1/SDKTools.ts b/tools/sdk-share-tools-1.0.1/SDKTools.ts new file mode 100644 index 0000000..63100c1 --- /dev/null +++ b/tools/sdk-share-tools-1.0.1/SDKTools.ts @@ -0,0 +1,49 @@ +import ShareVideoTools, { ShareVideoKeys, ShareVideoType } from "./ShareVideoTools"; + +/* +* SDK工具类库; +*/ +export default class SDKTools { + // 判断PCSDK是否支持 + static get isSupported() { + return typeof PCSDK === 'object'; + } + + /** + * 检测普通不是返回值为Promise的 api接口：在浏览器中或其他不支持的平台不至于报错 + * @param callback 接口 api函数 + * @param defaltVal 返回的默认值 + */ + private static checkNormal(callback: Function, defaltVal?: T): T { + if (!this.isSupported) return defaltVal; + return callback(); + } + + /** + * 检测普返回值为Promise的 api接口：在浏览器中或其他不支持的平台不至于报错 + * @param callback 接口 api函数 + * @param defaltVal 返回的默认值 + */ + private static checkPromise(callback: Function, defaultVal: Promise = Promise.resolve()): Promise { + return this.checkNormal>(callback, defaultVal); + } + + static getType(shareVideoKey: ShareVideoKeys): ShareVideoType { + return this.checkNormal(() => ShareVideoTools.getType(shareVideoKey), ShareVideoType.Share); + } + + static share(shareVideoKey: ShareVideoKeys, params?: any, opts?: any): void { + return this.checkNormal(() => ShareVideoTools.share(shareVideoKey, params, opts), null); + } + + static dispatch(shareVideoKey: ShareVideoKeys, params?: { type?: number, success?: Function, fail?: Function, context?: any }): void { + if (!this.isSupported) + return params && params.success && params.success.call(params.context || this); + else + return this.checkNormal(() => ShareVideoTools.dispatch(shareVideoKey, params), null); + } + + static dispatchType(shareVideoType: ShareVideoType, shareVideoKey: ShareVideoKeys, opts?: { success?: Function, fail?: Function, context?: any }): void { + return this.checkNormal(() => ShareVideoTools.dispatchType(shareVideoType, shareVideoKey, opts), null); + } +} \ No newline at end of file diff --git a/tools/sdk-share-tools-1.0.1/ShareVideoTools.ts b/tools/sdk-share-tools-1.0.1/ShareVideoTools.ts new file mode 100644 index 0000000..9b3fe0e --- /dev/null +++ b/tools/sdk-share-tools-1.0.1/ShareVideoTools.ts @@ -0,0 +1,150 @@ +/* +* 分享与视频工具类; +*/ +export default class ShareVideoTools { + /** + * @param key + * @param params + */ + static getType(key: ShareVideoKeys): ShareVideoType { + return PCSDK.shareVideo.getType(key.toString()); + } + + /** + * 普通分享，不进行处理回调 + * @param key + * @param params 分享参数 + * @param opts 扩展参数 + */ + static share(key: ShareVideoKeys, params: any, opts?: any) { + PCSDK.shareVideo.share(key.toString(), params, opts).then(ret => this.handleSuccess(ShareVideoFrom.Share, ret)); + } + + /** + * 验证分享：可处理成功、失败 + * @param key + * @param params + */ + static dispatch(key: ShareVideoKeys, params?: { type?: number, success?: Function, fail?: Function, context?: any }) { + PCSDK.shareVideo.shareDispatch(key.toString(), this.buildParams(params)); + } + + /** + * 可自定义类型的验证分享：例如后台配的shareVideoKey是分享，但是这个key临时想要看视频，可传递shareVideoType Video类型强制使用视频 + * @param shareVideoType + * @param key + * @param params + */ + static dispatchType(shareType: ShareVideoType, key: ShareVideoKeys, params?: { type?: number, success?: Function, fail?: Function, context?: any }) { + PCSDK.shareVideo.dispatchType(shareType, key.toString(), this.buildParams(params)); + } + + /** + * 对参数进行处理 + * @param params + */ + private static buildParams(params: any = {}) { + let { isOveride } = params; + let { success, fail, context } = params; + // 设置成功处理 + params = { + ...params, + success: (from: ShareVideoFrom, ret) => { + success && success.call(context, from, ret); + this.handleSuccess(from, ret); + } + }; + + if (isOveride) + // 覆盖：失败默认处理 + return { + ...params, + fail: (from: ShareVideoFrom, err) => { + fail && fail.call(context, from, err); + } + }; + else + // 不覆盖：失败默认处理 + return { + ...params, + fail: (from: ShareVideoFrom, err) => { + fail && fail.call(context, from, err); + this.handleError(from, err); + } + }; + } + + /** + * 成功默认处理：分享和视频统计 + * @param from 来源 + * @param ret? + */ + private static handleSuccess(from: ShareVideoFrom, ret: any | null) { + switch (from) { + case ShareVideoFrom.Share: // 同步分享 + case ShareVideoFrom.ShareAysnc: // 异步分享 + break; + + case ShareVideoFrom.Video: // 看视频 + break; + } + } + + /** + * 失败默认设置（可覆盖） + * @param from 来源 + * @param error: 失败消息对象 + */ + private static handleError(from: ShareVideoFrom, error: { code: number, msg: string } | null) { + if (!error) return; + // 开发者自定义处理 error msg + if (error.code) { + // wx.showToast({ + // title: error.msg + // }); + // ViewManager.I.showModal(ComTipFull, error.msg); + } + } +} + +// 分享视频类型（与后台一一对应） +export enum ShareVideoType { + None = -1, // -1无分享无视频 + Share = 0, // 0同步分享 + ShareAysnc = 1, // 1异步分享 + ShareIntegral = 5, // 5分享积分 + Video = 2, // 2看视频 + VideoToShare = 3, // 3无视频则分享 + VideoAndShare = 4, // 4视频和分享(控制分享和视频两个按钮的显示) ， +} + +// 分享或者视频来源 +export enum ShareVideoFrom { + None, // 无分享 + Share, // 同步分享 + ShareAysnc, // 异步分享 + Video // 看视频 +} + +// 分享视频keysKeys +export enum ShareVideoKeys { + Forward = 'forward', // 右上角三点转发 + CoinTip = 'coin_tip', // 金币不足弹出框 + DiamondDouble = 'diamond_double', // 钻石再来一份 + SuccessDouble = 'success_double', // 成功界面双倍 + LevelUpDiamond = 'levelup_diamond', // 升级活动钻石 + FailRewardDouble = 'fail_reward_double' // 失败获得双倍奖励 +} + +// 分享和视频错误 +export enum ShareVideoError { + VideoQuit = 1000, // { code: 1000, msg: '要看完视频哦!' }, + VideoFail = 1001, // { code: 1001, msg: '加载视频广告失败!' }, + VideoNotOpen = 1002, // { code: 1002, msg: '微信版本过低，暂不支持看视频!' }, + VideoPlaying = 1003, // { code: 1003, msg: '正在观看视频中...' }, + VideoInvalid = 999, // { code: 999, msg: '视频UID不存在!' }, + ShareFail = 1004, // { code: 1004, msg: '失败，发给其他好友试试！' }, + ShareSame = 1005, // { code: 1005, msg: '别总骚扰这个群，换个群分享吧!' }, + ShareNotGroup = 1006, // { code: 1006, msg: '请分享到群哦!' } + ShareAsyncNotGroup = 1007 // { code: 1007, msg: '分享到群才能领取更多~' } +} \ No newline at end of file -- libgit2 0.21.0