Skip to content

Commit 20b2709

Browse files
authored
Merge pull request #1106 from haoxiuwen/doc-v2
Unify Programming Languages for Each Client Platform
2 parents a247526 + d9a82d5 commit 20b2709

File tree

419 files changed

+2533
-2533
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

419 files changed

+2533
-2533
lines changed

docs/document/android/connection.md

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

99
你可以通过注册连接监听确认连接状态。
1010

11-
```Java
11+
```java
1212
EMConnectionListener connectionListener = new EMConnectionListener() {
1313
@Override
1414
public void onConnected() {

docs/document/android/conversation_delete.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
示例代码如下:
3030

31-
```Java
31+
```java
3232
//获取指定的会话 ID。
3333
EMConversation conversation = EMClient.getInstance().chatManager().getConversation(conversationId);
3434

@@ -50,12 +50,12 @@ EMClient.getInstance().chatManager().deleteConversationFromServer(conversationId
5050

5151
你可以删除本地会话和历史消息,示例代码如下:
5252

53-
```Java
53+
```java
5454
// 删除指定用户的会话,如果需要保留历史消息,传 `false`。
5555
EMClient.getInstance().chatManager().deleteConversation(conversationId, true);
5656
```
5757

58-
```Java
58+
```java
5959
// 删除指定会话中指定的一条历史消息。
6060
EMConversation conversation = EMClient.getInstance().chatManager().getConversation(conversationId);
6161
conversation.removeMessage(deleteMsg.msgId);

docs/document/android/conversation_list.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838

3939
示例代码如下:
4040

41-
```Java
41+
```java
4242
// limit: 每页返回的会话数。取值范围为 [1,50]。
4343
// cursor: 开始获取数据的游标位置。若获取数据时传 `null` 或者空字符串(""),SDK 从最新活跃的会话开始获取。
4444
int limit = 10;
@@ -69,7 +69,7 @@ EMClient.getInstance().chatManager().asyncFetchConversationsFromServer(limit, cu
6969
若使用该功能,需将 SDK 升级至 4.6.0。
7070
:::
7171

72-
```Java
72+
```java
7373
EMClient.getInstance().chatManager().asyncFilterConversationsFromDB(new EMCustomConversationFilter() {
7474
@Override
7575
public boolean filter(EMConversation emConversation) {
@@ -106,7 +106,7 @@ EMClient.getInstance().chatManager().asyncFilterConversationsFromDB(new EMCustom
106106

107107
示例代码如下:
108108

109-
```Java
109+
```java
110110
List<EMConversation> conversations = EMClient.getInstance().chatManager().getAllConversationsBySort();
111111
```
112112

@@ -126,7 +126,7 @@ SDK 初始化时,你可以设置 `EMOptions#setAutoLoadAllConversations` 方
126126

127127
你可以调用 `cleanConversationsMemoryCache` 方法,清除本地内存中的所有会话,从而释放内存。
128128

129-
```Java
129+
```java
130130
EMClient.getInstance().chatManager().cleanConversationsMemoryCache();
131131
```
132132

@@ -138,7 +138,7 @@ EMClient.getInstance().chatManager().cleanConversationsMemoryCache();
138138
2. 获取会话前清空内存中的会话:调用 `asyncFilterConversationsFromDB` 获取过滤的会话时,将 `cleanConversationsCache` 参数传 `true`
139139
3. 监控到内存较高时(开发者自己实现)释放内存: 调用 `cleanConversationsMemoryCache` 方法清空内存中的会话,释放内存。
140140

141-
```Java
141+
```java
142142
//step 1:SDK 初始化时,关闭自动加载会话开关。
143143
EMOptions options = initChatOptions(context);
144144
options.setAutoLoadAllConversations(false);

docs/document/android/conversation_mark.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
你需要自行维护会话标记与具体业务含义(比如 `MARK_0` 为重要会话)之间的映射关系。例如:
1010

11-
```Java
11+
```java
1212
Map<EMConversation.EMMarkType,String> mapping=new HashMap<>();
1313
mapping.put(EMConversation.EMMarkType.MARK_0,"important");
1414
mapping.put(EMConversation.EMMarkType.MARK_1,"normal");
@@ -48,7 +48,7 @@ mapping.put(EMConversation.EMMarkType.MARK_4,"girls");
4848
对会话添加标记,例如会话标星,并不影响会话的其他逻辑,例如会话的未读消息数。
4949
:::
5050

51-
```Java
51+
```java
5252
String conversationId = "huanhuan";
5353
List<String> ids=new ArrayList<>();
5454
ids.add(conversationId);
@@ -71,7 +71,7 @@ EMClient.getInstance().chatManager().asyncAddConversationMark(ids, EMConversatio
7171

7272
调用该方法会同时移除本地和服务器端会话的标记。
7373

74-
```Java
74+
```java
7575
String conversationId = "huanhuan";
7676
List<String> ids=new ArrayList<>();
7777
ids.add(conversationId);
@@ -92,7 +92,7 @@ EMClient.getInstance().chatManager().asyncRemoveConversationMark(ids, EMConversa
9292

9393
你可以调用 `asyncGetConversationsFromServerWithCursor` 方法根据会话标记从服务器分页获取会话列表。SDK 会按会话标记的时间的倒序返回会话列表,每个会话对象中包含会话 ID、会话类型、是否为置顶状态、置顶时间(对于未置顶的会话,值为 0)、会话标记以及最新一条消息。从服务端拉取会话列表后会更新本地会话列表。
9494

95-
```Java
95+
```java
9696
// 最终的查询结果全部放入 result 中。
9797
List<EMConversation> result=new ArrayList<>();
9898
// cursor:查询的开始位置。若传入空字符串,SDK 从最新标记操作的会话开始获取。
@@ -127,7 +127,7 @@ private void doAsyncGetConversationsFromServerWithCursor(List<EMConversation> re
127127

128128
对于本地会话,你可以调用 `getAllConversations` 方法获取本地所有会话后自己进行会话过滤。下面以查询标记了 `EMConversation.EMMarkType.MARK_0` 的所有本地会话为例。
129129

130-
```Java
130+
```java
131131
//最终的查询结果全部放入 result 中。
132132
List<EMConversation> result=new ArrayList<>();
133133
Map<String, EMConversation> localConversations = EMClient.getInstance().chatManager().getAllConversations();
@@ -149,7 +149,7 @@ if(localConversations!=null&&!localConversations.isEmpty()){
149149

150150
你可以调用 `EMConversation#marks` 方法获取本地单个会话的所有标记,示例代码如下:
151151

152-
```Java
152+
```java
153153
EMConversation conversation = EMClient.getInstance().chatManager().getConversation("conversationId");
154154
Set<EMMarkType> marks = conversation.marks();
155155
```

docs/document/android/conversation_overview.md

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

5454
示例代码如下:
5555

56-
```Java
56+
```java
5757
EMConversationListener listener=new EMConversationListener() {
5858
// 收到会话已读的事件。该事件在以下场景中触发:
5959
// 1. 当消息接收方调用 `ackConversationRead()` 方法,SDK 会执行此回调,

docs/document/android/conversation_pin.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131

3232
示例代码如下:
3333

34-
```Java
34+
```java
3535
EMClient.getInstance().chatManager().asyncPinConversation(conversationId, isPinned, new EMCallBack() {
3636
@Override
3737
public void onSuccess() {
@@ -55,7 +55,7 @@ EMClient.getInstance().chatManager().asyncPinConversation(conversationId, isPinn
5555

5656
示例代码如下:
5757

58-
```Java
58+
```java
5959
// limit: 每页返回的会话数。取值范围为 [1,50]。
6060
// cursor: 开始获取数据的游标位置。若获取数据时传 `null` 或者空字符串(""),SDK 从最新置顶的会话开始查询。
6161
int limit = 10;

docs/document/android/conversation_receipt.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
1. 开启已读回执功能,即 SDK 初始化时设置 `EMOptions#setRequireAck``true`
3131

32-
```Java
32+
```java
3333
// 设置是否需要接受方已读确认,默认为 true
3434
options.setRequireAck(true);
3535
```
@@ -40,7 +40,7 @@ options.setRequireAck(true);
4040

4141
若会话中存在多条未读消息,建议调用该方法,因为若调用发送消息已读回执方法 `ackMessageRead`,则需要调用多次。
4242

43-
```Java
43+
```java
4444
try {
4545
EMClient.getInstance().chatManager().ackConversationRead(conversationId);
4646
} catch (HyphenateException e) {
@@ -56,7 +56,7 @@ try {
5656
对于群组聊天,会话已读回执只用于清空服务端的群组会话的未读数,消息发送方不会通过 `OnConversationRead` 回调收到会话已读回执。
5757
:::
5858

59-
```Java
59+
```java
6060
EMClient.getInstance().chatManager().addConversationListener(new EMConversationListener() {
6161
……
6262
@Override

docs/document/android/conversation_unread.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@
2727

2828
你可以调用 `getUnreadMessageCount` 方法获取本地所有会话的未读消息数量,示例代码如下:
2929

30-
```Java
30+
```java
3131
EMClient.getInstance().chatManager().getUnreadMessageCount();
3232
```
3333

3434
### 获取指定会话的未读消息数
3535

3636
你可以调用 `getUnreadMsgCount` 获取本地指定会话的未读消息数,示例代码如下:
3737

38-
```Java
38+
```java
3939
EMConversation conversation = EMClient.getInstance().chatManager().getConversation(conversationId);
4040
conversation.getUnreadMsgCount();
4141
```
@@ -44,15 +44,15 @@ conversation.getUnreadMsgCount();
4444

4545
你可以调用 `markAllConversationsAsRead` 方法将本地所有会话设为已读,即将所有会话的未读消息数清零,示例代码如下:
4646

47-
```Java
47+
```java
4848
EMClient.getInstance().chatManager().markAllConversationsAsRead();
4949
```
5050

5151
### 指定会话的未读消息数清零
5252

5353
你可以调用 `markAllMessagesAsRead` 方法对指定会话的未读消息数清零,示例代码如下:
5454

55-
```Java
55+
```java
5656
EMConversation conversation = EMClient.getInstance().chatManager().getConversation(conversationId);
5757
conversation.markAllMessagesAsRead();
5858
```
@@ -61,7 +61,7 @@ conversation.markAllMessagesAsRead();
6161

6262
你可以调用 `markMessageAsRead` 方法将指定会话的单条未读消息置为已读。
6363

64-
```Java
64+
```java
6565
EMConversation conversation = EMClient.getInstance().chatManager().getConversation(conversationId);
6666
conversation.markMessageAsRead(messageId);
6767
```

docs/document/android/easecallkit.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ implementation 'io.agora.rtc:full-sdk:3.8.0'
128128

129129
在环信 IM SDK 初始化完成后,可以开始初始化 `EaseCallKit`,同时增加监听回调,设置常用配置项。代码如下:
130130

131-
```Java
131+
```java
132132
//初始化 `EaseCallUIKit`。
133133
EaseCallKitConfig callKitConfig = new EaseCallKitConfig();
134134
//设置默认头像。
@@ -150,7 +150,7 @@ addCallkitListener();
150150

151151
可设置的配置项包括以下内容:
152152

153-
```Java
153+
```java
154154
/**
155155
* EaseCallKit 相关的用户配置选项。
156156
* defaultHeadImage 用户默认头像。该参数的值为本地文件绝对路径或者 URL。
@@ -178,7 +178,7 @@ public class EaseCallKitConfig {
178178

179179
一对一通话可分为视频通话和语音通话,接口如下所示:
180180

181-
```Java
181+
```java
182182
/**
183183
* 发起一对一通话。
184184
* @param type 通话类型。该参数只能设置为 `SIGNAL_VOICE_CALL` 或 `SIGNAL_VIDEO_CALL`。
@@ -192,7 +192,7 @@ public void startSingleCall(final EaseCallType type, final String user,final St
192192

193193
你可以从群组成员列表或者好友列表中选择,发起多人音视频邀请,具体实现可参考 demo 中的 `ConferenceInviteActivity`。
194194

195-
```Java
195+
```java
196196
/**
197197
* 邀请用户加入多人通话。
198198
* @param users 用户 ID 列表,即环信 ID 列表。
@@ -211,7 +211,7 @@ public void startInviteMultipleCall(final String[] users,final String ext){}
211211

212212
被叫收到邀请后会触发 `EaseCallKitListener` 中的 `onRevivedCall` 回调:
213213

214-
```Java
214+
```java
215215
/**
216216
* 收到通话邀请回调。
217217
* @param callType 通话类型。
@@ -229,7 +229,7 @@ void onRevivedCall(EaseCallType callType, String userId,String ext){}
229229

230230
多人通话中,当前用户可以点击通话界面右上角的邀请按钮再次向其他用户发起邀请。这种情况下,会触发 `EaseCallKitListener` 中的 `onInviteUsers` 回调:
231231

232-
```Java
232+
```java
233233
/**
234234
* 邀请好友进行多人通话。
235235
* @param context 通话上下文。
@@ -244,7 +244,7 @@ public void onInviteUsers(Context context,String userId[],String ext) {
244244

245245
用户加入通话后,当前用户以及其他与会者会收到 `EaseCallKitListener` 中的 `onRemoteUserJoinChannel` 回调。该接口自从 SDK 3.8.1 新增。
246246

247-
```Java
247+
```java
248248
@Override
249249
public void onRemoteUserJoinChannel(String channelName, String userName, int uid, EaseGetUserAccountCallback callback){
250250
//此时,可以获取当前频道中已有用户的声网 ID 与环信 ID 的映射表,并将映射表设置到 `EaseCallKit`,同时也可以更新用户的头像和昵称。
@@ -256,7 +256,7 @@ public void onRemoteUserJoinChannel(String channelName, String userName, int uid
256256

257257
在一对一音视频通话中,若其中一方挂断,双方的通话会自动结束,而多人音视频通话中需要主动挂断才能结束通话。通话结束后,会触发 `onEndCallWithReason` 回调:
258258

259-
```Java
259+
```java
260260
/**
261261
* 通话结束回调。
262262
* @param callType 通话类型。
@@ -285,7 +285,7 @@ public enum EaseCallEndReason {
285285

286286
通话过程中如果有异常或者错误发生,会触发 `EaseCallKitListener` 中的 `onCallError` 回调:
287287

288-
```Java
288+
```java
289289
/**
290290
* 通话异常回调。
291291
* @param type 错误类型。
@@ -297,7 +297,7 @@ void onCallError(EaseCallKit.EaseCallError type, int errorCode, String descripti
297297

298298
`EaseCallError` 异常包括业务逻辑异常、音视频异常以及 Easemob IM 异常。
299299

300-
```Java
300+
```java
301301
/**
302302
* 通话错误类型。
303303
*
@@ -313,7 +313,7 @@ public enum EaseCallError{
313313

314314
`EaseCallKit` 库初始化之后,可修改有关配置,接口和示例如下:
315315

316-
```Java
316+
```java
317317
/**
318318
* 获取当前 `EaseCallKit` 的配置。
319319
*
@@ -332,7 +332,7 @@ if(config != null){
332332

333333
自 `EaseCallKit` 3.8.1 开始,新增了修改头像昵称的接口,用户可以在加入频道后,修改自己和通话中其他人的头像昵称,修改方法如下:
334334

335-
```Java
335+
```java
336336
@Override
337337
public void onRemoteUserJoinChannel(String channelName, String userName, int uid, EaseGetUserAccountCallback callback){
338338
if(userName == null || userName == ""){
@@ -359,7 +359,7 @@ CallKit 4.8.2 及更高版本支持私有化部署,包括初始化和初测监
359359

360360
配置私有化 AgoraAppId。其他可配置的选项,详见本文档中的[初始化](https://doc.easemob.com/document/android/easecallkit.html#初始化)一节。
361361

362-
```Kotlin
362+
```kotlin
363363
EaseCallKitConfig().apply {
364364
……
365365
agoraAppId = "2d4f114e22304cee8d31ae909f3289d2"
@@ -372,7 +372,7 @@ EaseCallKitConfig().apply {
372372

373373
监听 `com.hyphenate.easecallkit.base.EaseCallKitListener#onRtcEngineCreated` 事件,在 RTC 引擎创建的回调里进行私有化配置。详见 [API 参考](https://doc.shengwang.cn/api-ref/rtc/android/API/toc_network#api_irtcengine_setlocalaccesspoint)。
374374

375-
```Kotlin
375+
```kotlin
376376
private val callKitListener by lazy { object :EaseCallKitListener {
377377
……
378378

@@ -401,7 +401,7 @@ EaseCallKit.getInstance().setCallKitListener(callKitListener)
401401

402402
如果不需要鉴权,可以直接回调 token 为 `null`,或者在设置 `callKitConfig.setEnableRTCToken(false)` 的前提下不实现该回调, 具体接口和使用如下:
403403

404-
```Java
404+
```java
405405
/**
406406
* 用户生成 token 回调。
407407
* @param userId 用户 ID,即用户的环信 ID。
@@ -429,7 +429,7 @@ public void onGenerateToken(String userId, String channelName, String agoraAppId
429429

430430
EaseCallKit 3.8.1 版本开始,`EaseCallKitTokenCallback` 中的 `onSetToken` 方法添加了 `uid` 参数,你可以使用数字 uid 加入声网频道。
431431

432-
```Java
432+
```java
433433
void onSetToken(String token, int uId);
434434
```
435435

0 commit comments

Comments
 (0)