appcan-docs-v2
所属分类:文章/文档
开发工具:JavaScript
文件大小:0KB
下载次数:0
上传日期:2020-11-10 02:28:41
上 传 者:
sh-1993
说明: 线上文档中心,
(Online Document Center,)
文件列表:
Constant.md (12624, 2020-08-11)
ErrorCode.md (5308, 2020-08-11)
JSDK寮鍙戞枃妗/ (0, 2020-08-11)
JSDK寮鍙戞枃妗/Button鎸夐挳.md (1129, 2020-08-11)
JSDK寮鍙戞枃妗/CheckBox鎸夐挳.md (473, 2020-08-11)
JSDK寮鍙戞枃妗/Demo/ (0, 2020-08-11)
JSDK寮鍙戞枃妗/Demo/unlimitedTreeView.zip (466263, 2020-08-11)
JSDK寮鍙戞枃妗/Dialog娑堟伅瀵硅瘽妗.md (684, 2020-08-11)
JSDK寮鍙戞枃妗/Header瀵艰埅鏍.md (1124, 2020-08-11)
JSDK寮鍙戞枃妗/InputTextarea鏂囨湰杈撳叆.md (2054, 2020-08-11)
JSDK寮鍙戞枃妗/Listview鍒楄〃缁勪欢.md (8102, 2020-08-11)
JSDK寮鍙戞枃妗/Radio鎸夐挳.md (485, 2020-08-11)
JSDK寮鍙戞枃妗/Select涓嬫媺閫夋嫨.md (1110, 2020-08-11)
JSDK寮鍙戞枃妗/Slider鍥剧墖杞鎾缁勪欢.md (5943, 2020-08-11)
JSDK寮鍙戞枃妗/Switch寮鍏崇粍浠.md (1294, 2020-08-11)
JSDK寮鍙戞枃妗/Tab閫夐」鍗$粍浠.md (2743, 2020-08-11)
JSDK寮鍙戞枃妗/Treeview鏍戠姸鍒楄〃缁勪欢.md (3323, 2020-08-11)
JSDK寮鍙戞枃妗/imgs/ (0, 2020-08-11)
JSDK寮鍙戞枃妗/imgs/add1.png (10783, 2020-08-11)
JSDK寮鍙戞枃妗/imgs/add2.png (10437, 2020-08-11)
JSDK寮鍙戞枃妗/imgs/all.png (2202, 2020-08-11)
JSDK寮鍙戞枃妗/imgs/liebiao1.png (2511, 2020-08-11)
JSDK寮鍙戞枃妗/imgs/liebiao2.jpg (21749, 2020-08-11)
JSDK寮鍙戞枃妗/imgs/set2.png (5404, 2020-08-11)
JSDK寮鍙戞枃妗/optionList甯︽搷浣滈夐」鐨勫垪琛ㄧ粍浠.md (3243, 2020-08-11)
JSDK寮鍙戞枃妗/widgetOne妯″潡.md (6807, 2020-08-11)
JSDK寮鍙戞枃妗/widget妯″潡.md (18750, 2020-08-11)
JSDK寮鍙戞枃妗/浜嬩欢妯″潡EventEmitter.md (3081, 2020-08-11)
JSDK寮鍙戞枃妗/鍩虹绫诲簱Base.md (5818, 2020-08-11)
JSDK寮鍙戞枃妗/鏁版嵁搴撴ā鍧桪atabase.md (6804, 2020-08-11)
JSDK寮鍙戞枃妗/鏂囦欢妯″潡File.md (20992, 2020-08-11)
JSDK寮鍙戞枃妗/鏇存柊鏃ュ織.md (13895, 2020-08-11)
JSDK寮鍙戞枃妗/鏈鍦板瓨鍌↙ocStorage.md (2380, 2020-08-11)
JSDK寮鍙戞枃妗/姒傝.md (2147, 2020-08-11)
JSDK寮鍙戞枃妗/娴鍔ㄧ獥鍙fā鍧桭rame.md (12228, 2020-08-11)
JSDK寮鍙戞枃妗/绂荤嚎缂撳瓨icache.md (2044, 2020-08-11)
JSDK寮鍙戞枃妗/绐楀彛妯″潡Window.md (43884, 2020-08-11)
JSDK寮鍙戞枃妗/缃戠粶璇锋眰Request.md (16228, 2020-08-11)
JSDK寮鍙戞枃妗/璁惧囨ā鍧桪evice.md (4368, 2020-08-11)
... ...
# AppCan 4.0 插件接口规范
## 版本升级
* 兼容3.0版本,插件新增方法遵循4.0开发规范
* 插件方法支持同步返回值
* 插件方法参数支持function作为入参(去掉插件的CB函数)
## 编写规范
- 多实例插件,初始化同步返回插件对象。不再使用外部传入ID管理。
- 插件方法参数入参为JSON对象,便于扩展。
- 插件方法参数入参为Function对象,格式为:function(error, data){}
- error值: 0表示成功, 非0表示错误。 (必选)
- data值:(可选)
- error 为0时,返回数据。
- error 为非0时,返回错误信息
- 插件方法返回值
- BOOL类型,true 或者 false
- 对象(字符串或者对象),null表示失败。
## 文档格式规范
### 简介 示例规范
1、编写文档请在引言说明处:须回车换一行(某些页面识别md语法较严格,显示排版时留意下即可)增加一用户提示,如下
**插件集成使用说明:**(已集成到平台[公共插件](https://github.com/dev-guide/platform-services/app-dev#-4-5-ignore-),直接勾选打包)
2、简介-->插件说明部分:须包含插件介绍、插件用途、使用场景、注意事项
3、简介-->UI展示部分:须提供插件效果图 提高对插件辨识度,进一步了解插件使用场景
4、简介-->可以增加其他层次标题,若暂无可忽略
### fun1 示例1
`uexDemo.fun1();`
**说明:**
无参数,无返回值,无回调函数的方法文档示例。
**参数:**
无
**示例:**
```javascript
uexDemo.fun1();
```
### fun2 示例2
`uexDemo.fun2(jsonData);`
**说明:**
有参数,无返回值,无回调函数的方法文档示例。
**参数:**
| 参数名称 | 参数类型 | 是否必选 | 说明 |
| -------- | ---- | ---- | -------- |
| jsonData | Json | 是 | 接口所需业务数据 |
```javascript
var jsonData = {
key1:,
key2:,
key3:,
key4:
}
```
各字段含义如下:
| 字段名称 | 类型 | 是否必选 | 说明 |
| ---- | ------- | ---- | ---- |
| key1 | Number | 是 | |
| key2 | String | 是 | |
| key3 | Boolean | 否 | |
| key4 | Array | 是 | |
**示例:**
```javascript
var jsonData = {
key1:1,
key2:"text",
key3:true,
key4:["item1","item2"]
}
uexDemo.fun2(jsonData);
```
### fun3 示例3
`uexDemo.fun3(jsonData,callBackFunction);`
**说明:**
有参数,有返回值,有回调函数的方法文档示例。
**参数:**
| 参数名称 | 参数类型 | 是否必选 | 说明 |
| ---------------- | -------- | ---- | -------- |
| jsonData | Json | 是 | 接口所需业务数据 |
| callBackFunction | Function | 是 | 回调函数 |
```javascript
var jsonData = {
key1:,
key2:,
key3:,
key4:
}
```
各字段含义如下:
| 字段名称 | 类型 | 是否必选 | 说明 |
| ---- | ------- | ---- | ---- |
| key1 | Number | 是 | |
| key2 | String | 是 | |
| key3 | Boolean | 否 | |
| key4 | Array | 是 | |
**回调参数:**
| 参数名称 | 参数类型 | 说明 |
| ----- | ------ | ------------ |
| error | Number | 0表示成功,非0表示失败 |
| data | String | 相关数据 |
**返回值:**
xxx对象,失败时返回null
**示例:**
```javascript
var jsonData = {
key1:1,
key2:"text",
key3:true,
key4:["item1","item2"]
}
var demoObject = uexDemo.fun3(jsonData,function(error,data){
if(!error){
alert("成功,数据为:" + data);
}else{
alert("失败,错误码为:" + error);
}
});
alert(demoObject);
```
### 更新历史 示例规范
**插件负责人:**请及时更新插件文档“更新日志”里的内容!
### iOS
API版本:`uexTencentLVB-3.0.0`
最近更新时间:`2016-11-4`
| 历史发布版本 | 更新内容 |
| ------ | ------ |
| 3.0.0 | 视频直播插件 |
### Android
API版本:`uexTencentLVB-3.0.0`
最近更新时间:`2016-11-4`
| 历史发布版本 | 更新内容 |
| ------ | --------- |
| 3.0.0 | 腾讯云视频直播插件 |
近期下载者:
相关文件:
收藏者: