Skip to content

Commit 2c072ba

Browse files
author
yelvye
committed
update md files
1 parent 8767c6e commit 2c072ba

38 files changed

+2107
-6
lines changed

‎CHANGELOG.md

+47-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,49 @@
11
# 1.0.9
22

3-
* 增加监控统计功能
3+
* 增加APP启动指令
4+
* [LaunchApp(app启动指令)](doc/directive/AppLuncher/LaunchApp.md)
5+
6+
* 增加音频PlayerInfo
7+
* [PlayerInfo(播放信息类)](doc/directive/AudioPlayer/PlayerInfo.md)
8+
9+
* 增加音频控制组件
10+
* [BaseButton(按钮控件基础类)](doc/directive/AudioPlayer/Control/BaseButton.md)
11+
* [Button(普通按钮控件)](doc/directive/AudioPlayer/Control/Button.md)
12+
* [FavoriteButton(喜欢按钮控件)](doc/directive/AudioPlayer/Control/FavoriteButton.md)
13+
* [LyricButton(歌词按钮控件)](doc/directive/AudioPlayer/Control/LyricButton.md)
14+
* [NextButton(下一曲按钮控件)](doc/directive/AudioPlayer/Control/NextButton.md)
15+
* [PlayPauseButton(暂停播放按钮控件)](doc/directive/AudioPlayer/Control/PlayPauseButton.md)
16+
* [PreviousButton(上一曲按钮控件)](doc/directive/AudioPlayer/Control/PreviousButton.md)
17+
* [RadioButton(单选按钮控件)](doc/directive/AudioPlayer/Control/RadioButton.md)
18+
* [RecommendButton(推荐按钮控件)](doc/directive/AudioPlayer/Control/RecommendButton.md)
19+
* [RefreshButton(刷新按钮控件)](doc/directive/AudioPlayer/Control/RefreshButton.md)
20+
* [RepeatButton(单曲循环按钮控件)](doc/directive/AudioPlayer/Control/RepeatButton.md)
21+
* [ShowFavoriteListButton(展现收藏歌曲列表按钮控件)](doc/directive/AudioPlayer/Control/ShowFavoriteListButton.md)
22+
* [ShowPlayListButton(展现歌曲列表按钮控件)](doc/directive/AudioPlayer/Control/ShowPlayListButton.md)
23+
* [ThumbsUpDownButton(封面按钮控件)](doc/directive/AudioPlayer/Control/ThumbsUpDownButton.md)
24+
25+
* 增加视频指令
26+
* [Play(视频播放指令)](doc/directive/VideoPlayer/Play.md)
27+
* [Stop(视频停止指令)](doc/directive/VideoPlayer/Stop.md)
28+
29+
* 增加展示
30+
* 模版
31+
* [BaseTemplate(基础模版类)](doc/directive/Dispay/Template/BaseTemplate.md)
32+
* [BodyTemplate1(文本展现模板)](doc/directive/Dispay/Template/BodyTemplate1.md)
33+
* [BodyTemplate2(上图下文模版)](doc/directive/Dispay/Template/BaseTemplate2.md)
34+
* [BodyTemplate3(左图右文模版)](doc/directive/Dispay/Template/BodyTemplate3.md)
35+
* [BodyTemplate4(右图左文模版)](doc/directive/Dispay/Template/BodyTemplate4.md)
36+
* [BodyTemplate5(图片模板)](doc/directive/Dispay/Template/BodyTemplate5.md)
37+
* [ListTemplate(列表模版基础类)](doc/directive/Dispay/Template/ListTemplate.md)
38+
* [ListTemplate1(横向列表模板)](doc/directive/Dispay/Template/ListTemplate1.md)
39+
* [ListTemplate2(纵向列表模板)](doc/directive/Dispay/Template/ListTemplate2.md)
40+
* [ListTemplateItem(模版列表项)](doc/directive/Dispay/Template/ListTemplateItem.md)
41+
* [TextImageTemplate(图文模版)](doc/directive/Dispay/Template/TextImageTemplate.md)
42+
* 用户提示指令
43+
* [Hint(用户提示指令)](doc/directive/Dispay/Hint.md)
44+
* 模版渲染
45+
* [RenderTemplate(模版渲染)](doc/directive/Dispay/RenderTemplate.md)
46+
47+
* 增加支付
48+
* 支付Charge
49+
[Charge(支付类)](doc/directive/Pay/Charge.md)

‎README.md

