Skip to content

Commit af929a8

Browse files
BloominggBloomingg
committed
fix: break links
1 parent 4dcb5e9 commit af929a8

12 files changed

Lines changed: 210 additions & 10 deletions

File tree

‎docs/restapi/apis/uploadManagement/confirmUpload.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ hide_title: true
2727
| header 名 | 示例值 | 选填 | 类型 | 说明 |
2828
| :---------- | :------------ | :--- | ------ | ---------------------------- |
2929
| operationID | 1646445464564 | 必填 | string | 用于全局链路追踪，建议使用时间戳，在每个请求中独立 |
30-
| token | eyJhbxxxx3Xs | 必填 | string | [管理员 token](docs/restapi/apis/authenticationManagement/getAdminToken.mdx) |
30+
| token | eyJhbxxxx3Xs | 必填 | string | [管理员 token](/restapi/apis/authenticationManagement/getAdminToken) |
3131

3232
### 请求参数示例
3333

‎docs/restapi/apis/uploadManagement/initUpload.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ hide_title: true
2727
| header 名 | 示例值 | 选填 | 类型 | 说明 |
2828
| :---------- | :------------ | :--- | ------ | ---------------------------- |
2929
| operationID | 1646445464564 | 必填 | string | 用于全局链路追踪，建议使用时间戳，在每个请求中独立 |
30-
| token | eyJhbxxxx3Xs | 必填 | string | [管理员 token](docs/restapi/apis/authenticationManagement/getAdminToken.mdx) |
30+
| token | eyJhbxxxx3Xs | 必填 | string | [管理员 token](/restapi/apis/authenticationManagement/getAdminToken) |
3131

3232
### 请求参数示例
3333

‎docs/sdks/enum/viewType.mdx‎

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

99
:::info
1010

11-
在[获取会话历史消息](docs/sdks/api/message/getAdvancedHistoryMessageList.mdx)与[反向获取会话历史消息](docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx)时，客户端用于通知SDK当前的具体操作。
11+
在[获取会话历史消息](docs/sdks/api/message/getAdvancedHistoryMessageList.mdx)时，客户端用于通知SDK当前的具体操作。
1212

1313
:::
1414

‎docs/sdks/listener/advancedMsgListener.mdx‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,4 @@ toc_max_heading_level: 2
1919
| [onRecvNewMessage](docs/sdks/callback/onRecvNewMessage.mdx) | 收到新消息 |
2020
| [onRecvOfflineNewMessage](docs/sdks/callback/onRecvOfflineNewMessage.mdx) | 收到离线消息 |
2121
| [onRecvC2CReadReceipt](docs/sdks/callback/onRecvC2CReadReceipt.mdx) | 单聊消息已读回执 |
22-
| [onRecvGroupReadReceipt](docs/sdks/callback/onRecvGroupReadReceipt.mdx) | 群聊消息已读回执 |
2322
| [onNewRecvMessageRevoked](docs/sdks/callback/onNewRecvMessageRevoked.mdx) | 撤回消息回调 |

‎i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/uploadManagement/_category_.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"position": 7,
3+
"label": "上传管理",
4+
"collapsible": true,
5+
"collapsed": true
6+
}

‎i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/uploadManagement/confirmUpload.mdx‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
sidebar_position: 2
3+
title: 确认上传
4+
hide_title: true
5+
---
6+
7+
<center>
8+
9+
## 确认上传
10+
11+
</center>
12+
13+
### 简要描述
14+
15+
- 在文件直传成功后通知服务端完成上传，生成可访问的对象地址。
16+
17+
### 请求方式
18+
19+
- `post`
20+
21+
### 请求 URL
22+
23+
- `{API_ADDRESS}/object/complete_form_data`
24+
25+
### Header
26+
27+
| header 名 | 示例值 | 选填 | 类型 | 说明 |
28+
| :---------- | :------------ | :--- | ------ | ---------------------------- |
29+
| operationID | 1646445464564 | 必填 | string | 用于全局链路追踪，建议使用时间戳，在每个请求中独立 |
30+
| token | eyJhbxxxx3Xs | 必填 | string | [管理员 token](/restapi/apis/authenticationManagement/getAdminToken) |
31+
32+
### 请求参数示例
33+
34+
```json
35+
{
36+
"id": "upload-task-id"
37+
}
38+
```
39+
40+
| 字段名 | 选填 | 类型 | 说明 |
41+
| :----- | :--- | :----- | ------------------- |
42+
| id | 必填 | string | 初始化阶段返回的 ID |
43+
44+
### 成功返回示例
45+
46+
```json
47+
{
48+
"errCode": 0,
49+
"errMsg": "",
50+
"errDlt": "",
51+
"data": {
52+
"url": "https://cdn.example.com/avatar.png"
53+
}
54+
}
55+
```
56+
57+
### 成功返回示例的参数说明
58+
59+
| 参数名 | 类型 | 说明 |
60+
| :----- | :----- | :--------------------------- |
61+
| errCode | int | 错误码，0 表示成功 |
62+
| errMsg | string | 错误简要信息，为空 |
63+
| errDlt | errDlt | 错误详细信息，为空 |
64+
| data | object | 通用数据对象，具体结构见下方 |
65+
| url | string | 文件在业务端可访问的最终地址 |
66+
67+
> 仅在使用 `initiate_form_data` 返回的凭证完成直传并确认成功后，服务端才会返回 `url`，可将其写入业务数据或下发给客户端。
68+
69+
### 失败返回示例
70+
71+
```json
72+
{
73+
"errCode": 1004,
74+
"errMsg": "RecordNotFoundError",
75+
"errDlt": ": [1004]RecordNotFoundError"
76+
}
77+
```
78+
79+
### 失败返回示例的参数说明
80+
81+
| 参数名 | 类型 | 说明 |
82+
| :------ | :----- | :---------------------------- |
83+
| errCode | int | 错误码，具体查看全局错误码文档 |
84+
| errMsg | string | 错误简要信息 |
85+
| errDlt | errDlt | 错误详细信息 |

