Skip to content

Commit

Permalink
Merge pull request #535 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Modify Format Client API of Getting Contacts
  • Loading branch information
haoxiuwen authored Dec 7, 2023
2 parents 1ddc6ed + aa68a97 commit 27ef78f
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 14 deletions.
17 changes: 8 additions & 9 deletions docs/document/android/user_relationship.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ EMClient.getInstance().contactManager().asyncSetContactRemark(userId, remark, ne

自 4.2.1 版本开始,你可以调用 `asyncFetchAllContactsFromServer` 方法从服务器一次性或分页获取好友列表,其中每个好友对象包含好友的用户 ID 和好友备注。

- 一次性从服务端获取整个好友列表
- 一次性获取服务端好友列表

```java
EMClient.getInstance().contactManager().asyncFetchAllContactsFromServer(new EMValueCallBack<List<EMContact>>() {
Expand All @@ -145,7 +145,7 @@ EMClient.getInstance().contactManager().asyncFetchAllContactsFromServer(new EMVa
});
```

- 从服务端分页获取好友列表
- 分页获取服务端好友列表

```java
// limit 的取值范围为 [1,50]
Expand Down Expand Up @@ -178,20 +178,19 @@ private void doAsyncFetchAllContactsFromServer(List<EMContact> contacts, String
此外,你也可以调用 `getAllContactsFromServer` 方法从服务器获取所有好友的列表,该列表只包含好友的用户 ID

```java
// 从服务器获取好友列表。
// 同步方法,会阻塞当前线程。异步方法为 asyncGetAllContactsFromServer(EMValueCallBack)。
List<String> usernames = EMClient.getInstance().contactManager().getAllContactsFromServer();
```

##### **从本地获取好友列表**

4.2.1 版本开始,你可以调用 `asyncFetchAllContactsFromServer` 方法从本地获取单个好友的用户 ID 和好友备注;你也可以调用 `asyncFetchAllContactsFromLocal` 方法一次性获取整个好友列表,其中每个好友对象包含好友的用户 ID 和好友备注。
4.2.1 版本开始,你可以调用 `asyncFetchAllContactsFromServer` 方法从本地获取单个好友的用户 ID 和好友备注;你也可以调用 `asyncFetchAllContactsFromLocal` 方法一次性获取整个好友列表,其中每个好友对象包含好友的用户 ID 和好友备注。

:::notice
需要从服务器获取好友列表之后,才能从本地获取到好友列表。
:::
:::notice
需要从服务器获取好友列表之后,才能从本地获取到好友列表。
:::

- 从本地获取单个好友
- 获取本地单个好友

```java
try {
Expand All @@ -204,7 +203,7 @@ try {
};
```

- 一次性从本地获取整个好友列表
- 一次性获取本地好友列表

```java
EMClient.getInstance().contactManager().asyncFetchAllContactsFromLocal(new EMValueCallBack<List<EMContact>>() {
Expand Down
8 changes: 4 additions & 4 deletions docs/document/ios/user_relationship.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ if (!aError) {
自 4.2.0 版本开始,你可以调用 `getAllContactsFromServerWithCompletion` 或 `getContactsFromServerWithCursor` 方法从服务器一次性或分页获取好友列表,其中每个好友对象包含好友的用户 ID 和好友备注。
- 一次性从服务端获取整个好友列表
- 一次性获取服务端的好友列表
```objectivec
//一次性从服务端获取整个好友列表
Expand All @@ -165,7 +165,7 @@ if (!aError) {
}];
```

- 从服务端分页获取好友列表
- 分页获取服务端的好友列表

```objectivec
//pageSize 的取值范围为 [1,50]
Expand Down Expand Up @@ -196,13 +196,13 @@ if (!aError) {

自 4.2.0 版本开始,你可以调用 `getContact` 方法从本地获取单个好友的用户 ID 和好友备注;你也可以调用 `getAllContacts` 方法一次性获取整个好友列表,其中每个好友对象包含好友的用户 ID 和好友备注。

- 从本地获取单个好友
- 获取本地单个好友

```objectivec
EMContact* contact = [EMClient.sharedClient.contactManager getContact:@"userId"];
```
- 一次性从本地获取整个好友列表
- 一次性获取本地好友列表
```objectivec
NSArray<EMContact*>* contacts = [EMClient.sharedClient.contactManager getAllContacts];
Expand Down
2 changes: 1 addition & 1 deletion docs/document/web/user_relationship.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ conn

4.3.0 版本,你可以调用 `getAllContacts``getContactsWithCursor` 方法一次性或分页获取好友列表,其中每个好友对象包含好友的用户 ID 和好友备注。

- 一次性获取全部好友列表
- 一次性获取好友列表

```javascript
conn
Expand Down

0 comments on commit 27ef78f

Please sign in to comment.