cloudcc-cli 2.2.1 → 2.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -0
- package/bin/cc.js +1 -0
- package/bin/mcp.js +18 -0
- package/package.json +14 -6
- package/src/classes/create.js +1 -0
- package/src/classes/get.js +1 -0
- package/src/classes/publish.js +4 -0
- package/src/classes/pull.js +5 -1
- package/src/mcp/index.js +227 -0
- package/src/mcp/readme.md +132 -0
- package/src/mcp/tools/ccdk/fetcher.js +18 -0
- package/src/mcp/tools/ccdk/handler.js +98 -0
- package/src/mcp/tools/ccdk/prompt.js +453 -0
- package/src/mcp/tools/classes/handler.js +358 -0
- package/src/mcp/tools/classes/prompt.js +1261 -0
- package/src/mcp/tools/dev-env/fetcher.js +500 -0
- package/src/mcp/tools/dev-env/handler.js +92 -0
- package/src/mcp/tools/dev-env/prompt.js +256 -0
- package/src/mcp/tools/key-guide/fetcher.js +278 -0
- package/src/mcp/tools/key-guide/handler.js +43 -0
- package/src/mcp/tools/key-guide/prompt.js +71 -0
- package/src/mcp/tools/plugin/handler.js +92 -0
- package/src/mcp/tools/plugin/prompt.js +659 -0
- package/src/plugin/create.js +1 -2
- package/src/plugin/create1.js +1 -2
- package/src/plugin/publish.js +3 -0
- package/src/plugin/publish1.js +6 -2
- package/src/script/publish.js +3 -0
- package/src/script/pull.js +3 -0
- package/src/timer/publish.js +3 -0
- package/src/timer/pull.js +3 -0
- package/src/triggers/publish.js +3 -0
- package/src/triggers/pull.js +3 -0
- package/template/Appvue +452 -12
- package/template/cloudcc-cli.configjs +7 -1
- package/template/index.js +0 -4
- package/template/vueconfigjs +10 -10
- package/utils/checkVersion.js +2 -0
- package/utils/utils.js +32 -9
- package/template/demojava +0 -15
- package/template/indexvue +0 -29
- package/template/javaconfigjson +0 -3
- package/template/package-lockjson +0 -13952
|
@@ -0,0 +1,453 @@
|
|
|
1
|
+
// 自动生成的 CCDK API 树形结构
|
|
2
|
+
const ccdkApiTree = {
|
|
3
|
+
"CCApplication": {
|
|
4
|
+
"name": "应用",
|
|
5
|
+
"keyword": "",
|
|
6
|
+
"description": "访问应用信息",
|
|
7
|
+
"apis": {
|
|
8
|
+
"getApplicaton": {
|
|
9
|
+
"name": "getApplicaton",
|
|
10
|
+
"description": "获取当前访问的应用对象",
|
|
11
|
+
"content": "### getApplicaton():object\n\n\n\n#### 获取当前访问的应用对象 v0.2.1\n\njs\nlet app = $CCDK.CCApplication.getApplicaton()\n\n#### app返回题参数\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| id | 应用程序id | string | — | — |\n| name | 应用程序名称 | string | — | — |\n| navigationStyle | 控制台样式,'0'控制台样式,'1'标准样式 | string | — | — |",
|
|
12
|
+
"keyword": "获取当前访问的应用对象,getApplicaton,应用,CCApplication",
|
|
13
|
+
"version": "v0.2.1"
|
|
14
|
+
},
|
|
15
|
+
"setApplicaton": {
|
|
16
|
+
"name": "setApplicaton",
|
|
17
|
+
"description": "存储应用对象",
|
|
18
|
+
"content": "### setApplicaton(detail)\n\n\n\n#### 存储应用对象 v0.2.1\njs\nlet detail = {}\n$CCDK.CCApplication.setApplication(detail)\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| detail | 类型 | object | — | — |",
|
|
19
|
+
"keyword": "存储应用对象,setApplicaton,应用,CCApplication",
|
|
20
|
+
"version": "v0.2.1"
|
|
21
|
+
},
|
|
22
|
+
"open": {
|
|
23
|
+
"name": "open",
|
|
24
|
+
"description": "存储应用对象",
|
|
25
|
+
"content": "### open(appId)(开发中)\n\n\n\n#### 存储应用对象\njs\n$CCDK.CCApplication.open(appId)\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| appId | 应用唯一标识 | string | — | — |",
|
|
26
|
+
"keyword": "存储应用对象,open,应用,CCApplication",
|
|
27
|
+
"version": "开发中"
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
},
|
|
31
|
+
"CCBus": {
|
|
32
|
+
"name": "事件总线",
|
|
33
|
+
"keyword": "",
|
|
34
|
+
"description": "事件发布订阅管理工具",
|
|
35
|
+
"apis": {
|
|
36
|
+
"$emit": {
|
|
37
|
+
"name": "$emit",
|
|
38
|
+
"description": "发布信息",
|
|
39
|
+
"content": "### $emit(event, ...args)\n\n\n\n#### 发布信息 v0.0.1\njs\n$CCDK.CCBus.$emit('myevent')\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| event | 事件名称,唯一标识 | string | — | — |\n| args | 请求参数 | any | — | — |",
|
|
40
|
+
"keyword": "发布信息,$emit,事件总线,CCBus",
|
|
41
|
+
"version": "v0.0.1"
|
|
42
|
+
},
|
|
43
|
+
"$on": {
|
|
44
|
+
"name": "$on",
|
|
45
|
+
"description": "订阅事件",
|
|
46
|
+
"content": "### $on(event, callback)\n\n\n\n#### 订阅事件 v0.0.1\njs\n$CCDK.CCBus.$on('myevent',()=>{\n console.log('hello CloudCC')\n})\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| event | 事件名称,唯一标识 | string | — | — |\n| callback | 回调方法 | function | — | — |",
|
|
47
|
+
"keyword": "订阅事件,$on,事件总线,CCBus",
|
|
48
|
+
"version": "v0.0.1"
|
|
49
|
+
},
|
|
50
|
+
"$off": {
|
|
51
|
+
"name": "$off",
|
|
52
|
+
"description": "取消订阅",
|
|
53
|
+
"content": "### $off(event)\n\n\n\n#### 取消订阅 v0.0.1\njs\n$CCDK.CCBus.$off('myevent')\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| event | 事件名称,唯一标识 | string | — | — |",
|
|
54
|
+
"keyword": "取消订阅,$off,事件总线,CCBus",
|
|
55
|
+
"version": "v0.0.1"
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
},
|
|
59
|
+
"CCCall": {
|
|
60
|
+
"name": "拨打电话",
|
|
61
|
+
"keyword": "",
|
|
62
|
+
"description": "调用拨打电话功能",
|
|
63
|
+
"apis": {
|
|
64
|
+
"init": {
|
|
65
|
+
"name": "init",
|
|
66
|
+
"description": "初始化电话功能",
|
|
67
|
+
"content": "### init(id, callClient):object\n\n\n\n\n\n#### 初始化电话功能 v0.0.1\njs\nlet callClient = {\n // 点击平台手机号,右侧电话图标会,回调此方法\n call:(options)=>{\n // 获取要外呼的电话号码,进行业务处理\n let number = options.number\n }\n}\nlet client = $CCDK.CCCall.init(\"abc\",callClient)\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| id | 电话服务商唯一标识,从CloudCC后台设置获取:沟通渠道——》电话 | string | — | — |\n| callClient | 电话服务商对象,需要服务商手动初始化, | object | — | — |\n#### callClient\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| call | 必须实现的方法,用于平台和电话条通信 | function | — | — |",
|
|
68
|
+
"keyword": "初始化电话功能,init,拨打电话,CCCall",
|
|
69
|
+
"version": "v0.0.1"
|
|
70
|
+
},
|
|
71
|
+
"call": {
|
|
72
|
+
"name": "call",
|
|
73
|
+
"description": "平台通过此方法,与电话条通信,拨打电话",
|
|
74
|
+
"content": "### call(id, options):object\n\n\n\n\n\n#### 平台通过此方法,与电话条通信,拨打电话 v0.0.1\njs\nlet client = $CCDK.CCCall.call(id,options)\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| id | 电话服务商唯一标识,从CloudCC后台获取,不填写时,使用默认服务商 | string | — | '' |\n| options | 拨打电话的配置信息 | object | — | — |\n#### options\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| number | 电话号码 | string | — | — |",
|
|
75
|
+
"keyword": "平台通过此方法,与电话条通信,拨打电话,call,拨打电话,CCCall",
|
|
76
|
+
"version": "v0.0.1"
|
|
77
|
+
},
|
|
78
|
+
"openCallPanel": {
|
|
79
|
+
"name": "openCallPanel",
|
|
80
|
+
"description": "调用话务服务,打开电话面板",
|
|
81
|
+
"content": "### openCallPanel(id, options):object\n\n\n\n\n\n#### 调用话务服务,打开电话面板 v0.0.1\njs\nlet client = $CCDK.CCCall.openCallPanel(id,options)\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| id | 电话服务商唯一标识,从CloudCC后台获取,不填写时,试用默认服务商 | string | — | — |\n| options | 拨打电话的配置信息 | object | — | — |\n#### options\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| number | 电话号码 | string | — | — |",
|
|
82
|
+
"keyword": "调用话务服务,打开电话面板,openCallPanel,拨打电话,CCCall",
|
|
83
|
+
"version": "v0.0.1"
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
},
|
|
87
|
+
"CCCommon": {
|
|
88
|
+
"name": "自定义接口交互",
|
|
89
|
+
"keyword": "",
|
|
90
|
+
"description": "与自定义接口交互",
|
|
91
|
+
"apis": {
|
|
92
|
+
"post": {
|
|
93
|
+
"name": "post",
|
|
94
|
+
"description": "请求自定义类",
|
|
95
|
+
"content": "### post(className, methodName, params):object\n\n\n\n#### 请求自定义类 v0.6.9\njs\nlet className = \"test\"\nlet methodName = \"func1\"\nlet params = [\n {\n \"argType\": \"java.lang.String\",\n \"argValue\": \"hello\",\n },\n {\n \"argType\": \"java.lang.String\",\n \"argValue\": \"world\",\n }]\n$CCDK.CCCommon.post(className,methodName,params)\n.then((res)=>{let data = res.data;console.log(data)})\n.catch((error)=>{console.log(error)})\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| className | 类名 | string | — | — |\n| methodName | 方法名 | string | — | — |\n| params | 参数集合 | array | — | — |\n| config | 配置参数 | object | — | {} |",
|
|
96
|
+
"keyword": "请求自定义类,post,自定义接口交互,CCCommon",
|
|
97
|
+
"version": "v0.6.9"
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
},
|
|
101
|
+
"CCCrypto": {
|
|
102
|
+
"name": "加密",
|
|
103
|
+
"keyword": "",
|
|
104
|
+
"description": "对敏感数据进行加密",
|
|
105
|
+
"apis": {
|
|
106
|
+
"encrypt": {
|
|
107
|
+
"name": "encrypt",
|
|
108
|
+
"description": "加密数据",
|
|
109
|
+
"content": "### encrypt(data:object, key:string, iv:number)():string\n\n\n\n\n\n#### 加密数据 v0.0.1\njs\nlet encrypt = $CCDK.CCCrypto.encrypt({'name':'zhangsan'},\"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\",1)\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| data | 待加密的数据 | object | — | — |\n| key | 密钥 | string | — | AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA |\n| iv | 偏移量 | number | — | 1 |",
|
|
110
|
+
"keyword": "加密数据,encrypt,加密,CCCrypto",
|
|
111
|
+
"version": "v0.0.1"
|
|
112
|
+
},
|
|
113
|
+
"decrypt": {
|
|
114
|
+
"name": "decrypt",
|
|
115
|
+
"description": "解密数据",
|
|
116
|
+
"content": "### decrypt(data:string, key:string, iv:number):object\n\n\n\n\n\n#### 解密数据 v0.0.1\njs\nlet data = 'rgTxYdmUGNelPbfoChXe5eTQqNDPxTNv57V62x6Be9kXceAqcpq/uNeaZnH0EcexNKqep6u8v6YApDkv9K9J0YrhLRgKiEGT/N0RKqdpPZH7bwFP6x0zGV3iE3Rij/5Vc1YwcAMoboA7aTAq0skmQK7rdgD73JpEY9umN3pM13xHAvHjY5Mym8PpT+KIL7m6O3z+aDcKzATn7Y7jiQOMjJynGZhgvKjE0M1ztyGPkmDcEBU8NBeyCBrSiy+EsB2rxkQGmwihm/itcUsl7QE/bseSPz4v1GuWek110hUfCd6a0Le1AsrnbNdpZ84fcEAJFhQW1sekqolzUrh2e0ncgSqmggW75COSsxmdtArsifzn7P1jxgPBVoA8EXk+1HCHStI7iJms2AaiYV7c/KnTHV2l3jPRIawV+Z0C5zvlcsE/pP3TfJmTkQQHncqE2bmwiwxu4h/T/STNX01bu+1bFE3ooIFwsDRd2K6cAfmkmeDCa17DWJdJwS/uM2hYHPz3Mhsds0wbMW0jsniLOeqzV99E80hfXBKMkR3cVpLmXKM/moj5xxoFzIDgJi0DVgZXDnG6V5I5GwKLOjPF5h50KkzkJoOlqT5IJObdqtvfq2WFoLTWBaVwTjBgwai7HQ5w2DZ9b6MheiTMuvgC6lB/lGcG90chInaWa7rhym7l/b+6wts7eGFA07+WT86kNQMzhAMdinizXIwABK2T5ZkXoeooXlkQM8MEGK0Y25g+gXIX2icfviSrZ8MKJvtqyXZKhyHxjHfrQtpgcirylG+dvjE+Dw4Nem+wt5Pigc0HolkKHgIPVqnpUCyG2qIZD/8jihllHt9FV7scGczICLbQ71rHIw5L5nGLCW5uG2ylYB8hEA+F+bIxaqylIRdrsrTt/pI5Y3eE5qJ3F6e0Pls8Kb34iMT/ICG2gks6x7g2EuxsDe9L+Ixd2d6BF8XYiBN1wjXQ+nlsiSA+Vd5GYt5ROJGU5Ls6aGoOHQBaDd6EHTtKS9Vl2CpaUcGXU9bKQEqRPPr7oHH2JHqFGSPL68FrRjDK6MkcR/BqfwsmWkHcW6qyRPVlW7rtqu3AhSe17PSS+uKqtkqgvc1dAjythYC1lRW5Rlbgz93qjtC/9yoarBCJusaIDFjefRgiGKxvixkkar07Zpw4untdhp0ToU60SD3wGnmA1VaOBGM3NRGtb06l0PO049gACVsXLqn8IrKL+eWgYGobwOgXyBGyDyobwLL6NkYrC63aLLoPZN08yozgPS/Zw4kTFtTac1/RmFCf1JyxcKClB3fS2Pc7TOCRkPIXcys1oeYDTb280iIbV2eeaRxaQTW/3yHNOJWiQC+G2uQkIgnQ45tDfj60c6hPOJjwNdmb1yXYEUoN/xBbDxBxAUTzclp54kZZJjdk8SapIWaNrloSHtlG7LoDXUK3QgKgQL2vfvl9X5FPA31MOGxD8LIhq2XYzJLtBoy5W09QAwlNvKRzA1gJRsLcXLQFozwm0Tjz0FGZvBqpeQJ1k8zzIhXmsbUNn0sRXuFY/+F2XMrJCOlVl3Oz0E+Pl032t1omRtdH0AOvv3DNbv5Tb5R4QoGs0Bm5cJREAlurvp0G9mYvRiUMngGvwQn5IW4Jyx7ok6AQCyKgxDB1AIYKbcsVyQvWnbFC2aPFIEOwo5O8iyX3xeaV89YPlIj5Tuw3RvgHT77+ahKVMghUi65N8XmQ242g0Pm9a21ob7gpDlQG'\nlet result = $CCDK.CCCrypto.decrypt(data)\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| data | 待解密的数据 | object | — | — |\n| key | 密钥 | string | — | AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA |\n| iv | 偏移量 | number | — | 1 |",
|
|
117
|
+
"keyword": "解密数据,decrypt,加密,CCCrypto",
|
|
118
|
+
"version": "v0.0.1"
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
},
|
|
122
|
+
"CCDetail": {
|
|
123
|
+
"name": "对象详情",
|
|
124
|
+
"keyword": "",
|
|
125
|
+
"description": "对象详情页的一些操作",
|
|
126
|
+
"apis": {
|
|
127
|
+
"getDetail": {
|
|
128
|
+
"name": "getDetail",
|
|
129
|
+
"description": "在详情页,获取当前访问的对象的详细信息",
|
|
130
|
+
"content": "### getDetail(apiname,detailId):object\n\n\n\n\n\n#### 在详情页,获取当前访问的对象的详细信息 v0.9.8\n在非详情页下,如果不指定详情页id,会返回最后一次打开的详情页数据\njs\n// 在当前查看的详情页中,获取指定字段内容\nlet objectDetail = $CCDK.CCDetail.getDetail()\n\n// 在当前查看的详情页中,通过指定字段apiname,获取指定字段内容\nlet objectDetail = $CCDK.CCDetail.getDetail('name')\n\n// 指定详情页获取详细信息\nconst detailId = '00820231CFCBA29H8YmN'\nlet objectDetail = $CCDK.CCDetail.getDetail(null,detailId)\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| apiname | 查找字段的apiname,如果传字段apiname将返回指定字段信息,不传该参数默认返回全部字段信息和当前记录id | string | — | — |\n| detailId | 指定获取已经打开的详情页数据 | string | — | — |",
|
|
131
|
+
"keyword": "在详情页,获取当前访问的对象的详细信息,getDetail,对象详情,CCDetail",
|
|
132
|
+
"version": "v0.9.8"
|
|
133
|
+
},
|
|
134
|
+
"setDetail": {
|
|
135
|
+
"name": "setDetail",
|
|
136
|
+
"description": "设置对象详细信息",
|
|
137
|
+
"content": "### setDetail(detail)\n\n\n\n\n\n#### 设置对象详细信息 v0.9.8\njs\n$CCDK.CCDetail.setDetail(detail)\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| detail | 类型 | object | — | — |\n\n##### detail\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| id | 详情记录id | string | — | — |\n| detail | 记录详细信息 | Array | — | — |",
|
|
138
|
+
"keyword": "设置对象详细信息,setDetail,对象详情,CCDetail",
|
|
139
|
+
"version": "v0.9.8"
|
|
140
|
+
},
|
|
141
|
+
"setDetailId": {
|
|
142
|
+
"name": "setDetailId",
|
|
143
|
+
"description": "设置详情页ID",
|
|
144
|
+
"content": "### setDetailId(id)\n\n\n\n\n\n#### 设置详情页ID v0.9.8\njs\n$CCDK.CCDetail.setDetailId(id)\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| id | 类型 | string | — | — |",
|
|
145
|
+
"keyword": "设置详情页ID,setDetailId,对象详情,CCDetail",
|
|
146
|
+
"version": "v0.9.8"
|
|
147
|
+
},
|
|
148
|
+
"getDetailId": {
|
|
149
|
+
"name": "getDetailId",
|
|
150
|
+
"description": "获取详情页ID,获得是最新的",
|
|
151
|
+
"content": "### getDetailId()\n\n\n\n\n\n#### 获取详情页ID,获得是最新的 v0.9.8\njs\nlet detailId = $CCDK.CCDetail.getDetailId()\n\n| 返回值 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| 最后一次访问的标准详情页id | 类型 | string | — | — |",
|
|
152
|
+
"keyword": "获取详情页ID,获得是最新的,getDetailId,对象详情,CCDetail",
|
|
153
|
+
"version": "v0.9.8"
|
|
154
|
+
},
|
|
155
|
+
"refreshRelatedList": {
|
|
156
|
+
"name": "refreshRelatedList",
|
|
157
|
+
"description": "刷新详情页相关列表",
|
|
158
|
+
"content": "### refreshRelatedList(ids)\n\n\n\n\n\n#### 刷新详情页相关列表 v0.9.8\njs\nlet ids = \"asdf234,234asdf\"\n$CCDK.CCDetail.refreshRelatedList(ids)\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| ids | 相关列表的id集合,传空刷新全部列表,刷新多个使用逗号分隔,查询方法:https://cloudccone.feishu.cn/wiki/DVYGwgpj3iLFjmkvmA9c3Y0ynSc| string | — | — |",
|
|
159
|
+
"keyword": "刷新详情页相关列表,refreshRelatedList,对象详情,CCDetail",
|
|
160
|
+
"version": "v0.9.8"
|
|
161
|
+
},
|
|
162
|
+
"getRelatedSelected": {
|
|
163
|
+
"name": "getRelatedSelected",
|
|
164
|
+
"description": "获取相关列表选中的数据id",
|
|
165
|
+
"content": "### getRelatedSelected(recordId,detailId)\n\n\n\n\n\n#### 获取相关列表选中的数据id v0.9.30\n\nccdk相关列表id清空时机:\n\n1. 沉浸式详情页相关列表:tab切换、分页或者刷新列表数据时清空\n\n2. 相关列表查看更多:关闭相关列表或者数据刷新时清空\n\njs\n$CCDK.CCDetail.getRelatedSelected(recordId,detailId)\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| recordId | 相关列表id,获取详情页中指定相关列表的选中数据,返回值类型为数组,不传时,默认获取详情页所有相关列表的选中数据,返回值类型为对象,key为相关列表id,值为选中数据数组| string | — | — |\n| detailId | 详情页id,获取指定详情页的相关列表选中数据,不传时,默认获取当前详情页的相关列表选中数据。\n\n若未找到,默认返回null,使用需判断返回值是否存在| string | — | — |",
|
|
166
|
+
"keyword": "获取相关列表选中的数据id,getRelatedSelected,对象详情,CCDetail",
|
|
167
|
+
"version": "v0.9.30"
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
},
|
|
171
|
+
"CCList": {
|
|
172
|
+
"name": "对象列表",
|
|
173
|
+
"keyword": "",
|
|
174
|
+
"description": "对象列表页一些操作",
|
|
175
|
+
"apis": {
|
|
176
|
+
"getSelected": {
|
|
177
|
+
"name": "getSelected",
|
|
178
|
+
"description": "在列表视图页,获取当前选中的数据id集合",
|
|
179
|
+
"content": "### getSelected()\n\n\n\n\n\n#### 在列表视图页,获取当前选中的数据id集合 v0.9.8\njs\nlet ids = $CCDK.CCList.getSelected()\n\n| 返回值 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| ids | 返回值中的ids属性表示选中的id集合:{ids:[]} | object | — | — |",
|
|
180
|
+
"keyword": "在列表视图页,获取当前选中的数据id集合,getSelected,对象列表,CCList",
|
|
181
|
+
"version": "v0.9.8"
|
|
182
|
+
},
|
|
183
|
+
"getViewId": {
|
|
184
|
+
"name": "getViewId",
|
|
185
|
+
"description": "在列表视图页,获取当前选中视图id",
|
|
186
|
+
"content": "### getViewId()\n\n\n\n\n\n#### 在列表视图页,获取当前选中视图id v0.9.22\njs\nlet viewId = $CCDK.CCList.getViewId()\n\n| 返回值 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| viewId | 返回值为当前选中视图id | string | — | — |",
|
|
187
|
+
"keyword": "在列表视图页,获取当前选中视图id,getViewId,对象列表,CCList",
|
|
188
|
+
"version": "v0.9.22"
|
|
189
|
+
},
|
|
190
|
+
"getViewInfo": {
|
|
191
|
+
"name": "getViewInfo",
|
|
192
|
+
"description": "在列表视图页,获取当前视图信息",
|
|
193
|
+
"content": "### getViewInfo()\n\n\n\n\n\n#### 在列表视图页,获取当前视图信息 v0.9.22\njs\nlet viewInfo = $CCDK.CCList.getViewInfo()\n\n| 返回值 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| ids | 表示选中的id集合 | string | — | — |\n| viewId | 表示当前选中的视图id | string | — | — |\n| prefix | 表示当前对象的prefix | string | — | — |\n| objid | 表示当前对象的objid | string | — | — |\n| objectApi | 表示当前对象的objectApi | string | — | — |",
|
|
194
|
+
"keyword": "在列表视图页,获取当前视图信息,getViewInfo,对象列表,CCList",
|
|
195
|
+
"version": "v0.9.22"
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
},
|
|
199
|
+
"CCLoad": {
|
|
200
|
+
"name": "下载JS",
|
|
201
|
+
"keyword": "",
|
|
202
|
+
"description": "用于下载远程JS功能",
|
|
203
|
+
"apis": {
|
|
204
|
+
"loadJs": {
|
|
205
|
+
"name": "loadJs",
|
|
206
|
+
"description": "使用js方法加载远程js",
|
|
207
|
+
"content": "### loadJs(src):Promise\n\n\n\n\n\n#### 使用js方法加载远程js v0.4.3\njs\nlet p = $CCDK.CCLoad.loadJs(\n \"http://shining-bucket01.oss-cn-hangzhou.aliyuncs.com/staticResource/org08f84e9c0566eaf0c/202212/16708233902069649.js?Expires=4824423390&OSSAccessKeyId=LTAI5tN2tp8bwdNMQk4HL63H&Signature=LbVWqugBF4ldtWZumJD6AEf6yHc%3D\"\n );\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| src | js远程地址 | string | — | — |",
|
|
208
|
+
"keyword": "使用js方法加载远程js,loadJs,下载JS,CCLoad",
|
|
209
|
+
"version": "v0.4.3"
|
|
210
|
+
},
|
|
211
|
+
"createLoadJsComponent": {
|
|
212
|
+
"name": "createLoadJsComponent",
|
|
213
|
+
"description": "创建js加载组件",
|
|
214
|
+
"content": "### createLoadJsComponent()\n\n\n\n\n\n#### 创建js加载组件 v0.4.3\njs\n// 第一步:引入对象,调用方法\n$CCDK.CCLoad.createLoadJsComponent();\n// 第二步:使用引入脚本标签\n<cc-load-script src=\"js上线地址\"></cc-load-script>\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| src | js远程地址 | string | — | — |",
|
|
215
|
+
"keyword": "创建js加载组件,createLoadJsComponent,下载JS,CCLoad",
|
|
216
|
+
"version": "v0.4.3"
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
},
|
|
220
|
+
"CCLog": {
|
|
221
|
+
"name": "日志上报工具",
|
|
222
|
+
"keyword": "",
|
|
223
|
+
"description": "通过此工具可以上报info和error信息到开发者平台,进而了解组件的运行状态",
|
|
224
|
+
"apis": {
|
|
225
|
+
"function": {
|
|
226
|
+
"name": "function",
|
|
227
|
+
"description": "上报网络异常请求信息",
|
|
228
|
+
"content": "### function reportErrorLog(logInfo,response)\n\n\n\n\n\n#### 上报网络异常请求信息 v0.6.0\njs\n let logInfo = {\n \"serviceName\": \"my app\",\n \"errorMessage\":\"描述信息\",\n \"printStackTraceInfo\":\"printStackTraceInfo描述信息\"\n }\n window.$CCDK.CCLog.reportErrorLog(logInfo)\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| logInfo | 日志描写 | object | — | {} | —\n#### logInfo\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| serviceName | 服务名称 | string | — | 项目名称 |\n| errorMessage | 日志描述信息 | string | — | \"\" |\n| printStackTraceInfo | 堆栈信息 | string | — | \"\" |\n| requestUrl | 请求地址 | string | — | \"\" |\n| remark | 备注信息 | string | — | \"\" |",
|
|
229
|
+
"keyword": "上报网络异常请求信息,function,日志上报工具,CCLog",
|
|
230
|
+
"version": "v0.6.0"
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
},
|
|
234
|
+
"CCMenu": {
|
|
235
|
+
"name": "菜单(内部使用)",
|
|
236
|
+
"keyword": "",
|
|
237
|
+
"description": "服务工作台菜单管理",
|
|
238
|
+
"apis": {
|
|
239
|
+
"function": {
|
|
240
|
+
"name": "function",
|
|
241
|
+
"description": "刷新二级菜单",
|
|
242
|
+
"content": "### function refreshMenu2(options)(开发中)\n#### 刷新二级菜单 v0.2.1\njs\nlet options = {id:'asdfasdf'}\n$CCDK.CCMenu.refreshMenu2(options)\n\n#### options\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| id | 菜单的唯一标识,不填时将刷新当前二级菜单 | string | — | — |",
|
|
243
|
+
"keyword": "刷新二级菜单,function,菜单(内部使用),CCMenu",
|
|
244
|
+
"version": "开发中"
|
|
245
|
+
}
|
|
246
|
+
}
|
|
247
|
+
},
|
|
248
|
+
"CCMessage": {
|
|
249
|
+
"name": "消息提示",
|
|
250
|
+
"keyword": "",
|
|
251
|
+
"description": "消息提示工具",
|
|
252
|
+
"apis": {
|
|
253
|
+
"showMessage": {
|
|
254
|
+
"name": "showMessage",
|
|
255
|
+
"description": "消息提示框",
|
|
256
|
+
"content": "### showMessage(text, type, duration,showClose, center)\n\n\n\n\n\n#### 消息提示框 v0.0.1\njs\n$CCDK.CCMessage.showMessage('Hello CloudCC')\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| text | 提示消息 | string | — | — |\n| type | 消息类型 | string | success/warning/info/error | info |\n| duration | 显示时间, 毫秒。设为 0 则不会自动关闭 | number | — | 3000 |\n| showClose | 是否显示关闭按钮 | boolean | — | false |\n| center | 文字是否居中 | boolean | — | false |",
|
|
257
|
+
"keyword": "消息提示框,showMessage,消息提示,CCMessage",
|
|
258
|
+
"version": "v0.0.1"
|
|
259
|
+
},
|
|
260
|
+
"showConfirm": {
|
|
261
|
+
"name": "showConfirm",
|
|
262
|
+
"description": "消息确认框",
|
|
263
|
+
"content": "### showConfirm(text, title, options, confirm, reject)\n\n\n\n\n\n#### 消息确认框 v0.0.1\njs\n$CCDK.CCMessage.showConfirm('Hello CloudCC','MyConfirm',{},()=>{alert(\"a\")},()=>{alert(\"b\")})\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| text | MessageBox 消息正文内容 | string / VNode | — | — |\n| title | MessageBox 标题 | string | — | — |\n| options | 其他配置参数 | options | — | — |\n| confirm | 确认回调方法 | function | — | — |\n| reject | 取消回调方法 | function | — | — |\n#### options\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| type | 消息类型,用于显示图标 | string | success / info / warning / error | — |\n| showClose | MessageBox 是否显示右上角关闭按钮 | boolean | — | true |\n| lockScroll | 是否在 MessageBox 出现时将 body 滚动锁定 | boolean | — | true |\n| showCancelButton | 是否显示取消按钮 | boolean | — | false(以 confirm 和 prompt 方式调用时为 true) |\n| showConfirmButton | 是否显示确定按钮 | boolean | — | true |\n| cancelButtonText | 取消按钮的文本内容 | string | — | 取消 |\n| confirmButtonText | 确定按钮的文本内容 | string | — | 确定 |\n| closeOnClickModal | 是否可通过点击遮罩关闭 MessageBox | boolean | — | true(以 alert 方式调用时为 false) |\n| center | 是否居中布局 | boolean | — | false |\n| roundButton | 是否使用圆角按钮 | boolean | — | false |",
|
|
264
|
+
"keyword": "消息确认框,showConfirm,消息提示,CCMessage",
|
|
265
|
+
"version": "v0.0.1"
|
|
266
|
+
},
|
|
267
|
+
"showNotification": {
|
|
268
|
+
"name": "showNotification",
|
|
269
|
+
"description": "消息提示框",
|
|
270
|
+
"content": "### showNotification(options)\n\n\n\n\n\n#### 消息提示框 v0.0.1\njs\n$CCDK.CCMessage.showNotification({\n title: '提示',\n message: '这是一条不会自动关闭的消息',\n duration: 0\n })\n\n#### options\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| title | 标题 | string | — | — |\n| message | 说明文字 | string/Vue.VNode | — | — |\n| dangerouslyUseHTMLString | 是否将 message 属性作为 HTML 片段处理 | boolean | — | false |\n| type | 主题样式,如果不在可选值内将被忽略 | string | success/warning/info/error | — |\n| iconClass | 自定义图标的类名。若设置了 type,则 iconClass 会被覆盖 | string | — | — |\n| customClass | 自定义类名 | string | — | — |\n| duration | 显示时间, 毫秒。设为 0 则不会自动关闭 | number | — | 4500 |\n| position | 自定义弹出位置 | string | top-right/top-left/bottom-right/bottom-left | top-right |\n| showClose | 是否显示关闭按钮 | boolean | — | true |\n| onClose | 关闭时的回调函数 | function | — | — |\n| onClick | 点击 Notification 时的回调函数 | function | — | — |\n| offset | 偏移的距离,在同一时刻,所有的 Notification 实例应当具有一个相同的偏移量 | number | — | 0 |",
|
|
271
|
+
"keyword": "消息提示框,showNotification,消息提示,CCMessage",
|
|
272
|
+
"version": "v0.0.1"
|
|
273
|
+
}
|
|
274
|
+
}
|
|
275
|
+
},
|
|
276
|
+
"CCPage": {
|
|
277
|
+
"name": "页面",
|
|
278
|
+
"keyword": "",
|
|
279
|
+
"description": "通过此api可以对标准新建页/标准编辑页/标准视图页/标准详情页/自定义页面,进行打开,关闭,刷新操作。",
|
|
280
|
+
"apis": {
|
|
281
|
+
"openListPage": {
|
|
282
|
+
"name": "openListPage",
|
|
283
|
+
"description": "打开标准视图页,并返回打开页面的唯一标识,可以用于关闭和刷新使用。",
|
|
284
|
+
"content": "### openListPage(obj:object):string\n\n\n\n\n\n#### 打开标准视图页,并返回打开页面的唯一标识,可以用于关闭和刷新使用。v1.0.0\njs\nlet pageId = $CCDK.CCPage.openListPage\n (\n {\n menuId:'aaa-223',\n prefix:'001',\n viewId:'ace1111',\n layoutType:'list'\n }\n )\n\n#### obj\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| menuId | 菜单id | string | — | — |\n| prefix | 对象前缀 | string | — | — |\n| viewId | 视图id | string | — | — |\n| layoutType | 布局类型 | string | list/Kanban/splitscreen | list |",
|
|
285
|
+
"keyword": "打开标准视图页,并返回打开页面的唯一标识,可以用于关闭和刷新使用。,openListPage,页面,CCPage",
|
|
286
|
+
"version": "v1.0.0"
|
|
287
|
+
},
|
|
288
|
+
"openDetailPage": {
|
|
289
|
+
"name": "openDetailPage",
|
|
290
|
+
"description": "打开标准详情页,并返回打开页面的唯一标识,可以用于关闭和刷新使用。",
|
|
291
|
+
"content": "### openDetailPage(obj:object, id:string, options:object):string\n\n\n\n\n\n#### 打开标准详情页,并返回打开页面的唯一标识,可以用于关闭和刷新使用。v1.0.0\njs\nlet pageId = $CCDK.CCPage.openDetailPage\n (\n {\n oprateType:'DETAIL',\n objectName:'客户',\n objId:'account',\n objectApi:'Account',\n prefix:'001',\n },\n '00120227805836AlIEL4',\n {\n openPlace:'menu2',\n openMode:'_self'\n }\n )\n\n#### obj\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| oprateType | 页面类型(DETAIL) | string | — | — |\n| recordId | 记录类型id | string | — | — |\n| objId | 对象id | string | — | — |\n| objectApi | 唯一表示 | string | — | — |\n| prefix | 对象前缀 | string | — | — |\n| objectName | 对象名称 | string | — | — |\n\n#### id\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| id | 记录id | string | — | — |\n\n#### options\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| pageId | 页面id,如果id相同,那么不会创建新页面,而是打开同一个页面 | string | 默认不填写 | -- |\n| openPlace | 打开位置 | string | tab/menu1/menu2 | menu1 |\n| openMode | 打开方式 | string | _self/_blank | _self |\n| menu1PageId | 一级菜单id,会在此一级菜单中生成二级菜单(现支持openDetailPage以blank方式打开二级菜单) | string | 默认不填写 | -- |\n| isShowMenu | 是否显示菜单 | boolean | 当openPlace是menu1/menu2不传默认true; 是tab不传默认false | -- |\n| isShowTitleBox | 是否展示头部区域 | boolean | true/false | true |\n| isShowRoi | 是否展示ROI | boolean | true/false | true |\n| isShowKeyInfo | 是否展示关键信息 | boolean | true/false | true |\n| isShowProcess | 是否展示进程 | boolean | true/false | true |\n| isShowRelationList | 是否展示相关列表 | boolean | true/false | true |\n| isShowDetail | 是否展示详细信息 | boolean | true/false | true |\n| isShowRelationDetail | 是否展示相关列表详情 | boolean | true/false | true |\n| isShowActivity | 是否展示活动(不展示活动时,切换布局按钮也会一并隐藏) | boolean | true/false | true |",
|
|
292
|
+
"keyword": "打开标准详情页,并返回打开页面的唯一标识,可以用于关闭和刷新使用。,openDetailPage,页面,CCPage",
|
|
293
|
+
"version": "v1.0.0"
|
|
294
|
+
},
|
|
295
|
+
"openCreatePage": {
|
|
296
|
+
"name": "openCreatePage",
|
|
297
|
+
"description": "打开标准新建页,并返回打开页面的唯一标识,可以用于关闭和刷新使用。",
|
|
298
|
+
"content": "### openCreatePage(obj:object, options:object):string\n\n\n\n\n\n#### 打开标准新建页,并返回打开页面的唯一标识,可以用于关闭和刷新使用。v0.2.1\n以下为apiname为khmc的查找字段和apiname为khdh的文本字段设置默认值\njs\nlet pageId = $CCDK.CCPage.openCreatePage\n (\n {\n objectName:'客户',\n objId:'account',\n objectApi:'Account',\n prefix:'001',\n defalutData:\n [\n {\n // 字段唯一标识:值\n khmc:'0013423dsdsds',\n data: [{id: '0013423dsdsds', value: '客户名称'}]\n },\n {\n khdh: '15383943854'\n }\n ]\n },\n {\n openPlace:'dialog',\n openMode:'_blank'\n }\n )\n\n#### obj\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| recordId | 记录类型id,指定记录类型编辑 | string | — | — |\n| objId | 对象id | string | — | — |\n| objectApi | 唯一表示 | string | — | — |\n| prefix | 对象前缀 | string | — | — |\n| objectName | 对象名称,新建弹窗标题 | string | — | — |\n| defalutData | 初始化的数据,数据字段(apiname)必须保持与该对象下的字段(apiname)一致,否则无法回显 | array | — | — |\n| creaeteDataId | 请保证creaeteDataId的唯一性,新建页面的唯一标识,保存后会通过$Bus.$emit调用 save(dataId) 回调函数,可以用于处理保存后的逻辑,参数是接口返回的数据| string | — | — |\n\n#### defalutData\n该对象支持所有getDetail接口返回的字段属性,除apiname:value外,其他都非必填\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| apiname:value | 字段apiname以及对应的值 | string | — | — |\n| fieldType | 字段类型 | string | — | — |\n| data | 查找、主详字段用于回显value的下拉列表,查找、主详字段回显时必填(例子:[{id: \"0012022813A22F1p7OhJ\", value: \"cascascf\"}]) | Array | — | — |\n| label | 查找和主详字段需要显示的label | string | — | — |\n| expressionType | 公式字段返回值类型 | string | — | — |\n\n#### options\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| pageId | 页面id,如果id相同,那么不会创建新页面,而是打开同一个页面 | string | 默认不填写 | -- |\n| openPlace | 打开位置 | string | dialog/tab/floatDialog/menu1/menu2 | dialog |\n| openMode | 打开方式(仅支持新打开弹窗) | string | _self/_blank | _blank",
|
|
299
|
+
"keyword": "打开标准新建页,并返回打开页面的唯一标识,可以用于关闭和刷新使用。,openCreatePage,页面,CCPage",
|
|
300
|
+
"version": "v0.2.1"
|
|
301
|
+
},
|
|
302
|
+
"openEditPage": {
|
|
303
|
+
"name": "openEditPage",
|
|
304
|
+
"description": "打开标准编辑页,并返回打开页面的唯一标识,可以用于关闭和刷新使用。",
|
|
305
|
+
"content": "### openEditPage(obj:object,id:string,options:object):string\n\n\n\n#### 打开标准编辑页,并返回打开页面的唯一标识,可以用于关闭和刷新使用。 v0.2.1\njs\nlet pageId = $CCDK.CCPage.openEditPage\n (\n {\n objectName:'客户',\n objId:'account',\n objectApi:'Account',\n prefix:'001',\n defalutData:\n [\n {\n // 字段唯一标识:值\n khmc:'0013423dsdsds',\n data: [{id: '0013423dsdsds', value: '客户名称'}]\n },\n {\n khdh: '15383943854'\n }\n ]\n },\n '00120227805836AlIEL4',\n {\n openPlace:'dialog',\n openMode:'_blank'\n }\n )\n\n\n#### obj\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| recordId | 记录类型id,指定记录类型编辑 | string | — | — |\n| objId | 对象id | string | — | — |\n| objectApi | 唯一表示 | string | — | — |\n| prefix | 对象前缀 | string | — | — |\n| objectName | 对象名称,新建弹窗标题 | string | — | — |\n| defalutData | 初始化的数据,数据字段(apiname)必须保持与该对象下的字段(apiname)一致,否则无法回显 | array | — | — |\n\n#### defalutData\n该对象支持所有getDetail接口返回的字段属性,除apiname:value外,其他都非必填\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| apiname:value | 字段apiname以及对应的值 | string | — | — |\n| fieldType | 字段类型 | string | — | — |\n| data | 查找、主详字段用于回显value的下拉列表,查找、主详字段回显时必填(例子:[{id: \"0012022813A22F1p7OhJ\", value: \"cascascf\"}]) | Array | — | — |\n| label | 查找和主详字段需要显示的label | string | — | — |\n| expressionType | 公式字段返回值类型 | string | — | — |\n\n#### id\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| id | 编辑记录id,记录保存后会通过$Bus.$emit调用save(id)回调函数,用于处理保存后的逻辑,参数是接口返回的数据 | string | — | — |\n\n#### options\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| pageId | 页面id,如果id相同,那么不会创建新页面,而是打开同一个页面 | string | 默认不填写 | -- |\n| openPlace | 打开位置 | string | dialog/tab/floatDialog/menu1/menu2 | dialog |\n| openMode | 打开方式 | string | _self/_blank | _blank",
|
|
306
|
+
"keyword": "打开标准编辑页,并返回打开页面的唯一标识,可以用于关闭和刷新使用。,openEditPage,页面,CCPage",
|
|
307
|
+
"version": "v0.2.1"
|
|
308
|
+
},
|
|
309
|
+
"openCustomPage": {
|
|
310
|
+
"name": "openCustomPage",
|
|
311
|
+
"description": "打开自定义页面,并返回打开页面的唯一标识,可以用于关闭和刷新使用。",
|
|
312
|
+
"content": "### openCustomPage(obj:object, options:object):string\n\n\n\n#### 打开自定义页面,并返回打开页面的唯一标识,可以用于关闭和刷新使用。\n#### 一级菜单示例:\njs\nlet obj =\n {\n pageApi: \"sayhello\",\n }\nlet options =\n {\n openPlace: 'menu1',\n openMode: '_blank',\n title: '菜单标题',\n // 是否展示菜单关闭按钮\n isShowClose:true,\n // 菜单操作项 不传默认为以下4项\n tabAction: [\n // 一级菜单可选操作项\n {\n name: \"刷新选项卡\",\n id: \"refresh\",\n },\n {\n name: \"固定选项卡\",\n id: \"fixed\",\n },\n {\n name: \"自定义选项卡\",\n id: \"custom\",\n },\n {\n name: \"关闭选项卡\",\n id: \"close\",\n },\n ]\n }\nlet pageId = $CCDK.CCPage.openCustomPage(obj,options)\n\n#### 二级菜单示例:\njs\nlet obj =\n {\n pageApi: \"sayhello\",\n }\nlet options =\n {\n openPlace: 'menu2',\n openMode: '_blank',\n title: '菜单标题',\n // 是否展示菜单关闭按钮\n isShowClose:true,\n // 菜单操作项 不传默认为以下4项\n tabAction: [\n // 二级菜单可选操作项\n {\n name: \"刷新选项卡\",\n id: \"refresh\",\n },\n {\n name: \"自定义选项卡\",\n id: \"custom\",\n },\n {\n name: \"设置为工作区选项卡\",\n id: \"setToLevel1\",\n },\n {\n name: \"关闭选项卡\",\n id: \"close\",\n },\n ]\n }\nlet pageId = $CCDK.CCPage.openCustomPage(obj,options)\n\n#### obj\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| pageApi | 自定义页面标识 | string | — | — |\n| data | 初始化的数据(表单数据可用,其他类型请使用localStorage)。{apiname:value}| object | — | — |\n#### data\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| key:value | key:表单字段apiname,value:该字段设置的值 | string | — | — |\n#### options\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| pageId | 页面id,如果id相同,那么不会创建新页面,而是打开同一个页面 | string | 默认不填写 | -- |\n| openPlace | 打开位置 | string | dialog/tab/floatDialog/menu1/menu2 | tab |\n| openMode | 打开方式 | string | _self/_blank | _blank\n| title | dialog标题或者菜单名字| string | — | —\n| isIframe | 打开一级菜单的自定义页面渲染的是iframe,需要缓存时设置此属性 | boolean | true/false | false\n| isShowClose | 是否展示菜单关闭按钮| boolean | true/false | true\n| tabAction | 一二级菜单下拉操作项| array | 见示例 | 见示例\n| width | 宽度,支持px,%,vw单位 | string | — | — |\n| height | 高度,支持px,vh单位 | string | — | — |\n| left | 距离屏幕左边大小 | string | — | — |\n| top | 距离屏幕顶部大小 | string | — | — |\n| right | 距离屏幕右侧大小 | string | — | — |\n| bottom | 距离屏幕底部大小 | string | — | — |\n| isShowMenu | 是否显示菜单 | boolean | 当openPlace是menu1/menu2不传默认true; 是tab不传默认false | -- |",
|
|
313
|
+
"keyword": "打开自定义页面,并返回打开页面的唯一标识,可以用于关闭和刷新使用。,openCustomPage,页面,CCPage",
|
|
314
|
+
"version": ""
|
|
315
|
+
},
|
|
316
|
+
"reOpenPage": {
|
|
317
|
+
"name": "reOpenPage",
|
|
318
|
+
"description": "通过页面Id,重新打开页面",
|
|
319
|
+
"content": "### reOpenPage(pageId:string,options:object)(开发中)\n\n\n\n#### 通过页面Id,重新打开页面\njs\nlet options =\n {\n refresh,\n }\n$CCDK.CCPage.reOpenPage(pageId,options)\n\n#### pageId\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| pageId | 页面唯一标识 | string | — | — |\n#### options\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| refresh | 是否刷新页面 | boolean | true/false | false |",
|
|
320
|
+
"keyword": "通过页面Id,重新打开页面,reOpenPage,页面,CCPage",
|
|
321
|
+
"version": "开发中"
|
|
322
|
+
},
|
|
323
|
+
"searchPage": {
|
|
324
|
+
"name": "searchPage",
|
|
325
|
+
"description": "查询页面",
|
|
326
|
+
"content": "### searchPage(pageId:string)\n\n\n\n#### 查询页面v0.3.9\njs\nlet obj = $CCDK.CCPage.searchPage(pageId)\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| pageId | 页面id,通过id查找是否存在此页面,若存在返回一个对象 | string | — | '' |",
|
|
327
|
+
"keyword": "查询页面,searchPage,页面,CCPage",
|
|
328
|
+
"version": "v0.3.9"
|
|
329
|
+
},
|
|
330
|
+
"getCurrentPage": {
|
|
331
|
+
"name": "getCurrentPage",
|
|
332
|
+
"description": "获取当前页面菜单数据",
|
|
333
|
+
"content": "### getCurrentPage()\n\n\n\n#### 获取当前页面菜单数据 v0.4.9\njs\nlet obj = $CCDK.CCPage.getCurrentPage()",
|
|
334
|
+
"keyword": "获取当前页面菜单数据,getCurrentPage,页面,CCPage",
|
|
335
|
+
"version": "v0.4.9"
|
|
336
|
+
},
|
|
337
|
+
"close": {
|
|
338
|
+
"name": "close",
|
|
339
|
+
"description": "关闭小程序",
|
|
340
|
+
"content": "### close(refresh:Boolean)\n\n\n\n#### 关闭小程序\n\n| 参数 | 说明 | 类型 |\n| ------- | -------------------- | ------- |\n| refresh | 是否刷新Native详情页 | Boolean |",
|
|
341
|
+
"keyword": "关闭小程序,close,页面,CCPage",
|
|
342
|
+
"version": ""
|
|
343
|
+
},
|
|
344
|
+
"refresh": {
|
|
345
|
+
"name": "refresh",
|
|
346
|
+
"description": "刷新当前选中的一级菜单或者二级菜单页面",
|
|
347
|
+
"content": "### refresh()\n\n\n\n#### 刷新当前选中的一级菜单或者二级菜单页面 v0.5.1\njs\nwindow.$CCDK.CCPage.refresh()",
|
|
348
|
+
"keyword": "刷新当前选中的一级菜单或者二级菜单页面,refresh,页面,CCPage",
|
|
349
|
+
"version": "v0.5.1"
|
|
350
|
+
}
|
|
351
|
+
}
|
|
352
|
+
},
|
|
353
|
+
"CCSide": {
|
|
354
|
+
"name": "侧边工具栏",
|
|
355
|
+
"keyword": "",
|
|
356
|
+
"description": "用于操作侧边工具栏",
|
|
357
|
+
"apis": {
|
|
358
|
+
"init": {
|
|
359
|
+
"name": "init",
|
|
360
|
+
"description": "初始化侧边栏",
|
|
361
|
+
"content": "### init(options)\n\n\n\n#### 初始化侧边栏 v0.4.7\njs\nlet options = {\n width:\"300px\",\n pageApi:\"dht\"\n}\n$CCDK.CCSide.init(options);\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| options | 初始化数据 | object | — | — |\n#### options\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| width | 侧边栏的宽度,支持px,%,vw单位 | string | — | — |\n| pageApi | 自定义页面api | string | — | — |",
|
|
362
|
+
"keyword": "初始化侧边栏,init,侧边工具栏,CCSide",
|
|
363
|
+
"version": "v0.4.7"
|
|
364
|
+
},
|
|
365
|
+
"open": {
|
|
366
|
+
"name": "open",
|
|
367
|
+
"description": "打开侧边栏",
|
|
368
|
+
"content": "### open()\n\n\n\n\n\n#### 打开侧边栏 v0.4.7\njs\n$CCDK.CCSide.open();",
|
|
369
|
+
"keyword": "打开侧边栏,open,侧边工具栏,CCSide",
|
|
370
|
+
"version": "v0.4.7"
|
|
371
|
+
},
|
|
372
|
+
"close": {
|
|
373
|
+
"name": "close",
|
|
374
|
+
"description": "关闭侧边栏",
|
|
375
|
+
"content": "### close()\n\n\n\n\n\n#### 关闭侧边栏 v0.4.7\njs\n$CCDK.CCSide.close();",
|
|
376
|
+
"keyword": "关闭侧边栏,close,侧边工具栏,CCSide",
|
|
377
|
+
"version": "v0.4.7"
|
|
378
|
+
}
|
|
379
|
+
}
|
|
380
|
+
},
|
|
381
|
+
"CCToken": {
|
|
382
|
+
"name": "令牌",
|
|
383
|
+
"keyword": "",
|
|
384
|
+
"description": "操作当前登录的令牌信息",
|
|
385
|
+
"apis": {
|
|
386
|
+
"getToken": {
|
|
387
|
+
"name": "getToken",
|
|
388
|
+
"description": "获取当前用户的令牌",
|
|
389
|
+
"content": "### getToken():string\n\n\n\n#### 获取当前用户的令牌 v0.0.1\njs\nlet token = $CCDK.CCToken.getToken()",
|
|
390
|
+
"keyword": "获取当前用户的令牌,getToken,令牌,CCToken",
|
|
391
|
+
"version": "v0.0.1"
|
|
392
|
+
},
|
|
393
|
+
"setToken": {
|
|
394
|
+
"name": "setToken",
|
|
395
|
+
"description": "设置当前用户的令牌",
|
|
396
|
+
"content": "### setToken(toke)\n\n\n\n\n\n#### 设置当前用户的令牌 v0.0.1\njs\nlet token = 'a2k3jlskdf'\n$CCDK.CCToken.setToken(token)\n\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------- |---------- |------------- |-------- |\n| token | 新令牌 | string | — | — |",
|
|
397
|
+
"keyword": "设置当前用户的令牌,setToken,令牌,CCToken",
|
|
398
|
+
"version": "v0.0.1"
|
|
399
|
+
},
|
|
400
|
+
"clearToken": {
|
|
401
|
+
"name": "clearToken",
|
|
402
|
+
"description": "清除当前用户的令牌",
|
|
403
|
+
"content": "### clearToken()\n\n\n\n\n\n#### 清除当前用户的令牌 v0.0.1\njs\n$CCDK.CCToken.clearToken()",
|
|
404
|
+
"keyword": "清除当前用户的令牌,clearToken,令牌,CCToken",
|
|
405
|
+
"version": "v0.0.1"
|
|
406
|
+
}
|
|
407
|
+
}
|
|
408
|
+
},
|
|
409
|
+
"CCUser": {
|
|
410
|
+
"name": "用户",
|
|
411
|
+
"keyword": "",
|
|
412
|
+
"description": "操作当前登录的用户信息",
|
|
413
|
+
"apis": {
|
|
414
|
+
"getUserInfo": {
|
|
415
|
+
"name": "getUserInfo",
|
|
416
|
+
"description": "获取当前登录的用户信息",
|
|
417
|
+
"content": "### getUserInfo():object\n\n\n\n#### 获取当前登录的用户信息 v0.0.1\njs\nlet userInfo = $CCDK.CCUser.getUserInfo()",
|
|
418
|
+
"keyword": "获取当前登录的用户信息,getUserInfo,用户,CCUser",
|
|
419
|
+
"version": "v0.0.1"
|
|
420
|
+
}
|
|
421
|
+
}
|
|
422
|
+
},
|
|
423
|
+
"CCUtils": {
|
|
424
|
+
"name": "工具",
|
|
425
|
+
"keyword": "",
|
|
426
|
+
"description": "一些常用的方法",
|
|
427
|
+
"apis": {
|
|
428
|
+
"getDomain": {
|
|
429
|
+
"name": "getDomain",
|
|
430
|
+
"description": "获得一级域名,比如:xx.com、xx.cn、xx.com.cn、xx.net.cn、xx.org.cn",
|
|
431
|
+
"content": "### getDomain():string\n\n\n\n#### 获得一级域名,比如:xx.com、xx.cn、xx.com.cn、xx.net.cn、xx.org.cn v0.0.1\njs\nlet domain = $CCDK.CCUtils.getDomain()",
|
|
432
|
+
"keyword": "获得一级域名,比如:xx.com、xx.cn、xx.com.cn、xx.net.cn、xx.org.cn,getDomain,工具,CCUtils",
|
|
433
|
+
"version": "v0.0.1"
|
|
434
|
+
},
|
|
435
|
+
"getCurrentPageType": {
|
|
436
|
+
"name": "getCurrentPageType",
|
|
437
|
+
"description": "获得当前页类型,暂时支持视图页和详情页",
|
|
438
|
+
"content": "### getCurrentPageType():string\n\n\n\n#### 获得当前页类型,暂时支持视图页和详情页 v0.9.22\njs\nlet pageType = $CCDK.CCUtils.getCurrentPageType()\n\n| 返回值 | 说明 | 类型 |\n|---------- |-------------- |---------- |\n| | \"view\": 视图页 \"detail\":详情页 | string |",
|
|
439
|
+
"keyword": "获得当前页类型,暂时支持视图页和详情页,getCurrentPageType,工具,CCUtils",
|
|
440
|
+
"version": "v0.9.22"
|
|
441
|
+
},
|
|
442
|
+
"setFormFieldValue": {
|
|
443
|
+
"name": "setFormFieldValue",
|
|
444
|
+
"description": "为表单字段值设置默认值",
|
|
445
|
+
"content": "### setFormFieldValue():void\n\n\n\n#### 为表单字段值设置默认值 v0.9.37\njs\n// 新建、编辑页面中的onLoad、onChange客户端脚本中,参数obj中存在表单formId\nconst formId = obj.formId;\nconst option = {\n formId:formId,\n list: [{\n // 字段值\n value:'',\n // 查找字段的label,查找字段赋值需要传\n valueName:'',\n // 字段apiname\n fieldKey:'',\n }],\n}\n$CCDK.CCUtils.setFormFieldValue(option)\n\noption值为对象,参数说明:\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| formId | 表单id,客户端脚本obj对象中可以获取到| string | — | — |\n| list | 赋值字段信息 | array | — | — |\n\n#### ccdk获取指定表单字段采集值 v0.9.38\n需结合客户端脚本,获取formId\njs\n// 新建、编辑页面中的onLoad、onChange客户端脚本中,参数obj中存在表单formId\nconst formId = obj.formId;\nconst option = {\n formId:formId,\n list: [{\n // 字段apiname\n fieldKey:'',\n }],\n}\n$CCDK.CCUtils.getFormFieldValue(option)\n\noption值为对象,参数说明:\n| 参数 | 说明 | 类型 | 可选值 | 默认值 |\n|---------- |-------------- |---------- |-------------------------------- |-------- |\n| formId | 表单id,客户端脚本obj参数中可以获取到,同一表单场景下,同时打开多个表单时,用于定位表单 | string | — | — |\n| view | 对应场景,默认是新建、编辑,默认情况无需传 | string | ccForm | ccForm |\n| list | 指定获取某些字段值,fieldKey是字段apiname,非必传参数,参数不传时,默认返回表单主记录所有数据 | array | — | — |",
|
|
446
|
+
"keyword": "为表单字段值设置默认值,setFormFieldValue,工具,CCUtils",
|
|
447
|
+
"version": "v0.9.37"
|
|
448
|
+
}
|
|
449
|
+
}
|
|
450
|
+
}
|
|
451
|
+
};
|
|
452
|
+
|
|
453
|
+
module.exports = { ccdkApiTree };
|