‎i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/uploadManagement/initUpload.mdx‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
---
2+
sidebar_position: 1
3+
title: 获取上传凭证
4+
hide_title: true
5+
---
6+
7+
<center>
8+
9+
## 获取上传凭证
10+
11+
</center>
12+
13+
### 简要描述
14+
15+
- 初始化表单直传任务，获取上传所需的临时 URL、字段和 Header。
16+
17+
### 请求方式
18+
19+
- `post`
20+
21+
### 请求 URL
22+
23+
- `{API_ADDRESS}/object/initiate_form_data`
24+
25+
### Header
26+
27+
| header 名 | 示例值 | 选填 | 类型 | 说明 |
28+
| :---------- | :------------ | :--- | ------ | ---------------------------- |
29+
| operationID | 1646445464564 | 必填 | string | 用于全局链路追踪，建议使用时间戳，在每个请求中独立 |
30+
| token | eyJhbxxxx3Xs | 必填 | string | [管理员 token](/restapi/apis/authenticationManagement/getAdminToken) |
31+
32+
### 请求参数示例
33+
34+
```json
35+
{
36+
"name": "avatar.png",
37+
"size": 204800,
38+
"contentType": "image/png",
39+
"group": "avatar",
40+
"millisecond": 600000
41+
}
42+
```
43+
44+
| 字段名 | 选填 | 类型 | 说明 |
45+
| :---------- | :--- | :----- | ------------------------------------------------ |
46+
| name | 必填 | string | 对象名称，通常为文件名 |
47+
| size | 必填 | int64 | 文件大小（字节） |
48+
| contentType | 必填 | string | 文件 MIME 类型，如 `image/png` |
49+
| group | 选填 | string | 文件分组标识，用于在存储端区分业务目录 |
50+
| millisecond | 选填 | int64 | 上传地址有效时长（毫秒），不填使用服务端默认值 |
51+
52+
### 成功返回示例
53+
54+
```json
55+
{
56+
"errCode": 0,
57+
"errMsg": "",
58+
"errDlt": "",
59+
"data": {
60+
"id": "upload-task-id",
61+
"url": "https://storage.example.com/form-upload",
62+
"file": "file",
63+
"header": [
64+
{
65+
"key": "Content-Type",
66+
"value": "multipart/form-data"
67+
}
68+
],
69+
"formData": {
70+
"policy": "BASE64_POLICY",
71+
"signature": "SIGN_VALUE",
72+
"key": "tmp/avatar.png"
73+
},
74+
"expires": 1715065020123,
75+
"successCodes": [
76+
200
77+
]
78+
}
79+
}
80+
```
81+
82+
### 成功返回示例的参数说明
83+
84+
| 参数名 | 类型 | 说明 |
85+
| :---------- | :-------------- | :------------------------------------------------------------------- |
86+
| errCode | int | 错误码，0 表示成功 |
87+
| errMsg | string | 错误简要信息，为空 |
88+
| errDlt | errDlt | 错误详细信息，为空 |
89+
| data | object | 通用数据对象，具体结构见下方 |
90+
| id | string | 上传任务 ID，稍后调用完成接口时使用 |
91+
| url | string | 第三方存储直传地址 |
92+
| file | string | 文件内容对应的表单字段名 |
93+
| header | KeyValues 数组 | 直传 HTTP Header 列表 |
94+
| formData | map<string,string> | 需要在表单中追加的业务字段集合 |
95+
| expires | int64 | 凭证过期时间戳（毫秒） |
96+
| successCodes | array<int32/> | 直传成功时可接受的 HTTP 状态码，如 `200` |
97+
98+
### 上传说明
99+
100+
1. 构造 `multipart/form-data` 请求，目标地址为返回的 `url`。
101+
2. 将 `header` 中给出的键值添加到 HTTP Header。
102+
3. 在请求体中写入 `formData` 的所有键值对，键名和键值须保持原样。
103+
4. 将真实的文件内容放入 `file` 字段（字段名必须与返回值一致），例如 `-F "file=@avatar.png"`。
104+
5. 根据 `successCodes` 列表判断上传是否成功，收到成功响应后再调用确认接口。
105+
106+
示例命令：
107+
108+
```bash
109+
curl -X POST "https://storage.example.com/form-upload" \
110+
-H "Content-Type: multipart/form-data" \
111+
-F "policy=BASE64_POLICY" \
112+
-F "signature=SIGN_VALUE" \
113+
-F "key=tmp/avatar.png" \
114+
-F "file=@avatar.png"
115+
```

