Skip to content

Commit 7489182

Browse files
committed
udpate docs
1 parent 75032a7 commit 7489182

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

document/API.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ import JMessage from 'jmessage-react-plugin';
2121
- [updateMyPassword](#updatemypassword)
2222
- [updateMyAvatar](#updatemyavatar)
2323
- [updateMyInfo](#updatemyinfo)
24+
- [downloadThumbUserAvatar](#downloadthumbuseravatar)
25+
- [downloadOriginalUserAvatar](#downloadoriginaluseravatar)
2426
- [聊天](#聊天)
2527
- [createSendMessage](#createsendmessage)
2628
- [sendMessage](#sendmessage)
@@ -276,6 +278,54 @@ JMessage.updateMyInfo({ nickname: 'nickname' },
276278
- gender: 必须为 'male', 'female' 和 'unknown' 中的一种。
277279
- 其余都为 `string` 类型,支持全部字符串;长度限制为 Byte (0~250)。
278280

281+
### downloadThumbUserAvatar
282+
283+
下载用户头像缩略图。
284+
285+
#### 示例
286+
287+
```javascript
288+
const param = {
289+
username: 'theUserName'
290+
appKey: 'you appKey'
291+
}
292+
JMessage.downloadThumbUserAvatar(param, (result) => {}, (err) => {})
293+
```
294+
295+
#### 参数说明:
296+
297+
- param (object):
298+
- username (string): 用户名
299+
- appKey (string):
300+
- result (object):
301+
- username (string): 用户名
302+
- appKey (string):
303+
- filePath (string): 下载后的图片路径
304+
305+
### downloadOriginalUserAvatar
306+
307+
下载用户头像原图。
308+
309+
#### 示例
310+
311+
```javascript
312+
const param = {
313+
username: 'theUserName'
314+
appKey: 'you appKey'
315+
}
316+
JMessage.downloadThumbUserAvatar(param, (result) => {}, (err) => {})
317+
```
318+
319+
#### 参数说明:
320+
321+
- param (object):
322+
- username (string): 用户名
323+
- appKey (string):
324+
- result (object):
325+
- username (string): 用户名
326+
- appKey (string):
327+
- filePath (string): 下载后的图片路径
328+
279329
## 群组
280330

281331
### createGroup

0 commit comments

Comments
 (0)