Skip to content

Commit c53e2e8

Browse files
committed
update docs
1 parent 2791229 commit c53e2e8

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

document/API.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ import JMessage from 'jmessage-react-plugin';
2525
- [downloadOriginalUserAvatar](#downloadoriginaluseravatar)
2626

2727
- [群组](#群组)
28+
- [createGroup](#creategroup)
2829
- [addGroupAdmins](#addgroupadmins)
2930
- [removeGroupAdmins](#removegroupadmins)
3031
- [changeGroupType](#changegrouptype)
@@ -372,6 +373,7 @@ JMessage.createGroup({ name: 'group_name', desc: 'group_desc' },
372373
#### 参数说明
373374

374375
- name (string): 群组名。不支持 "\n" 和 "\r" 字符,长度限制为 0 ~ 64 Byte。
376+
- groupType (string): 指定创建群的类型,可以为 'private' 和 'public', 默认为 private。
375377
- desc (string): 群组描述。长度限制为 0 ~ 250 Byte。
376378

377379

index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ export default class JMessage {
425425
* @param {object} params = {
426426
* 'name': String // 群组名称。
427427
* 'desc': String // 群组描述。
428-
* 'groupTyp': String // 'public' | 'private'
428+
* 'groupType': String // 'public' | 'private'
429429
* }
430430
* @param {function} success = function (groupId) {} // 以参数形式返回 group id
431431
* @param {function} error = function ({'code': '错误码', 'description': '错误信息'}) {}

0 commit comments

Comments
 (0)