‎i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/index.mdx‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,13 @@ SDK related to messaging
4141
| [createFaceMessage](/api/message/createFaceMessage.mdx) | Create emoji message |
4242
| [sendMessage](/api/message/sendMessage.mdx) | Send message |
4343
| [sendMessageNotOss](/api/message/sendMessageNotOss.mdx) | Send message without SDK built-in OSS for multimedia file upload |
44-
| [typingStatusUpdate](/api/message/typingStatusUpdate.mdx) | Typing status update for private chat |
4544
| [revokeMessage](/api/message/revokeMessage.mdx) | Revoke a message |
4645
| [deleteMessage](/api/message/deleteMessage.mdx) | Delete a message |
4746
| [deleteMessageFromLocalStorage](/api/message/deleteMessageFromLocalStorage.mdx) | Delete a message locally |
4847
| [deleteAllMsgFromLocal](/api/message/deleteAllMsgFromLocal.mdx) | Delete all messages locally |
4948
| [deleteAllMsgFromLocalAndSvr](/api/message/deleteAllMsgFromLocalAndSvr.mdx) | Delete all messages |
5049
| [searchLocalMessages](/api/message/searchLocalMessages.mdx) | Search for local messages |
5150
| [getAdvancedHistoryMessageList](/api/message/getAdvancedHistoryMessageList.mdx) | Retrieve the message list within a conversation |
52-
| [getAdvancedHistoryMessageListReverse](/api/message/getAdvancedHistoryMessageListReverse.mdx) | Retrieve the message list in reverse within a conversation |
5351
| [findMessageList](/api/message/findMessageList.mdx) | Find message list |
5452
| [insertSingleMessageToLocalStorage](/api/message/insertSingleMessageToLocalStorage.mdx) | Insert a single chat message locally |
5553
| [insertGroupMessageToLocalStorage](/api/message/insertGroupMessageToLocalStorage.mdx) | Insert a group chat message locally |

‎i18n/en/docusaurus-plugin-content-docs-sdks/current/callback/index.mdx‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ Details for [Event Listeners](./listener) callbacks.
3838
| [onGroupDismissed](/callback/onGroupDismissed.mdx) | Callback after a group is disbanded |
3939
| [onRecvNewMessage](/callback/onRecvNewMessage.mdx) | Receipt of new message |
4040
| [onRecvC2CReadReceipt](/callback/onRecvC2CReadReceipt.mdx) | Read receipt for individual chat message |
41-
| [onRecvGroupReadReceipt](/callback/onRecvGroupReadReceipt.mdx) | Read receipt for group chat message |
4241
| [onNewRecvMessageRevoked](/callback/onNewRecvMessageRevoked.mdx) | Callback for message revocation |
4342
| [onSyncServerStart](/callback/onSyncServerStart.mdx) | Start of syncing server session |
4443
| [onSyncServerFinish](/callback/onSyncServerFinish.mdx) | Completion of syncing server session |

‎i18n/en/docusaurus-plugin-content-docs-sdks/current/class/user/index.mdx‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,4 @@ User information related
2020
| ----------------------------------------------------- | -----------------------------|
2121
| [UserInfo](/class/user/userInfo.mdx) | User Information Attributes |
2222
| [PublicInfo](/class/user/publicInfo.mdx) | User Public Information Attributes |
23-
| [FullUserInfo](/class/user/fullUserInfo.mdx) | Multi-dimensional User Attributes |
2423
| [UserStatusInfo](/class/user/userStatusInfo.mdx) | User Online Status Attributes |

0 commit comments

Comments
 (0)