+4
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,8 @@ app.post('/', (req, res) => {
145145
* [ListCard(列表卡片)](doc/card/ListCard.md)
146146
* 指令
147147
* [BaseDirective(所有指令基类)](doc/directive/BaseDirective.md)
148+
* app启动指令
149+
* [LaunchApp(app启动指令)](doc/directive/AppLuncher/LaunchApp.md)
148150
* 音频
149151
* [Play(音频播放指令)](doc/directive/AudioPlayer/Play.md)
150152
* [Stop(音频停止指令)](doc/directive/AudioPlayer/Stop.md)
@@ -185,3 +187,5 @@ app.post('/', (req, res) => {
185187
* 模版渲染
186188
* [RenderTemplate(模版渲染)](doc/directive/Dispay/RenderTemplate.md)
187189

190+
* 支付
191+
* [Charge(支付指令)](doc/directive/Pay/Charge.md)

‎doc/Bot.md

+392
Large diffs are not rendered by default.

‎doc/Request.md

+14
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
* [.getNlu()](#Request+getNlu) ⇒ <code>Nlu</code>
1313
* [.getType()](#Request+getType) ⇒ <code>string</code>
1414
* [.getAudioPlayerContext()](#Request+getAudioPlayerContext) ⇒ <code>Mixed</code>
15+
* [.getVideoPlayerContext()](#Request+getVideoPlayerContext) ⇒ <code>Mixed</code>
16+
* [.getScreenContext()](#Request+getScreenContext) ⇒ <code>Object</code>
1517
* [.getEventData()](#Request+getEventData) ⇒ <code>Mixed</code>
1618
* [.getUserId()](#Request+getUserId) ⇒ <code>string</code>
1719
* [.getQuery()](#Request+getQuery) ⇒ <code>string</code>
@@ -58,6 +60,18 @@
5860
### request.getAudioPlayerContext() ⇒ <code>Mixed</code>
5961
获取设备音频播放的状态
6062

63+
**Kind**: instance method of [<code>Request</code>](#Request)
64+
<a name="Request+getVideoPlayerContext"></a>
65+
66+
### request.getVideoPlayerContext() ⇒ <code>Mixed</code>
67+
获取设备视频播放的状态
68+
69+
**Kind**: instance method of [<code>Request</code>](#Request)
70+
<a name="Request+getScreenContext"></a>
71+
72+
### request.getScreenContext() ⇒ <code>Object</code>
73+
获取screen context
74+
6175
**Kind**: instance method of [<code>Request</code>](#Request)
6276
<a name="Request+getEventData"></a>
6377

‎doc/Response.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,15 @@
88
* [Response](#Response)
99
* [new Response(request, session, nlu)](#new_Response_new)
1010
* [.setShouldEndSession(val)](#Response+setShouldEndSession)
11+
* [.setExpectSpeech(expectSpeech)](#Response+setExpectSpeech)
1112
* [.illegalRequest()](#Response+illegalRequest) ⇒ <code>Promise</code>
1213
* [.build(data)](#Response+build) ⇒ <code>Promise</code>
1314

1415
<a name="new_Response_new"></a>
1516

1617
### new Response(request, session, nlu)
18+
构造方法
19+
1720

1821
| Param | Type | Description |
1922
| --- | --- | --- |
@@ -30,7 +33,18 @@
3033

3134
| Param | Type | Description |
3235
| --- | --- | --- |
33-
| val | <code>boolean</code> | true: 结束对话 false: 继续对话 |
36+
| val | <code>boolean</code> | true: 结束对话,false: 继续对话 |
37+
38+
<a name="Response+setExpectSpeech"></a>
39+
40+
### response.setExpectSpeech(expectSpeech)
41+
通过控制expectSpeech来控制麦克风开关
42+
43+
**Kind**: instance method of [<code>Response</code>](#Response)
44+
45+
| Param | Type | Description |
46+
| --- | --- | --- |
47+
| expectSpeech | <code>boolean</code> | 麦克风是否开启 |
3448

3549
<a name="Response+illegalRequest"></a>
3650

‎doc/directive/AppLuncher/LaunchApp.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<a name="LaunchApp"></a>
2+
3+
## LaunchApp
4+
**Kind**: global class
5+
6+
* [LaunchApp](#LaunchApp)
7+
* [new LaunchApp(appName, packageName, deepLink)](#new_LaunchApp_new)
8+
* [.setToken(token)](#LaunchApp+setToken)
9+
* [.getToken()](#LaunchApp+getToken) ⇒ <code>string</code>
10+
* [.setAppName(appName)](#LaunchApp+setAppName)
11+
* [.setPackageName(packageName)](#LaunchApp+setPackageName)
12+
* [.setDeepLink(deepLink)](#LaunchApp+setDeepLink)
13+
14+
<a name="new_LaunchApp_new"></a>
15+
16+
### new LaunchApp(appName, packageName, deepLink)
17+
LaunchApp构造函数
18+
19+
20+
| Param | Type | Description |
21+
| --- | --- | --- |
22+
| appName | <code>string</code> | 应用的名称 |
23+
| packageName | <code>string</code> | 应用的包名 |
24+
| deepLink | <code>string</code> | 打开应用指定功能 注意：以上appName，packageName和deepLink三个参数至少一个 |
25+
26+
<a name="LaunchApp+setToken"></a>
27+
28+
### launchApp.setToken(token)
29+
设置directive的token. 默认在构造时自动生成了token，可以覆盖
30+
31+
**Kind**: instance method of [<code>LaunchApp</code>](#LaunchApp)
32+
33+
| Param | Type | Description |
34+
| --- | --- | --- |
35+
| token | <code>string</code> | token |
36+
37+
<a name="LaunchApp+getToken"></a>
38+
39+
### launchApp.getToken() ⇒ <code>string</code>
40+
获取directive的token. 默认在构造时自动生成了token
41+
42+
**Kind**: instance method of [<code>LaunchApp</code>](#LaunchApp)
43+
**Returns**: <code>string</code> - token
44+
<a name="LaunchApp+setAppName"></a>
45+
46+
### launchApp.setAppName(appName)
47+
设置应用的名称
48+
49+
**Kind**: instance method of [<code>LaunchApp</code>](#LaunchApp)
50+
51+
| Param | Type | Description |
52+
| --- | --- | --- |
53+
| appName | <code>string</code> | 应用的名称 |
54+
55+
<a name="LaunchApp+setPackageName"></a>
56+
57+
### launchApp.setPackageName(packageName)
58+
设置应用的包名
59+
60+
**Kind**: instance method of [<code>LaunchApp</code>](#LaunchApp)
61+
62+
| Param | Type | Description |
63+
| --- | --- | --- |
64+
| packageName | <code>string</code> | 应用的包名 |
65+
66+
<a name="LaunchApp+setDeepLink"></a>
67+
68+
### launchApp.setDeepLink(deepLink)
69+
设置deepLink
70+
71+
**Kind**: instance method of [<code>LaunchApp</code>](#LaunchApp)
72+
73+
| Param | Type | Description |
74+
| --- | --- | --- |
75+
| deepLink | <code>string</code> | 应用指定功能 |
76+

‎doc/directive/AudioPlayer/Control/BaseButton.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<a name="BaseButton"></a>
2+
3+
## BaseButton
4+
BaseButton Button基础类
5+
6+
**Kind**: global class
7+
8+
* [BaseButton](#BaseButton)
9+
* [new BaseButton(type, name)](#new_BaseButton_new)
10+
* [.getData()](#BaseButton+getData) ⇒ <code>Object</code>
11+
12+
<a name="new_BaseButton_new"></a>
13+
14+
### new BaseButton(type, name)
15+
BaseButton 构造方法.
16+
17+
18+
| Param | Type | Description |
19+
| --- | --- | --- |
20+
| type | <code>string</code> | 类型 |
21+
| name | <code>string</code> | 名称 |
22+
23+
<a name="BaseButton+getData"></a>
24+
25+
### baseButton.getData() ⇒ <code>Object</code>
26+
getData
27+
28+
**Kind**: instance method of [<code>BaseButton</code>](#BaseButton)
29+
**Returns**: <code>Object</code> - Control数据
30+
**Access**: public

‎doc/directive/AudioPlayer/Control/Button.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
## Classes
2+
3+
<dl>
4+
<dt><a href="#BaseButton">BaseButton</a> ⇐ <code><a href="#BaseButton">BaseButton</a></code></dt>
5+
<dd><p>Button Button按钮类</p>
6+
</dd>
7+
<dt><a href="#Button">Button</a></dt>
8+
<dd></dd>
9+
</dl>
10+
11+
<a name="BaseButton"></a>
12+
13+
## BaseButton ⇐ [<code>BaseButton</code>](#BaseButton)
14+
Button Button按钮类
15+
16+
**Kind**: global class
17+
**Extends**: [<code>BaseButton</code>](#BaseButton)
18+
<a name="Button"></a>
19+
20+
## Button
21+
**Kind**: global class
22+
23+
* [Button](#Button)
24+
* [new Button(name)](#new_Button_new)
25+
* [.setEnabled(bool)](#Button+setEnabled)
26+
* [.setSelected(bool)](#Button+setSelected)
27+
28+
<a name="new_Button_new"></a>
29+
30+
### new Button(name)
31+
Button 构造函数.
32+
33+
34+
| Param | Type | Description |
35+
| --- | --- | --- |
36+
| name | <code>string</code> | 控件名字 |
37+
38+
<a name="Button+setEnabled"></a>
39+
40+
### button.setEnabled(bool)
41+
按钮是否可点击
42+
43+
**Kind**: instance method of [<code>Button</code>](#Button)
44+
**Access**: public
45+
46+
| Param | Type | Description |
47+
| --- | --- | --- |
48+
| bool | <code>boolean</code> | 按钮是否可点击，取值为true说明可以点击，取值为false不可点击 |
49+
50+
<a name="Button+setSelected"></a>
51+
52+
### button.setSelected(bool)
53+
按钮是否要渲染为选中状态
54+
55+
**Kind**: instance method of [<code>Button</code>](#Button)
56+
**Access**: public
57+
58+
| Param | Type | Description |
59+
| --- | --- | --- |
60+
| bool | <code>boolean</code> | 按钮是否要渲染为选中状态，取值为true需要渲染为选中状态，取值为false渲染为非选中状态 |
61+

‎doc/directive/AudioPlayer/Control/FavoriteButton.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Classes
2+
3+
<dl>
4+
<dt><a href="#Button">Button</a> ⇐ <code><a href="#Button">Button</a></code></dt>
5+
<dd><p>FavoriteButton 收藏按钮类</p>
6+
</dd>
7+
<dt><a href="#FavoriteButton">FavoriteButton</a></dt>
8+
<dd></dd>
9+
</dl>
10+
11+
<a name="Button"></a>
12+
13+
## Button ⇐ [<code>Button</code>](#Button)
14+
FavoriteButton 收藏按钮类
15+
16+
**Kind**: global class
17+
**Extends**: [<code>Button</code>](#Button)
18+
<a name="FavoriteButton"></a>
19+
20+
## FavoriteButton
21+
**Kind**: global class
22+
<a name="new_FavoriteButton_new"></a>
23+
24+
### new FavoriteButton()
25+
FavoriteButton 构造函数.
26+

‎doc/directive/AudioPlayer/Control/LyricButton.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Classes
2+
3+
<dl>
4+
<dt><a href="#Button">Button</a> ⇐ <code><a href="#Button">Button</a></code></dt>
5+
<dd><p>LyricButton 歌词按钮</p>
6+
</dd>
7+
<dt><a href="#LyricButton">LyricButton</a></dt>
8+
<dd></dd>
9+
</dl>
10+
11+
<a name="Button"></a>
12+
13+
## Button ⇐ [<code>Button</code>](#Button)
14+
LyricButton 歌词按钮
15+
16+
**Kind**: global class
17+
**Extends**: [<code>Button</code>](#Button)
18+
<a name="LyricButton"></a>
19+
20+
## LyricButton
21+
**Kind**: global class
22+
<a name="new_LyricButton_new"></a>
23+
24+
### new LyricButton()
25+
LyricButton 构造函数.
26+

‎doc/directive/AudioPlayer/Control/NextButton.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Classes
2+
3+
<dl>
4+
<dt><a href="#Button">Button</a> ⇐ <code><a href="#Button">Button</a></code></dt>
5+
<dd><p>NextButton 下一曲按钮</p>
6+
</dd>
7+
<dt><a href="#NextButton">NextButton</a></dt>
8+
<dd></dd>
9+
</dl>
10+
11+
<a name="Button"></a>
12+
13+
## Button ⇐ [<code>Button</code>](#Button)
14+
NextButton 下一曲按钮
15+
16+
**Kind**: global class
17+
**Extends**: [<code>Button</code>](#Button)
18+
<a name="NextButton"></a>
19+
20+
## NextButton
21+
**Kind**: global class
22+
<a name="new_NextButton_new"></a>
23+
24+
### new NextButton()
25+
NextButton 构造函数.
26+

0 commit comments

Comments
 (0)