Skip to content

Commit d39aaef

Browse files
authored
Merge pull request #94 from haoxiuwen/doc-shengwang
Modify IM Docs
2 parents ba08a38 + 21130af commit d39aaef

File tree

16 files changed

+30
-25
lines changed

16 files changed

+30
-25
lines changed

docs/docs/sdk/android/limitation.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,6 @@
8585

8686
### 置顶消息
8787

88-
- 该功能只支持群组和聊天室会话,不支持单聊。
8988
- 单个会话默认可置顶 20 条消息。你可以联系声网商务提升该上限,最大可调整至 100。
9089

9190
### 消息仅投递在线用户

docs/docs/sdk/android/login.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,10 @@ ChatClient.getInstance().login(mAccount, mPassword, new CallBack() {
7979

8080
初始化时,你可以设置 `ChatOptions#setAutoLogin` 选项确定是否自动登录。如果设置为自动登录,则登录成功之后,后续初始化 SDK 时会自动登录。
8181

82+
自动登录期限默认为 30 天,即设置自动登录后,用户 30 天内可自动登录。若调整改期限,可联系环信商务。
83+
84+
不过,自动登录还取决于你设置的用户 token 或密码有效期,例如,用户 token 有效期为 24 小时,则用户在 24 小时后,需获取 token 重新登录。
85+
8286
## 获取当前登录的用户
8387

8488
你可以调用 `ChatClient#getCurrentUser` 方法获取当前登录用户的用户 ID。

docs/docs/sdk/android/message_send_receive.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -501,9 +501,7 @@ ChatClient.getInstance().chatManager().sendMessage(message);
501501

502502
## 使用消息扩展字段
503503

504-
当 SDK 提供的消息类型不满足需求时,你可以通过消息扩展字段传递自定义的内容,从而生成自己需要的消息类型。
505-
506-
当目前消息类型不满足用户需求时,可以在扩展部分保存更多信息,例如消息中需要携带被回复的消息内容或者是图文消息等场景。
504+
当 SDK 提供的消息类型不满足需求时,你可以通过消息扩展字段传递自定义的内容,从而生成自己需要的消息类型,例如,消息中需要携带被回复的消息内容或者是图文消息等场景。
507505

508506
```java
509507
ChatMessage message = ChatMessage.createTxtSendMessage(content, toChatUsername);

docs/docs/sdk/flutter/login.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ try {
5858

5959
初始化时,你可以设置 `ChatOptions#autoLogin` 选项确定是否自动登录。如果设置为自动登录,则登录成功之后,后续初始化 SDK 时会自动登录。
6060

61+
自动登录期限默认为 30 天,即设置自动登录后,用户 30 天内可自动登录。若调整改期限,可联系环信商务。
62+
63+
不过,自动登录还取决于你设置的用户 token 或密码有效期,例如,用户 token 有效期为 24 小时,则用户在 24 小时后,需获取 token 重新登录。
64+
6165
## 获取当前登录的用户
6266

6367
你可以调用 `ChatClient#currentUserId` 方法获取当前登录用户的用户 ID。

docs/docs/sdk/flutter/message_send_receive.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -501,9 +501,7 @@ ChatClient.getInstance.chatManager.sendMessage(msg);
501501

502502
## 使用消息扩展字段
503503

504-
当 SDK 提供的消息类型不满足需求时,你可以通过消息扩展字段传递自定义的内容,从而生成自己需要的消息类型。
505-
506-
当目前消息类型不满足用户需求时,可以在扩展部分保存更多信息,例如消息中需要携带被回复的消息内容或者是图文消息等场景。
504+
当 SDK 提供的消息类型不满足需求时,你可以通过消息扩展字段传递自定义的内容,从而生成自己需要的消息类型,例如,消息中需要携带被回复的消息内容或者是图文消息等场景。
507505

508506
```dart
509507
try {

docs/docs/sdk/harmonyos/login.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@ ChatClient.getInstance().login(userId, pwd).then(() => {
6262

6363
初始化时,你可以设置 `ChatOptions#setAutoLogin` 选项确定是否自动登录。如果设置为自动登录,则登录成功之后,后续初始化 SDK 时会自动登录。
6464

65+
自动登录期限默认为 30 天,即设置自动登录后,用户 30 天内可自动登录。若调整改期限,可联系环信商务。
66+
67+
不过,自动登录还取决于你设置的用户 token 或密码有效期,例如,用户 token 有效期为 24 小时,则用户在 24 小时后,需获取 token 重新登录。
68+
6569
## 获取当前登录的用户
6670

6771
你可以调用 `ChatClient#getCurrentUser` 方法获取当前登录用户的用户 ID。

docs/docs/sdk/harmonyos/message_send_receive.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -480,9 +480,7 @@ ChatClient.getInstance().chatManager()?.sendMessage(message);
480480

481481
## 使用消息扩展字段
482482

483-
当 SDK 提供的消息类型不满足需求时,你可以通过消息扩展字段传递自定义的内容,从而生成自己需要的消息类型。
484-
485-
当目前消息类型不满足用户需求时,可以在扩展部分保存更多信息,例如,消息中需要携带被回复的消息内容或者是图文消息等场景。
483+
当 SDK 提供的消息类型不满足需求时,你可以通过消息扩展字段传递自定义的内容,从而生成自己需要的消息类型,例如,消息中需要携带被回复的消息内容或者是图文消息等场景。
486484

487485
```typescript
488486
let message = ChatMessage.createTxtSendMessage(toChatUsername, content);

docs/docs/sdk/ios/login.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@
7676
}
7777
```
7878
79+
自动登录期限默认为 30 天,即设置自动登录后,用户 30 天内可自动登录。若调整改期限,可联系环信商务。
80+
81+
不过,自动登录还取决于你设置的用户 token 或密码有效期,例如,用户 token 有效期为 24 小时,则用户在 24 小时后,需获取 token 重新登录。
82+
7983
## 获取当前登录的用户
8084
8185
你可以调用 `AgoraChatClient.shared().currentUsername` 方法获取当前登录用户的用户 ID。

docs/docs/sdk/ios/message_send_receive.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -428,9 +428,7 @@ msg.receiverList = @[@"A",@"B"];
428428
429429
## 使用消息扩展字段
430430
431-
当 SDK 提供的消息类型不满足需求时,你可以通过消息扩展字段来传递自定义的内容,从而生成自己需要的消息类型。
432-
433-
当目前消息类型不满足用户需求时,可以在扩展部分保存更多信息,例如消息中需要携带被回复的消息内容或者是图文消息等场景。
431+
当 SDK 提供的消息类型不满足需求时,你可以通过消息扩展字段来传递自定义的内容,从而生成自己需要的消息类型,例如,消息中需要携带被回复的消息内容或者是图文消息等场景。
434432
435433
```objectivec
436434
AgoraChatTextMessageBody *textMessageBody = [[AgoraChatTextMessageBody alloc] initWithText:content];

docs/docs/sdk/react-native/login.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ ChatClient.getInstance()
5656

5757
初始化时,你可以设置 `ChatOptions#autoLogin` 选项确定是否自动登录。如果设置为自动登录,则登录成功之后,后续初始化 SDK 时会自动登录。
5858

59+
自动登录期限默认为 30 天,即设置自动登录后,用户 30 天内可自动登录。若调整改期限,可联系环信商务。
60+
61+
不过,自动登录还取决于你设置的用户 token 或密码有效期,例如,用户 token 有效期为 24 小时,则用户在 24 小时后,需获取 token 重新登录。
62+
5963
## 获取当前登录的用户
6064

6165
你可以调用 `ChatClient#getCurrentUsername` 方法获取当前登录用户的用户 ID。

0 commit comments

Comments
 (0)