外观
创建文件消息对象
约 188 字小于 1 分钟
2025-03-25
1. 描述
createFileMessage() 创建文件消息对象,该方法为同步函数。
2. 参数
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| conversationType | 是 | TYPE | CONVERSATION_TYPE.GROUP 或 CONVERSATION_TYPE.SINGLE |
| target | 是 | String | 接收者ID(单聊用户ID或群聊ID) |
| url | 是 | String | 文件URL |
| size | 否 | Number | 文件大小,单位为字节 |
| name | 否 | String | 文件名称 |
| quote | 否 | Object | 引用消息对象,包含完整的消息体 |
| at | 否 | JsonArray | 艾特的用户对象数组,只存在于群聊中 |
3. 返回值
返回文件消息对象。
4. 示例代码
const message = XBCIM.createFileMessage({
target: 'group-id',
url: 'https://example.com/file.pdf',
size: 1024,
name: 'file.pdf',
conversationType: XBCIM.CONVERSATION_TYPE.GROUP,
quote: {
id: 'xxxxxx',
... // 完整的消息体
},
at: [
{
userId: 'user-id',
... // 用户对象
},
]
})