Skip to content

Commit 5cca192

Browse files
mo3etmo3et
authored
docs: update class and callback references path in docs. (#154)
* feat: add start cn docs scripts. * docs: Update class and callback references path to relation in CN docs. * docs: Update class and callback references path to relation in EN docs * docs: Update class, enum, and listener category labels in EN docs * refactor: Update start script for Chinese documentation
1 parent 0113072 commit 5cca192

95 files changed

Lines changed: 292 additions & 291 deletions

File tree

Some content is hidden

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

‎docs/sdks/api/friend/index.mdx‎

Lines changed: 0 additions & 34 deletions
This file was deleted.

‎docs/sdks/api/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ toc_max_heading_level: 2
1818
| -------------------------------------------------------- | ---------------------- |
1919
| [初始化及登录](docs/sdks/api/initialization/index.mdx) | 初始化等基础相关 |
2020
| [用户](docs/sdks/api/user/index.mdx) | 用户相关 |
21-
| [关系链](docs/sdks/api/friend/index.mdx) | 关系链相关 |
21+
| [关系链](docs/sdks/api/relation/index.mdx) | 关系链相关 |
2222
| [群组](docs/sdks/api/group/index.mdx) | 群组相关 |
2323
| [会话](docs/sdks/api/conversation/index.mdx) | 会话相关 |
2424
| [消息](docs/sdks/api/message/index.mdx) | 消息相关 |

docs/sdks/api/friend/acceptFriendApplication.mdx renamed to docs/sdks/api/relation/acceptFriendApplication.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ public static void AcceptFriendApplication(OnSucOrError cb, ProcessFriendApplica
302302
| 参数名称 | 参数类型 | 是否必填 | 描述 |
303303
| -------- | --------------------------------------- | -------- | -------- |
304304
| cb | [OnSucOrError](docs/sdks/callback/OnSucOrError.mdx) | 是 | 回调接口 |
305-
| userIDHandleMsg | [ProcessFriendApplicationParams](docs/sdks/class/friend/ProcessFriendApplicationParams.mdx) | 是 | 用户 ID |
305+
| userIDHandleMsg | [ProcessFriendApplicationParams](docs/sdks/class/relation/ProcessFriendApplicationParams.mdx) | 是 | 用户 ID |
306306

307307
### 返回结果
308308

docs/sdks/api/friend/addBlack.mdx renamed to docs/sdks/api/relation/addBlack.mdx

File renamed without changes.

docs/sdks/api/friend/addFriend.mdx renamed to docs/sdks/api/relation/addFriend.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ public static void AddFriend(OnSucOrError cb, ApplyToAddFriendReq userIDReqMsg)
298298
| 参数名称 | 参数类型 | 是否必填 | 描述 |
299299
| ---------- | --------------------------------------- | -------- | ---------------------------- |
300300
| cb | [OnSucOrError](docs/sdks/callback/OnSucOrError.mdx) | 是 | 回调接口 |
301-
| userIDReqMsg | [ApplyToAddFriendReq](docs/sdks/class/friend/ApplyToAddFriendReq.mdx) | 是 | 添加好友参数 |
301+
| userIDReqMsg | [ApplyToAddFriendReq](docs/sdks/class/relation/ApplyToAddFriendReq.mdx) | 是 | 添加好友参数 |
302302

303303
### 返回结果
304304

docs/sdks/api/friend/checkFriend.mdx renamed to docs/sdks/api/relation/checkFriend.mdx

File renamed without changes.

docs/sdks/api/friend/deleteFriend.mdx renamed to docs/sdks/api/relation/deleteFriend.mdx

File renamed without changes.

docs/sdks/api/friend/getBlackList.mdx renamed to docs/sdks/api/relation/getBlackList.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ values={[
4444

4545
| 参数名称 | 参数类型 | 描述 |
4646
| -------- | --------------------------------------------------- | -------- |
47-
| ~ | List<[BlacklistInfo](docs/sdks/class/friend/blackInfo.mdx)> | 成功返回 |
47+
| ~ | List<[BlacklistInfo](docs/sdks/class/relation/blackInfo.mdx)> | 成功返回 |
4848

4949
### 代码示例
5050

@@ -74,7 +74,7 @@ values={[
7474

7575
| 参数名称 | 参数类型 | 描述 |
7676
| --------- | ------------------------------------------------------------------ | -------- |
77-
| onSuccess | NSArray< [OIMBlackInfo](docs/sdks/class/friend/blackInfo.mdx) \* > | 成功返回 |
77+
| onSuccess | NSArray< [OIMBlackInfo](docs/sdks/class/relation/blackInfo.mdx) \* > | 成功返回 |
7878
| onFailure | OIMFailureCallback | 失败返回 |
7979

8080
### 代码示例
@@ -133,7 +133,7 @@ IMSDK.getBlacklist(operationID?: string): Promise<WsResponse<BlackUserItem[]>>
133133

134134
| 参数名称 | 参数类型 | 描述 |
135135
| --------------- | ----------------------------------------------------------------------------- | ------------------ |
136-
| Promise.then() | Promise<WsResponse<[BlackUserItem](docs/sdks/class/friend/blackInfo.mdx)[]>\> | 黑名单信息对象列表 |
136+
| Promise.then() | Promise<WsResponse<[BlackUserItem](docs/sdks/class/relation/blackInfo.mdx)[]>\> | 黑名单信息对象列表 |
137137
| Promise.catch() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
138138

139139
### 代码示例
@@ -181,7 +181,7 @@ IMSDK.asyncApi('getBlacklist', operationID: string): Promise<BlackUserItem[]>
181181
182182
| 参数名称 | 参数类型 | 描述 |
183183
| --------------- | ----------------------------------------------------------------- | ------------------ |
184-
| Promise.then() | Promise<[BlackUserItem](docs/sdks/class/friend/blackInfo.mdx)[]\> | 黑名单信息对象列表 |
184+
| Promise.then() | Promise<[BlackUserItem](docs/sdks/class/relation/blackInfo.mdx)[]\> | 黑名单信息对象列表 |
185185
| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
186186

187187
### 代码示例
@@ -217,7 +217,7 @@ OpenIMSDKRN.getBlackList(operationID: string): Promise<BlackUserItem[]>
217217

218218
| 参数名称 | 参数类型 | 描述 |
219219
| --------------- | ----------------------------------------------------------------- | ------------------ |
220-
| Promise.then() | Promise<[BlackUserItem](docs/sdks/class/friend/blackInfo.mdx)[]\> | 黑名单信息对象列表 |
220+
| Promise.then() | Promise<[BlackUserItem](docs/sdks/class/relation/blackInfo.mdx)[]\> | 黑名单信息对象列表 |
221221
| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
222222

223223
### 代码示例

docs/sdks/api/friend/getFriendApplicationListAsApplicant.mdx renamed to docs/sdks/api/relation/getFriendApplicationListAsApplicant.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ values={[
4444

4545
| 参数名称 | 参数类型 | 描述 |
4646
| -------- | --------------------------------------------------------------------------- | -------- |
47-
| ~ | List<[FriendApplicationInfo](docs/sdks/class/friend/friendApplication.mdx)> | 成功返回 |
47+
| ~ | List<[FriendApplicationInfo](docs/sdks/class/relation/friendApplication.mdx)> | 成功返回 |
4848

4949
### 代码示例
5050

@@ -74,7 +74,7 @@ values={[
7474

7575
| 参数名称 | 参数类型 | 描述 |
7676
| --------- | ---------------------------------------------------------------------------------- | -------- |
77-
| onSuccess | NSArray< [OIMFriendApplication](docs/sdks/class/friend/friendApplication.mdx) \* > | 成功返回 |
77+
| onSuccess | NSArray< [OIMFriendApplication](docs/sdks/class/relation/friendApplication.mdx) \* > | 成功返回 |
7878
| onFailure | OIMFailureCallback | 失败返回 |
7979

8080
### 代码示例
@@ -103,7 +103,7 @@ public void getSendFriendApplicationList(OnBase<List<FriendApplicationInfo>> cal
103103

104104
| 参数名称 | 参数类型 | 是否必填 | 描述 |
105105
| -------- | -------------------------------------------------------------------------------------------------------------------- | -------- | -------- |
106-
| callBack | [OnBase](docs/sdks/callback/onBase.mdx)<List<[FriendApplicationInfo](docs/sdks/class/friend/friendApplication.mdx)>> | 是 | 回调接口 |
106+
| callBack | [OnBase](docs/sdks/callback/onBase.mdx)<List<[FriendApplicationInfo](docs/sdks/class/relation/friendApplication.mdx)>> | 是 | 回调接口 |
107107

108108
### 返回结果
109109

@@ -133,7 +133,7 @@ IMSDK.getFriendApplicationListAsApplicant(operationID?: string): Promise<WsRespo
133133

134134
| 参数名称 | 参数类型 | 描述 |
135135
| --------------- | --------------------------------------------------------------------------------------------- | ------------------ |
136-
| Promise.then() | Promise<WsResponse<[FriendApplicationItem](docs/sdks/class/friend/friendApplication.mdx)[]>\> | 发出的好友请求列表 |
136+
| Promise.then() | Promise<WsResponse<[FriendApplicationItem](docs/sdks/class/relation/friendApplication.mdx)[]>\> | 发出的好友请求列表 |
137137
| Promise.catch() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
138138

139139
### 代码示例
@@ -181,7 +181,7 @@ IMSDK.asyncApi('getFriendApplicationListAsApplicant', operationID: string): Prom
181181
182182
| 参数名称 | 参数类型 | 描述 |
183183
| --------------- | --------------------------------------------------------------------------------- | ------------------ |
184-
| Promise.then() | Promise<[FriendApplicationItem](docs/sdks/class/friend/friendApplication.mdx)[]\> | 发出的好友请求列表 |
184+
| Promise.then() | Promise<[FriendApplicationItem](docs/sdks/class/relation/friendApplication.mdx)[]\> | 发出的好友请求列表 |
185185
| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
186186

187187
### 代码示例
@@ -217,7 +217,7 @@ OpenIMSDKRN.getFriendApplicationListAsApplicant(operationID: string): Promise<Fr
217217

218218
| 参数名称 | 参数类型 | 描述 |
219219
| --------------- | --------------------------------------------------------------------------------- | ------------------ |
220-
| Promise.then() | Promise<[FriendApplicationItem](docs/sdks/class/friend/friendApplication.mdx)[]\> | 发出的好友请求列表 |
220+
| Promise.then() | Promise<[FriendApplicationItem](docs/sdks/class/relation/friendApplication.mdx)[]\> | 发出的好友请求列表 |
221221
| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
222222

223223
### 代码示例

docs/sdks/api/friend/getFriendApplicationListAsRecipient.mdx renamed to docs/sdks/api/relation/getFriendApplicationListAsRecipient.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ values={[
4444

4545
| 参数名称 | 参数类型 | 描述 |
4646
| -------- | --------------------------------------------------------------------------- | -------- |
47-
| ~ | List<[FriendApplicationInfo](docs/sdks/class/friend/friendApplication.mdx)> | 成功返回 |
47+
| ~ | List<[FriendApplicationInfo](docs/sdks/class/relation/friendApplication.mdx)> | 成功返回 |
4848

4949
### 代码示例
5050

@@ -74,7 +74,7 @@ values={[
7474

7575
| 参数名称 | 参数类型 | 描述 |
7676
| --------- | ---------------------------------------------------------------------------------- | -------- |
77-
| onSuccess | NSArray< [OIMFriendApplication](docs/sdks/class/friend/friendApplication.mdx) \* > | 成功返回 |
77+
| onSuccess | NSArray< [OIMFriendApplication](docs/sdks/class/relation/friendApplication.mdx) \* > | 成功返回 |
7878
| onFailure | OIMFailureCallback | 失败返回 |
7979

8080
### 代码示例
@@ -103,7 +103,7 @@ public void getRecvFriendApplicationList(OnBase<List<FriendApplicationInfo>> cal
103103

104104
| 参数名称 | 参数类型 | 是否必填 | 描述 |
105105
| -------- | -------------------------------------------------------------------------------------------------------------------- | -------- | -------- |
106-
| callBack | [OnBase](docs/sdks/callback/onBase.mdx)<List<[FriendApplicationInfo](docs/sdks/class/friend/friendApplication.mdx)>> | 是 | 回调接口 |
106+
| callBack | [OnBase](docs/sdks/callback/onBase.mdx)<List<[FriendApplicationInfo](docs/sdks/class/relation/friendApplication.mdx)>> | 是 | 回调接口 |
107107

108108
### 返回结果
109109

@@ -133,7 +133,7 @@ IMSDK.getFriendApplicationListAsRecipient(operationID?: string): Promise<WsRespo
133133

134134
| 参数名称 | 参数类型 | 描述 |
135135
| --------------- | --------------------------------------------------------------------------------------------- | ------------------ |
136-
| Promise.then() | Promise<WsResponse<[FriendApplicationItem](docs/sdks/class/friend/friendApplication.mdx)[]>\> | 收到的好友请求列表 |
136+
| Promise.then() | Promise<WsResponse<[FriendApplicationItem](docs/sdks/class/relation/friendApplication.mdx)[]>\> | 收到的好友请求列表 |
137137
| Promise.catch() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
138138

139139
### 代码示例
@@ -181,7 +181,7 @@ IMSDK.asyncApi('getFriendApplicationListAsRecipient', operationID: string): Prom
181181
182182
| 参数名称 | 参数类型 | 描述 |
183183
| --------------- | --------------------------------------------------------------------------------- | ------------------ |
184-
| Promise.then() | Promise<[FriendApplicationItem](docs/sdks/class/friend/friendApplication.mdx)[]\> | 收到的好友请求列表 |
184+
| Promise.then() | Promise<[FriendApplicationItem](docs/sdks/class/relation/friendApplication.mdx)[]\> | 收到的好友请求列表 |
185185
| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
186186

187187
### 代码示例
@@ -217,7 +217,7 @@ OpenIMSDKRN.getFriendApplicationListAsRecipient(operationID: string): Promise<Fr
217217

218218
| 参数名称 | 参数类型 | 描述 |
219219
| --------------- | --------------------------------------------------------------------------------- | ------------------ |
220-
| Promise.then() | Promise<[FriendApplicationItem](docs/sdks/class/friend/friendApplication.mdx)[]\> | 收到的好友请求列表 |
220+
| Promise.then() | Promise<[FriendApplicationItem](docs/sdks/class/relation/friendApplication.mdx)[]\> | 收到的好友请求列表 |
221221
| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
222222

223223
### 代码示例

0 commit comments

Comments
 (0)