Skip to content

C
cdn
Commit ce27dcbb authored by 苏尧华's avatar 苏尧华
Browse files
Options

更新sdk文档

Signed-off-by: 's avatar苏尧华 <suyaohua@llewan.com>
parent 3f1a1ff6
Hide whitespace changes
Inline Side-by-side
Showing with 214 additions and 144 deletions
lewan-sdk-doc/index.html 0 → 100644
View file @ ce27dcbb
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>Loading...</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" />
<meta http-equiv="Pragma" content="no-cache" />
<meta http-equiv="Expires" content="0" />
<style type="text/css">
body {
width: 100%;
height: 100%;
margin: 0;
}
.container-fluid {
width: 60%;
height: 100%;
margin: 0 auto;
overflow: hidden;
}
.row {
margin: 3rem auto;
text-align: center;
}
</style>
</head>
<body>
<div class="container-fluid">
<div class="row"><a href="javascript:go(1)">乐玩sdk文档(微信或手Q小游戏平台)</a></div>
<div class="row"><a href="javascript:go(2)">乐玩sdk文档(头条小游戏平台)</a></div>
<div class="row"><a href="javascript:go(3)">乐玩sdk文档(百度小游戏平台)</a></div>
<div class="row"><a href="javascript:go(4)">乐玩sdk文档(oppo/vivo小游戏平台)</a></div>
<div class="row"><a href="javascript:go(5)">乐玩sdk文档(app)</a></div>
</div>
</div>
<script type="text/javascript">
function go(index) {
var randomNumber = parseInt(Math.random() * 10000);
switch (index) {
case 1:
window.location = './weixin/index.html?v=' + randomNumber;
break;
case 2:
// window.location = './weixin/index.html?v=' + randomNumber;
alert('待完善')
break;
case 3:
alert('待完善')
// window.location = './weixin/index.html?v=' + randomNumber;
break;
case 4:
alert('待完善')
// window.location = './weixin/index.html?v=' + randomNumber;
break;
case 5:
alert('待完善')
// window.location = './weixin/index.html?v=' + randomNumber;
break;
default:
window.location = './weixin/index.html?v=' + randomNumber;
}
}
</script>
</body>
</html>
lewan-sdk-doc/weixin/api_data.js
View file @ ce27dcbb
......@@ -3,13 +3,13 @@ define({ "api": [
"group": "A",
"name": "ABC",
"type": "sdk说明",
"url": "分组A中的方法都是游戏中基本必用的,分组B中的方法是常用的数据存储、获取和事件埋点上报,分组C的方法很少调用",
"url": "sdk说明",
"title": "ABC(sdk说明必看)",
"success": {
"examples": [
{
"title": "示例:",
"content": "//A",
"title": "说明:",
"content": "分组A中的方法都是游戏中基本必用的,分组B中的方法是常用的数据存储、获取和事件埋点上报,分组C的方法很少调用\n关于接入sdk\n第一步：让运营同事配置安全域名\n第二部：初始化sdk，也就是用户登录，应该在游戏加载的时候执行\nvar sdk.debug = true;//项目正式发布前需要修改为false\nsdk.WeChatLoginNoAuth((userData,configOk)=>{\n sdk.log(userData);//建议所有的console.log都使用sdk.log代替，只要把sdk.debug设为false,那所有的log都不会打印出来了\n if (configOk)var config1 = sdk.getConfig1();\n sdk.onShareAppMessage({type: 0,query: \"\",success:(res)=>{},cancel:(res)=>{},fail:(res)=>{},rewardFlag:'' });//注册微信右上角菜单分享\n})\n第三步：游戏加载完成并且sdk初始化完成，就可以使用sdk的所有接口了\n//关于接入阿拉丁统计，如需要启用阿拉丁统计，需要去ald-game-conf.js里配置app_key，app_key跟运营要",
"type": "json"
}
]
......@@ -40,7 +40,7 @@ define({ "api": [
"examples": [
{
"title": "示例：",
"content": "sdk.WeChatLoginNoAuth((userData)=>{\n console.log(userData);\n})",
"content": "sdk.WeChatLoginNoAuth((userData,configOk)=>{\n sdk.log(userData,configOk);\n})",
"type": "json"
}
],
......@@ -154,8 +154,8 @@ define({ "api": [
"group": "A",
"name": "feedbackButtonHide",
"type": "投诉意见按钮",
"url": "投诉意见按钮",
"title": "隐藏 feedbackButtonHide(投诉意见按钮)",
"url": "投诉意见按钮隐藏",
"title": "feedbackButtonHide(投诉意见按钮)",
"version": "0.0.0",
"filename": "llewan-weixin-sdk/sdk.js",
"groupTitle": "A"
......@@ -164,8 +164,8 @@ define({ "api": [
"group": "A",
"name": "feedbackButtonShow",
"type": "投诉意见按钮",
"url": "投诉意见按钮",
"title": "显示,该方法暂时仅支持cocos引擎 feedbackButtonShow(投诉意见按钮)",
"url": "投诉意见按钮显示,该方法暂时仅支持cocos引擎",
"title": "feedbackButtonShow(投诉意见按钮)",
"parameter": {
"fields": {
"Parameter": [
......@@ -201,8 +201,8 @@ define({ "api": [
"group": "A",
"name": "fitPlatform",
"type": "console",
"url": "判断对应平台的封装，调用平台api前，必须先调用此方法判断一下",
"title": "fitPlatform(运行平台环境)",
"url": "检测平台环境是否匹配，调用平台api前，必须先调用此方法判断一下",
"title": "fitPlatform(检测平台环境)",
"success": {
"examples": [
{
......@@ -486,7 +486,7 @@ define({ "api": [
"examples": [
{
"title": "示例:",
"content": "sdk.shareAppMessage({type: 1,query: \"\",success:xxx,cancel:xxx,fail:xxx,rewardFlag:'' });",
"content": "sdk.onShareAppMessage({type: 0,query: \"\",success:xxx,cancel:xxx,fail:xxx,rewardFlag:'' });",
"type": "json"
}
]
......@@ -664,6 +664,59 @@ define({ "api": [
"filename": "llewan-weixin-sdk/sdk.js",
"groupTitle": "A"
},
{
"group": "A",
"name": "shareOrVideo",
"type": "调用分享或视频",
"url": "调用分享或视频",
"title": "shareOrVideo(调用分享或视频)",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "object",
"optional": false,
"field": "obj",
"description": "<p>参数集合的对象</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "obj.buttonKey",
"description": "<p>按钮对应的key</p>"
},
{
"group": "Parameter",
"type": "callback",
"optional": true,
"field": "obj.onSuccess",
"description": "<p>成功回调</p>"
},
{
"group": "Parameter",
"type": "callback",
"optional": true,
"field": "obj.onFail",
"description": "<p>失败回调</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "示例:",
"content": "var onFail = function (type) {\n // type 的值可能为 share/video/none 分别对应 分享失败/视频失败/当天分享或视频奖励次数已用完\n if (type === 'share'){}\n}\nsdk.shareOrVideo({buttonKey:\"xxx\",onSuccess:xxx,onFail:onFail});",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "llewan-weixin-sdk/sdk.js",
"groupTitle": "A"
},
{
"group": "B",
"name": "formatTime",
......@@ -701,7 +754,7 @@ define({ "api": [
"examples": [
{
"title": "示例:",
"content": "var time = this.formatTime(new Date(),\"date\",\"\"); 20180920\nvar time = this.formatTime(new Date(),\"time\",\"\"); 20180920122324",
"content": "var time = sdk.formatTime(new Date(),\"date\",\"\"); 20180920\nvar time = sdk.formatTime(new Date(),\"time\",\"\"); 20180920122324",
"type": "json"
}
]
......@@ -785,7 +838,7 @@ define({ "api": [
"examples": [
{
"title": "示例：",
"content": "sdk.getFromServer(\"testKey\",\"TestData\",null,(d)=>{\n console.log(\"获取返回\",d.key3);\n });",
"content": "sdk.getFromServer(\"testKey\",\"TestData\",null,(d)=>{\n sdk.log(\"获取返回\",d.key3);\n });",
"type": "json"
}
],
......@@ -842,7 +895,7 @@ define({ "api": [
"examples": [
{
"title": "示例:",
"content": "sdk.getServerTime((d)=>{\n if(d.c==1){\n console.log(\"获取返回\",d.nowTime);\n }\n });",
"content": "sdk.getServerTime((d)=>{\n if(d.c==1){\n sdk.log(\"获取返回\",d.nowTime);\n }\n });",
"type": "json"
}
]
......@@ -1102,7 +1155,7 @@ define({ "api": [
"examples": [
{
"title": "示例:",
"content": "sdk.Get(\"https://xxx.xxx\", { user_id: user_id }, function (d) {\n console.log(d)\n});",
"content": "sdk.Get(\"https://xxx.xxx\", { user_id: user_id }, function (d) {\n sdk.log(d)\n});",
"type": "json"
}
]
......@@ -1148,7 +1201,7 @@ define({ "api": [
"examples": [
{
"title": "示例:",
"content": "sdk.Post(sdk.ip + sdk.common, { user_id: user_id }, function (d) {\n console.log(d)\n});",
"content": "sdk.Post(sdk.ip + sdk.common, { user_id: user_id }, function (d) {\n sdk.log(d)\n});",
"type": "json"
}
]
......@@ -1167,7 +1220,7 @@ define({ "api": [
"examples": [
{
"title": "示例:",
"content": "//.摄像机组件、回调\nsdk.Screenshot((d)=>{\n if(d){\n console.log(\"图片保存成功：\", d)\n }else{\n console.log(\"图片保存失败：\", d)\n }\n})",
"content": "//.摄像机组件、回调\nsdk.Screenshot((d)=>{\n if(d){\n sdk.log(\"图片保存成功：\", d)\n }else{\n sdk.log(\"图片保存失败：\", d)\n }\n})",
"type": "json"
}
]
......@@ -1791,57 +1844,5 @@ define({ "api": [
"version": "0.0.0",
"filename": "llewan-weixin-sdk/sdk.js",
"groupTitle": "C"
},
{
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "object",
"optional": false,
"field": "obj",
"description": "<p>参数集合的对象</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "obj.buttonKey",
"description": "<p>按钮对应的key</p>"
},
{
"group": "Parameter",
"type": "callback",
"optional": true,
"field": "obj.onSuccess",
"description": "<p>成功回调</p>"
},
{
"group": "Parameter",
"type": "callback",
"optional": true,
"field": "obj.onFail",
"description": "<p>失败回调</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "示例:",
"content": "var onFail = function (type) {\n // type 的值可能为 share/video/none 分别对应 分享失败/视频失败/当天分享或视频奖励次数已用完\n if (type === 'share'){}\n}\nsdk.shareOrVideo({buttonKey:\"xxx\",onSuccess:xxx,onFail:onFail});",
"type": "json"
}
]
},
"type": "",
"url": "",
"version": "0.0.0",
"filename": "llewan-weixin-sdk/sdk.js",
"group": "E__GitHub_com_lewan_sdk_llewan_weixin_sdk_assets_llewan_weixin_sdk_sdk_js",
"groupTitle": "E__GitHub_com_lewan_sdk_llewan_weixin_sdk_assets_llewan_weixin_sdk_sdk_js",
"name": ""
}
] });
lewan-sdk-doc/weixin/api_data.json
View file @ ce27dcbb
......@@ -3,13 +3,13 @@
"group": "A",
"name": "ABC",
"type": "sdk说明",
"url": "分组A中的方法都是游戏中基本必用的,分组B中的方法是常用的数据存储、获取和事件埋点上报,分组C的方法很少调用",
"url": "sdk说明",
"title": "ABC(sdk说明必看)",
"success": {
"examples": [
{
"title": "示例:",
"content": "//A",
"title": "说明:",
"content": "分组A中的方法都是游戏中基本必用的,分组B中的方法是常用的数据存储、获取和事件埋点上报,分组C的方法很少调用\n关于接入sdk\n第一步：让运营同事配置安全域名\n第二部：初始化sdk，也就是用户登录，应该在游戏加载的时候执行\nvar sdk.debug = true;//项目正式发布前需要修改为false\nsdk.WeChatLoginNoAuth((userData,configOk)=>{\n sdk.log(userData);//建议所有的console.log都使用sdk.log代替，只要把sdk.debug设为false,那所有的log都不会打印出来了\n if (configOk)var config1 = sdk.getConfig1();\n sdk.onShareAppMessage({type: 0,query: \"\",success:(res)=>{},cancel:(res)=>{},fail:(res)=>{},rewardFlag:'' });//注册微信右上角菜单分享\n})\n第三步：游戏加载完成并且sdk初始化完成，就可以使用sdk的所有接口了\n//关于接入阿拉丁统计，如需要启用阿拉丁统计，需要去ald-game-conf.js里配置app_key，app_key跟运营要",
"type": "json"
}
]
......@@ -40,7 +40,7 @@
"examples": [
{
"title": "示例：",
"content": "sdk.WeChatLoginNoAuth((userData)=>{\n console.log(userData);\n})",
"content": "sdk.WeChatLoginNoAuth((userData,configOk)=>{\n sdk.log(userData,configOk);\n})",
"type": "json"
}
],
......@@ -154,8 +154,8 @@
"group": "A",
"name": "feedbackButtonHide",
"type": "投诉意见按钮",
"url": "投诉意见按钮",
"title": "隐藏 feedbackButtonHide(投诉意见按钮)",
"url": "投诉意见按钮隐藏",
"title": "feedbackButtonHide(投诉意见按钮)",
"version": "0.0.0",
"filename": "llewan-weixin-sdk/sdk.js",
"groupTitle": "A"
......@@ -164,8 +164,8 @@
"group": "A",
"name": "feedbackButtonShow",
"type": "投诉意见按钮",
"url": "投诉意见按钮",
"title": "显示,该方法暂时仅支持cocos引擎 feedbackButtonShow(投诉意见按钮)",
"url": "投诉意见按钮显示,该方法暂时仅支持cocos引擎",
"title": "feedbackButtonShow(投诉意见按钮)",
"parameter": {
"fields": {
"Parameter": [
......@@ -201,8 +201,8 @@
"group": "A",
"name": "fitPlatform",
"type": "console",
"url": "判断对应平台的封装，调用平台api前，必须先调用此方法判断一下",
"title": "fitPlatform(运行平台环境)",
"url": "检测平台环境是否匹配，调用平台api前，必须先调用此方法判断一下",
"title": "fitPlatform(检测平台环境)",
"success": {
"examples": [
{
......@@ -486,7 +486,7 @@
"examples": [
{
"title": "示例:",
"content": "sdk.shareAppMessage({type: 1,query: \"\",success:xxx,cancel:xxx,fail:xxx,rewardFlag:'' });",
"content": "sdk.onShareAppMessage({type: 0,query: \"\",success:xxx,cancel:xxx,fail:xxx,rewardFlag:'' });",
"type": "json"
}
]
......@@ -664,6 +664,59 @@
"filename": "llewan-weixin-sdk/sdk.js",
"groupTitle": "A"
},
{
"group": "A",
"name": "shareOrVideo",
"type": "调用分享或视频",
"url": "调用分享或视频",
"title": "shareOrVideo(调用分享或视频)",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "object",
"optional": false,
"field": "obj",
"description": "<p>参数集合的对象</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "obj.buttonKey",
"description": "<p>按钮对应的key</p>"
},
{
"group": "Parameter",
"type": "callback",
"optional": true,
"field": "obj.onSuccess",
"description": "<p>成功回调</p>"
},
{
"group": "Parameter",
"type": "callback",
"optional": true,
"field": "obj.onFail",
"description": "<p>失败回调</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "示例:",
"content": "var onFail = function (type) {\n // type 的值可能为 share/video/none 分别对应 分享失败/视频失败/当天分享或视频奖励次数已用完\n if (type === 'share'){}\n}\nsdk.shareOrVideo({buttonKey:\"xxx\",onSuccess:xxx,onFail:onFail});",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "llewan-weixin-sdk/sdk.js",
"groupTitle": "A"
},
{
"group": "B",
"name": "formatTime",
......@@ -701,7 +754,7 @@
"examples": [
{
"title": "示例:",
"content": "var time = this.formatTime(new Date(),\"date\",\"\"); 20180920\nvar time = this.formatTime(new Date(),\"time\",\"\"); 20180920122324",
"content": "var time = sdk.formatTime(new Date(),\"date\",\"\"); 20180920\nvar time = sdk.formatTime(new Date(),\"time\",\"\"); 20180920122324",
"type": "json"
}
]
......@@ -785,7 +838,7 @@
"examples": [
{
"title": "示例：",
"content": "sdk.getFromServer(\"testKey\",\"TestData\",null,(d)=>{\n console.log(\"获取返回\",d.key3);\n });",
"content": "sdk.getFromServer(\"testKey\",\"TestData\",null,(d)=>{\n sdk.log(\"获取返回\",d.key3);\n });",
"type": "json"
}
],
......@@ -842,7 +895,7 @@
"examples": [
{
"title": "示例:",
"content": "sdk.getServerTime((d)=>{\n if(d.c==1){\n console.log(\"获取返回\",d.nowTime);\n }\n });",
"content": "sdk.getServerTime((d)=>{\n if(d.c==1){\n sdk.log(\"获取返回\",d.nowTime);\n }\n });",
"type": "json"
}
]
......@@ -1102,7 +1155,7 @@
"examples": [
{
"title": "示例:",
"content": "sdk.Get(\"https://xxx.xxx\", { user_id: user_id }, function (d) {\n console.log(d)\n});",
"content": "sdk.Get(\"https://xxx.xxx\", { user_id: user_id }, function (d) {\n sdk.log(d)\n});",
"type": "json"
}
]
......@@ -1148,7 +1201,7 @@
"examples": [
{
"title": "示例:",
"content": "sdk.Post(sdk.ip + sdk.common, { user_id: user_id }, function (d) {\n console.log(d)\n});",
"content": "sdk.Post(sdk.ip + sdk.common, { user_id: user_id }, function (d) {\n sdk.log(d)\n});",
"type": "json"
}
]
......@@ -1167,7 +1220,7 @@
"examples": [
{
"title": "示例:",
"content": "//.摄像机组件、回调\nsdk.Screenshot((d)=>{\n if(d){\n console.log(\"图片保存成功：\", d)\n }else{\n console.log(\"图片保存失败：\", d)\n }\n})",
"content": "//.摄像机组件、回调\nsdk.Screenshot((d)=>{\n if(d){\n sdk.log(\"图片保存成功：\", d)\n }else{\n sdk.log(\"图片保存失败：\", d)\n }\n})",
"type": "json"
}
]
......@@ -1791,57 +1844,5 @@
"version": "0.0.0",
"filename": "llewan-weixin-sdk/sdk.js",
"groupTitle": "C"
},
{
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "object",
"optional": false,
"field": "obj",
"description": "<p>参数集合的对象</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "obj.buttonKey",
"description": "<p>按钮对应的key</p>"
},
{
"group": "Parameter",
"type": "callback",
"optional": true,
"field": "obj.onSuccess",
"description": "<p>成功回调</p>"
},
{
"group": "Parameter",
"type": "callback",
"optional": true,
"field": "obj.onFail",
"description": "<p>失败回调</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "示例:",
"content": "var onFail = function (type) {\n // type 的值可能为 share/video/none 分别对应 分享失败/视频失败/当天分享或视频奖励次数已用完\n if (type === 'share'){}\n}\nsdk.shareOrVideo({buttonKey:\"xxx\",onSuccess:xxx,onFail:onFail});",
"type": "json"
}
]
},
"type": "",
"url": "",
"version": "0.0.0",
"filename": "llewan-weixin-sdk/sdk.js",
"group": "E__GitHub_com_lewan_sdk_llewan_weixin_sdk_assets_llewan_weixin_sdk_sdk_js",
"groupTitle": "E__GitHub_com_lewan_sdk_llewan_weixin_sdk_assets_llewan_weixin_sdk_sdk_js",
"name": ""
}
]
lewan-sdk-doc/weixin/api_project.js
View file @ ce27dcbb
define({
"name": "lewanSdk",
"version": "1.117.0",
"version": "0.0.0",
"description": "针对微信和qq平台的乐玩sdk接口文档",
"title": "乐玩Sdk-微信/QQ",
"url": "https://res.g.llewan.com/lewan-sdk-doc/weixin/index.html",
"url": "",
"sampleUrl": false,
"defaultVersion": "0.0.0",
"apidoc": "0.3.0",
"generator": {
"name": "apidoc",
"time": "2019-09-23T10:14:51.261Z",
"time": "2019-09-25T12:14:59.722Z",
"url": "http://apidocjs.com",
"version": "0.17.7"
}
......
lewan-sdk-doc/weixin/api_project.json
View file @ ce27dcbb
{
"name": "lewanSdk",
"version": "1.117.0",
"version": "0.0.0",
"description": "针对微信和qq平台的乐玩sdk接口文档",
"title": "乐玩Sdk-微信/QQ",
"url": "https://res.g.llewan.com/lewan-sdk-doc/weixin/index.html",
"url": "",
"sampleUrl": false,
"defaultVersion": "0.0.0",
"apidoc": "0.3.0",
"generator": {
"name": "apidoc",
"time": "2019-09-23T10:14:51.261Z",
"time": "2019-09-25T12:14:59.722Z",
"url": "http://apidocjs.com",
"version": "0.17.7"
}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment