Skip to content

Commit 2043eb1

Browse files
dcloud-wandldcloud-wandl
committed
Merge remote-tracking branch 'origin/dev'
2 parents 8d3121f + bda52c4 commit 2043eb1

38 files changed

+518
-465
lines changed

‎en/ExtensionDocs/Api/commands.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ commands, the second-level module object, used to process the logic related to `
7373
|Promise |Promise对象|
7474

7575

76-
##### 示例
76+
##### Example
7777
``` javascript
7878
//执行插件扩展的命令
7979
hx.commands.executeCommand('extension.firstExtension')
@@ -98,7 +98,7 @@ hx.commands.executeCommand('workbench.action.closeAllEditors')
9898
|[Disposable](/ExtensionDocs/Api/other/Disposable) |该`命令`的销毁器,可将该对象放置到插件的context.subscriptions数组内，插件卸载时，将会自动注销该`命令` |
9999

100100

101-
##### 示例
101+
##### Example
102102
``` javascript
103103
let disposable = hx.commands.registerCommand('extension.firstExtension',()=>{
104104
hx.window.showInformationMessage("Hello My First Extension.");

‎en/ExtensionDocs/Api/env/authorize.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ authorize二级模块对象，用于处理插件授权登录，获取HBuilderX
2525

2626
## login
2727

28-
#### 参数说明
28+
#### Parameter
2929

30-
|参数名称 |参数类型 |描述 |
30+
|Name |Type |Description |
3131
|-- |-- |-- |
3232
|params | Object |授权登录必要的信息|
3333

3434
参数属性说明
3535

36-
|属性名 |属性类型 |描述 |
36+
|Attribute name |Type |Description |
3737
|-- |-- |-- |
3838
|client_id |String | 在[DCloud开发者开放开台](https://open.dcloud.net.cn/)添加授权插件后创建的client_id |
3939
|scopes |Array<String> | 授权范围列表, 取值范围：basic, email, phone。basic必填|
@@ -45,20 +45,20 @@ email和phone请谨慎使用，非必要申请授权会招致HBuilderX的用户
4545

4646
同时注意在调用login方法后，HBuilderX会弹出授权确认框，用户可能拒绝授权或拒绝授权email、phone等敏感信息。
4747

48-
#### 返回值
48+
#### Returns
4949

50-
|返回类型 |描述 |
50+
|Type |Description |
5151
|-- |-- |
5252
|Promise<Object> | Promise对象 |
5353

5454
返回值属性说明
5555

56-
|属性名 |属性类型 |描述 |
56+
|Attribute name |Type |Description |
5757
|-- |-- |-- |
5858
|code |String | CODE码，有效期5分钟。用于插件作者服务器端换取accessToken，通过accessToken换取授权的基本信息 |
5959
|error |Number | code获取失败时的错误码 |
6060

61-
#### 示例
61+
#### Example
6262
``` javascript
6363
let prom = hx.authorize.login({ client_id: "your client id", scopes: ['basic', 'email','phone'], description: "for test"});
6464
prom.then(function (param) {
@@ -69,7 +69,7 @@ email和phone请谨慎使用，非必要申请授权会招致HBuilderX的用户
6969

7070
#### 主要错误码信息
7171

72-
|错误码 | 描述 |
72+
|错误码 | Description |
7373
|-- |-- |
7474
|0 | 无错误 |
7575
|1 | 当前没有登录用户 |
@@ -90,20 +90,20 @@ email和phone请谨慎使用，非必要申请授权会招致HBuilderX的用户
9090
## onUserLogin
9191
用户登录事件
9292

93-
#### 参数说明
93+
#### Parameter
9494

95-
|参数名称 |参数类型 |描述 |
95+
|Name |Type |Description |
9696
|-- |-- |-- |
9797
|callback |Function |用户登录时的回调函数，无参数|
9898

99-
#### 返回值
99+
#### Returns
100100

101-
|返回类型 |描述 |
101+
|Type|Description |
102102
|-- |-- |
103103
|[Disposable](#Disposable) | Disposable |
104104

105105

106-
#### 示例
106+
#### Example
107107
``` javascript
108108
hx.authorize.onUserLogin(function(){
109109
// do something
@@ -113,19 +113,19 @@ email和phone请谨慎使用，非必要申请授权会招致HBuilderX的用户
113113
## onUserLogout
114114
当前登录用户退出事件
115115

116-
#### 参数说明
116+
#### Parameter
117117

118-
|参数名称 |参数类型 |描述 |
118+
|Name |Type |Description |
119119
|-- |-- |-- |
120120
|callback |Function |当前登录用户退出时的回调函数，无参数|
121121

122-
#### 返回值
122+
#### Returns
123123

124-
|返回类型 |描述 |
124+
|Type |Description |
125125
|-- |-- |
126126
|[Disposable](#Disposable) | Disposable对象 |
127127

128-
#### 示例
128+
#### Example
129129
``` javascript
130130
hx.authorize.onUserLogout(function(){
131131
// do something

‎en/ExtensionDocs/Api/other/Disposable.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33

44
#### dispose
55

6-
#### 参数说明
6+
#### Parameter
77
无
88

9-
#### 返回值
9+
#### Returns
1010
无

‎en/ExtensionDocs/Api/other/Uri.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A universal resource identifier representing either a file on disk or another resource, like untitled resources.
44

5-
**属性列表**
5+
**Attribute list**
66

77
|Parameter |Type |Description |
88
|-- |-- |-- |

‎en/ExtensionDocs/Api/other/WorkspaceFolder.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# WorkspaceFolder
22

3-
工作空间下的项目目录,在左侧项目管理器内的每一个项目表示一个WorkspaceFolder
3+
The project directory under the workspace, each project in the project manager on the left represents a WorkspaceFolder
44

5-
**属性列表**
5+
**Attribute list**
66

7-
|属性名 |属性类型 |描述 |
7+
|Attribute name |Type |Description |
88
|-- |-- |-- |
9-
|uri |String或[Uri](/ExtensionDocs/Api/other/Uri)|项目目录地址 |
10-
|name |String |项目目录名称 |
11-
|nature |String |项目类型 |
12-
|id |String |项目唯一id |
9+
|uri |String或[Uri](/ExtensionDocs/Api/other/Uri)|Project Path |
10+
|name |String |Project directory name |
11+
|nature |String |Project Type |
12+
|id |String |Project ID |

‎en/ExtensionDocs/Api/other/languageId.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# languageId
22

3-
以下是目前支持的编程语言Id列表：
3+
The following is a list of currently supported programming language IDs:
44

55
- txt
66
- actionscript

‎en/ExtensionDocs/Api/windows/StatusBar.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ Set the status bar message at the bottom of HBuilderX
66

77
#### Parameter
88

9-
|Name |Type |Description |
10-
|-- |-- |-- |
11-
|text |String |Message content |
12-
|hideAfterTimeout |Number |[Optional] Timeout in milliseconds after which the message will be disposed. <br/><br/>The default value is 0: do not automatically hide |
13-
|level |String |[Optional] Message level, the values are ['warn','info','error'], default value:'info' |
9+
|Name |Type |Description |
10+
|-- |-- |-- |
11+
|text |String |Message content |
12+
|hideAfterTimeout |Number |[Optional] Timeout in milliseconds after which the message will be disposed. <br/><br/>The default value is 0: do not automatically hide |
13+
|level |String |[Optional] Message level, the values are ['warn','info','error'], default value:'info' |
1414

1515
#### Returns
1616

17-
|Type |Description |
18-
|-- |-- |
19-
|[Disposable](/ExtensionDocs/Api/other/Disposable) |A disposable which hides the status bar message. |
17+
|Type |Description |
18+
|-- |-- |
19+
|[Disposable](/ExtensionDocs/Api/other/Disposable)|A disposable which hides the status bar message. |
2020

2121

2222
#### Example

‎en/ExtensionDocs/Api/windows/TextDocument.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,53 +3,53 @@
33

44
## 属性列表
55

6-
|属性名 |属性类型 |描述 |
7-
|-- |-- |-- |
8-
|fileName |String |文件名称 |
9-
|isDirty |Boolean |是否是修改状态 |
10-
|isUntitled |Boolean | 是否是无标题文件 |
11-
|lineCount |Number |文档总行数 |
12-
|uri |[Uri](/ExtensionDocs/Api/other/Uri) |文档的uri，如果是本地文件，可通过uri.fsPath获取本地文件路径|
13-
|languageId|String|编程语言Id，如'javascript','html'等，完整id列表参见[这里](/ExtensionDocs/Api/other/languageId) |
14-
|workspaceFolder|[WorkspaceFolder](/ExtensionDocs/Api/other/WorkspaceFolder)|该文档文件所属的项目对象 |
6+
|Attribute name |Type |Description |
7+
|-- |-- |-- |
8+
|fileName |String |文件名称 |
9+
|isDirty |Boolean |是否是修改状态 |
10+
|isUntitled |Boolean | 是否是无标题文件 |
11+
|lineCount |Number |文档总行数 |
12+
|uri |[Uri](/ExtensionDocs/Api/other/Uri) |文档的uri，如果是本地文件，可通过uri.fsPath获取本地文件路径 |
13+
|languageId |String |编程语言Id，如'javascript','html'等，完整id列表参见[这里](/ExtensionDocs/Api/other/languageId) |
14+
|workspaceFolder|[WorkspaceFolder](/ExtensionDocs/Api/other/WorkspaceFolder)|该文档文件所属的项目对象 |
1515

1616
## getText
1717
获取指定区域内的文本
1818

19-
|参数名称 |参数类型 |描述 |
19+
|Name |Type |Description |
2020
|-- |-- |-- |
2121
|range |[Range](#Range)|[可选]文本区域，如果不传该参数，则获取整个文档的内容 |
2222

23-
**返回值**
23+
**Returns**
2424

25-
|返回类型 |描述 |
25+
|Type |Description |
2626
|-- |-- |
2727
|String |文本字符串 |
2828

2929

3030
## lineAt
3131
获取指定行号的行信息
3232

33-
|参数名称 |参数类型 |描述 |
33+
|Name |Type |Description |
3434
|-- |-- |-- |
3535
|lineno |Number |行号，从0开始 |
3636

37-
**返回值**
37+
**Returns**
3838

39-
|返回类型 |描述 |
39+
|Type |Description |
4040
|-- |-- |
4141
| Promise&lt;[TextLine](#TextLine)&gt; |文本行对象 |
4242

4343
## lineFromPosition
4444
根据光标位置获取光标所在行。
4545

46-
|参数名称 |参数类型 |描述 |
46+
|Name |Type |Description |
4747
|-- |-- |-- |
4848
|pos |Number |光标位置 |
4949

50-
**返回值**
50+
**Returns**
5151

52-
|返回类型 |描述 |
52+
|Type |Description |
5353
|-- |-- |
5454
|Promise&lt;[TextLine](#TextLine)&gt; |文本行对象 |
5555

@@ -59,7 +59,7 @@
5959

6060
### 属性列表
6161

62-
|属性名 |属性类型 |描述 |
62+
|Attribute name |Type |Description |
6363
|-- |-- |-- |
6464
|start |Number |起始位置 |
6565
|end |Number |结束位置 |
@@ -69,7 +69,7 @@
6969

7070
### 属性列表
7171

72-
|属性名 |属性类型 |描述 |
72+
|Attribute name |Type |Description |
7373
|-- |-- |-- |
7474
|start |Number |行起始位置 |
7575
|end |Number |行结束位置，不计算换行符 |
@@ -81,22 +81,22 @@
8181

8282
### 属性列表
8383

84-
|属性名 |属性类型 |描述 |
84+
|Attribute name |Type |Description |
8585
|-- |-- |-- |
8686
|range |[Range](#Range) |要修改的区域 |
8787
|newText|String |要插入的新内容 |
8888

8989
### replace **static**
9090

91-
#### 参数说明
91+
#### Parameter
9292

93-
|参数名称 |参数类型 |描述 |
93+
|Name |Type |Description |
9494
|-- |-- |-- |
9595
|range |[Range](#Range) |要修改的区域 |
9696
|newText |String |要插入的新内容 |
9797

98-
#### 返回值
98+
#### Returns
9999

100-
|返回类型 |描述 |
100+
|Type |Description |
101101
|-- |-- |
102102
|[TextEdit](#TextEdit)| 文档编辑对象|

0 commit comments

Comments
 (0)