Skip to content

Commit 60736d0

Browse files
jiajun-ifanrjiajun-ifanr
committed
修复 flutter 文档描述不正确的问题
1 parent 4679c28 commit 60736d0

File tree

11 files changed

+80
-54
lines changed

11 files changed

+80
-54
lines changed

‎flutter-sdk/error-code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ TableRecord record = product.create();
2121
try {
2222
record.set(123);
2323
} catch (err) {
24-
console.log(err.code) // 605
24+
print(err.code); // 605
2525
}
2626
2727
```

‎flutter-sdk/file/file.md

Lines changed: 48 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
**示例代码**
3434

3535
```Dart
36+
import 'dart:io';
3637
import 'package:file_picker/file_picker.dart';
3738
3839
try {
@@ -60,6 +61,8 @@ try {
6061
**示例代码**
6162

6263
```Dart
64+
import 'package:minapp/minapp.dart';
65+
6366
try {
6467
CloudFile MyFile = await FileManager.get('5a2fe93308443e313a428c4f');
6568
// 操作成功
@@ -83,6 +86,8 @@ HError 对象结构请参考[错误码和 HError 对象](/flutter-sdk/error-code
8386
**示例代码**
8487

8588
```Dart
89+
import 'package:minapp/minapp.dart';
90+
8691
try {
8792
await FileManager.delete('5a2fe93308443e313a428c4f');
8893
await FileManager.delete(['5a2fe93308443e313a428c4c', '5a2fe93308443e313a428c4d']);
@@ -115,19 +120,22 @@ try {
115120
**示例代码**
116121

117122
```Dart
123+
import 'package:minapp/minapp.dart';
124+
118125
try {
119126
// 查找所有文件
120127
CloudFileList cloudFiles = await FileManager.find();
121128
122-
let query = new Query();
129+
Query query = new Query();
123130
// 查询某一文件分类下的所有文件
124-
query.compare('category_name', '=', categoryName);
131+
Where where = Where.compare('category_name', '=', categoryName);
125132
// 查询文件名包含指定字符串的文件
126-
query.contains('name', substr);
133+
Where where = Where.contains('name', substr);
127134
135+
query.where(where);
128136
CloudFileList cloudFiles = await FileManager.find(query);
129137
// 操作成功
130-
} on HError catch(e) {
138+
} on HError catch (e) {
131139
// 操作失败
132140
}
133141
```
@@ -144,6 +152,8 @@ try {
144152
**示例代码**
145153

146154
```Dart
155+
import 'package:minapp/minapp.dart';
156+
147157
try {
148158
Query query = Query();
149159
query.orderBy('-created_at');
@@ -160,6 +170,8 @@ try {
160170
**示例代码**
161171

162172
```Dart
173+
import 'package:minapp/minapp.dart';
174+
163175
try {
164176
Query query = Query();
165177
query
@@ -187,6 +199,8 @@ try {
187199
**示例代码**
188200

189201
```Dart
202+
import 'package:minapp/minapp.dart';
203+
190204
try {
191205
FileCategory cate = await FileManager.getCategory('5a2fe91508443e3123dbe1cb');
192206
// 操作成功
@@ -202,6 +216,8 @@ try {
202216
**示例代码**
203217

204218
```Dart
219+
import 'package:minapp/minapp.dart';
220+
205221
try {
206222
Query query = Query();
207223
Where where = Where.compare('category_id', '=', '5a2fe91508443e3123dbe1cb');
@@ -226,6 +242,8 @@ try {
226242
文件分类查询与[数据表查询](../schema/query.md)方法一致，但只支持以下指定字段的筛选：
227243

228244
```Dart
245+
import 'package:minapp/minapp.dart';
246+
229247
try {
230248
FileCategoryList cates = await FileManager.getCategoryList();
231249
// 操作成功
@@ -296,14 +314,16 @@ res:
296314
**示例代码**
297315

298316
```Dart
317+
import 'package:minapp/minapp.dart';
318+
299319
try {
300320
Map<String, dynamic> params = {
301321
"source": "xxxxxxxxxx",
302322
"save_as": "hello.png",
303323
"point": "00:00:10",
304324
"category_id": "5c18bc794e1e8d20dbfcddcc",
305325
"random_file_link": false
306-
}
326+
};
307327
Map<String, dynamic> cover = await FileManager.genVideoSnapshot(params)
308328
// 操作成功
309329
} on HError catch(e) {
@@ -369,13 +389,20 @@ Map<String, dynamic> res:
369389
**示例代码**
370390

371391
```Dart
372-
Map<String, dynamic> params = {
373-
"m3u8s": ["xxxxxxxxxx", "xxxxxxxxxx"],
374-
"save_as": "hello.m3u8",
375-
"category_id": "5c18bc794e1e8d20dbfcddcc",
376-
"random_file_link": false,
392+
import 'package:minapp/minapp.dart';
393+
394+
try {
395+
Map<String, dynamic> params = {
396+
"m3u8s": ["xxxxxxxxxx", "xxxxxxxxxx"],
397+
"save_as": "hello.m3u8",
398+
"category_id": "5c18bc794e1e8d20dbfcddcc",
399+
"random_file_link": false,
400+
};
401+
Map<String, dynamic> result = await FileManager.videoConcat(params);
402+
// 操作成功
403+
} on HError catch (e) {
404+
// 操作失败
377405
}
378-
Map<String, dynamic>
379406
```
380407

381408
HError 对象结构请参考[错误码和 HError 对象](/flutter-sdk/error-code.md)
@@ -441,6 +468,8 @@ res:
441468
**示例代码**
442469

443470
```Dart
471+
import 'package:minapp/minapp.dart';
472+
444473
try {
445474
Map<String, dynamic> params = {
446475
"m3u8": "xxxxxxxxxx",
@@ -449,14 +478,14 @@ try {
449478
"category_id": "5c18bc794e1e8d20dbfcddcc",
450479
"random_file_link": false
451480
};
452-
Map<String, dynamic> video = FileManager.videoConcat(params);
481+
Map<String, dynamic> video = await FileManager.videoConcat(params);
453482
// 操作成功
454483
} on HError catch(e) {
455484
// 操作失败
456485
}
457486
```
458487

459-
HError 对象结构请参考[错误码和 HError 对象](/js-sdk/error-code.md)
488+
HError 对象结构请参考[错误码和 HError 对象](/flutter-sdk/error-code.md)
460489

461490
**返回示例**
462491

@@ -508,11 +537,13 @@ meta 参数说明：
508537
**示例代码**
509538

510539
```Dart
540+
import 'package:minapp/minapp.dart';
541+
511542
try {
512-
let params = {
543+
Map<String, dynamic> params = {
513544
"m3u8": "xxxxxxxxxx"
514545
};
515-
Map<String, dynamic> meta = FileManager.videoMeta(params);
546+
Map<String, dynamic> meta = await FileManager.videoMeta(params);
516547
// 操作成功
517548
} on HError catch(e) {
518549
// 操作失败
@@ -602,6 +633,8 @@ streams 参数说明：
602633
**示例代码**
603634

604635
```Dart
636+
import 'package:minapp/minapp.dart';
637+
605638
try {
606639
Map<String, dynamic> params = {
607640
"source": "xxxxxxxxxx"

‎flutter-sdk/schema/create-record.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ TableRecordOperationList response = await tableObject.createMany(data);
271271
| total_count | int | 总的待插入记录数 |
272272
| operation_result | List | TableRecordOperation 数组，包含每条数据是否成功被创建等信息 |
273273

274-
TableRecordOperation 类型具体请参考：[数据类型](/flutter-sdk/data-type.md)
274+
TableRecordOperation 类型具体请参考：[数据类型](/flutter-sdk/schema/data-type.md)
275275

276276
err 对象结构请参考[错误码和 HError 对象](/flutter-sdk/error-code.md)
277277

‎flutter-sdk/schema/delete-record.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ try {
6868
}
6969
```
7070

71-
err 对象结构请参考[错误码和 HError 对象](/js-sdk/error-code.md)
71+
err 对象结构请参考[错误码和 HError 对象](/flutter-sdk/error-code.md)
7272

7373
常见错误：
7474

@@ -117,7 +117,7 @@ then 回调中的 res 对象结构如下：
117117
}
118118
```
119119

120-
err 对象结构请参考[错误码和 HError 对象](/js-sdk/error-code.md)
120+
err 对象结构请参考[错误码和 HError 对象](/flutter-sdk/error-code.md)
121121

122122
常见错误：
123123

‎flutter-sdk/schema/get-record-detail.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ try {
4444

4545
**返回结果**
4646

47-
返回 `TableRecord` 示例，详见：[数据类型](/flutter-sdk/data-type.md)
47+
返回 `TableRecord` 示例，详见：[数据类型](/flutter-sdk/schema/data-type.md)
4848

49-
err 对象结构请参考[错误码和 HError 对象](/js-sdk/error-code.md)
49+
err 对象结构请参考[错误码和 HError 对象](/flutter-sdk/error-code.md)
5050

5151
常见错误：
5252

‎flutter-sdk/schema/query.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ query.where(where);
6767
6868
**返回结果**
6969

70-
返回 `TableRecordList` 类型，详见：[数据类型](/flutter-sdk/data-type.md)
70+
返回 `TableRecordList` 类型，详见：[数据类型](/flutter-sdk/schema/data-type.md)
7171

7272
## 示例
7373

@@ -100,9 +100,9 @@ try {
100100

101101
**返回结果**
102102

103-
返回 `TableRecordList` 类型，详见：[数据类型](/flutter-sdk/data-type.md)
103+
返回 `TableRecordList` 类型，详见：[数据类型](/flutter-sdk/schema/data-type.md)
104104

105-
err 对象结构请参考[错误码和 HError 对象](/js-sdk/error-code.md)
105+
err 对象结构请参考[错误码和 HError 对象](/flutter-sdk/error-code.md)
106106

107107
常见错误：
108108

@@ -361,7 +361,7 @@ try {
361361

362362
**返回示例**
363363

364-
返回 `TableRecordList` 类型，详见：[数据类型](/flutter-sdk/data-type.md)
364+
返回 `TableRecordList` 类型，详见：[数据类型](/flutter-sdk/schema/data-type.md)
365365

366366
**不使用 expand 方法的示例**
367367

‎flutter-sdk/schema/update-record.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ tableName 和 tableID 二选一，不能同时存在
3636

3737
2.通过数据行 id（以下用 `recordId` 参数名表示） 设置指定数据行
3838

39-
`TableRecord product = myTableObject.getWithoutData(recordId: recordId)`
39+
`TableRecord product = myTableObject.getWithoutData(recordId: recordId);`
4040

4141
**参数说明**
4242

@@ -56,7 +56,7 @@ a. set 操作
5656

5757
| 参数 | 类型 | 必填 | 说明 |
5858
| :---- | :---------------- | :-- | :-- |
59-
| key | String | 是 | 在数据表中的类型必须是 Number 或 Integer |
59+
| key | String | 是 | 需要更新的字段名 |
6060
| value | any | 是 | 与 key 字段的类型保持一致 |
6161
| obj | Map<String, dynamic> | 是 | 一次性赋值的键值对对象, 如 `{a: 10, b: 20}` |
6262

@@ -70,7 +70,7 @@ b. unset 操作
7070

7171
| 参数 | 类型 | 必填 | 说明 |
7272
| :---- | :---------------- | :-- | :-- |
73-
| key | String | 是 | 在数据表中的类型必须是 Number 或 Integer |
73+
| key | String | 是 | 需要清空的字段名 |
7474
| obj | Map<String, dynamic> | 是 | 一次性赋值的键值对对象, 如 `{a: '', b: ''}` |
7575

7676
set 和 unset 方法都支持两种类型的赋值操作：
@@ -87,8 +87,8 @@ product.set({
8787
b. 逐个赋值：
8888

8989
```dart
90-
product.set(key1, value1)
91-
product.set(key2, value2)
90+
product.set(key1, value1);
91+
product.set(key2, value2);
9292
```
9393

9494
> **info**
@@ -124,9 +124,9 @@ TableRecord response = await record.update();
124124

125125
| 名称 | 类型 | 说明 |
126126
| ---- | ---- | ---- |
127-
| response | TableRecord | 返回 TableRecord 类型，详见 [数据类型](/flutter-sdk/data-type.md) |
127+
| response | TableRecord | 返回 TableRecord 类型，详见 [数据类型](/flutter-sdk/schema/data-type.md) |
128128

129-
err 对象结构请参考[错误码和 HError 对象](/js-sdk/error-code.md)
129+
err 对象结构请参考[错误码和 HError 对象](/flutter-sdk/error-code.md)
130130

131131
常见错误：
132132

@@ -282,7 +282,7 @@ product.uAppend('desc', 'sweet');
282282
| value | List 或 List item | 是 | 如果元素类型是 geojson、object、file，则只能是 List item，或 length 为 1 的 List |
283283

284284
> **info**
285-
> 如果 array 类型字段的子元素类型是 geojson、object 或 file，则 value 只能是 Array item 或 length 为 1 的 Array,
285+
> 如果 array 类型字段的子元素类型是 geojson、object 或 file，则 value 只能是 Array item,
286286
> value 数组中多余的项，将会被忽略。
287287
288288
> 下面的操作是能按预期执行的:
@@ -291,16 +291,12 @@ product.uAppend('desc', 'sweet');
291291
292292
> `product.remove('array_obj', [{a: 10}]);`
293293
294-
> 下面的 `{a: 30}`，将会被忽略:
295-
296-
> `product.remove('array_obj', [{a: 10}, {a: 30}]);`
297-
298294
**请求示例**
299295

300-
```js
301-
product.remove('desc', ['sweet'])
296+
```dart
297+
product.remove('desc', ['sweet']);
302298
// or
303-
product.remove('desc', 'sweet')
299+
product.remove('desc', 'sweet');
304300
```
305301

306302
> **info**
@@ -360,11 +356,11 @@ TableRecordOperationList response = await record.update();
360356
| total_count | int | 总的待插入记录数 |
361357
| operation_result | List | TableRecordOperation 数组，包含每条数据是否成功被创建等信息 |
362358

363-
TableRecordOperation 类型具体请参考：[数据类型](/flutter-sdk/data-type.md)
359+
TableRecordOperation 类型具体请参考：[数据类型](/flutter-sdk/schema/data-type.md)
364360

365361
catch 回调中的 err 对象:
366362

367-
请参考[错误码和 HError 对象](/js-sdk/error-code.md)
363+
请参考[错误码和 HError 对象](/flutter-sdk/error-code.md)
368364

369365
**状态码说明**
370366

‎flutter-sdk/user/auth.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ HError 对象结构请参考[错误码和 HError 对象](/flutter-sdk/error-code
4545
**示例代码**
4646
```Dart
4747
try {
48-
CurrentUser currentUse = await Auth.registerWithUsername(username: "test", password: "111");
48+
CurrentUser currentUser = await Auth.registerWithUsername(username: "test", password: "111");
4949
// 操作成功
5050
} on HError catch(e) {
5151
// 操作成功
@@ -246,7 +246,7 @@ try {
246246
// 1. 发送验证码
247247
await sendSmsCode(phone: "150****7274");
248248
// 2. 手机号 + 验证码登录
249-
Auth.loginWithSmsVerificationCode("150****7274", code: "12345", createUser: true);
249+
Auth.loginWithSmsVerificationCode("150****7274", "12345", createUser: true);
250250
// 操作成功
251251
} on HError catch(e) {
252252
// 操作失败
@@ -299,7 +299,7 @@ HError 对象结构请参考[错误码和 HError 对象](/flutter-sdk/error-code
299299
`Auth.requestPasswordReset(String emial)`
300300

301301
> **info**
302-
> 只有通过验证的邮箱才能使用邮件找回密码功能。
302+
> 只有通过验证的邮箱才能使用邮件找回密码功能。[点此查看邮箱验证](https://doc.minapp.com/flutter-sdk/user/account.html#%E9%82%AE%E7%AE%B1%E9%AA%8C%E8%AF%81)
303303
304304
**示例代码**
305305

0 commit comments

Comments
 (0)