扩展消息
已发送的超级群消息可增加、修改、删除扩展信息。 原始消息增加状态标识的需求,都可使用消息扩展。
- 消息评论需求,可通过设置原始消息扩展信息的方式添加评论信息。
- 礼物领取、订单状态变化需求,通过此功能改变消息显示状态。 例如:向用户发送礼物,默认为 未领取状态,用户点击后可设置消息扩展为已领取状态。
更新消息扩展
方法
updateUltraGroupMessageExpansion(messageUId: string, expansion: Map<string, string>): Promise<number>;
参数说明
参数 | 类型 | 说明 |
---|---|---|
messageUId | string | 要扩展的全局消息ID |
expansion | Map<string, string> | 要扩展的信息 |
返回值
返回值 | 描述 |
---|---|
Promise<number> | 当次接口操作状态码,并不代表最终操作结果,状态码详细信息 |
代码示例
engine.updateUltraGroupMessageExpansion(
messageUId,
expansion
)
.then((code: number) => {});
回调方法
- setOnUltraGroupMessageExpansionUpdatedListener
setOnUltraGroupMessageExpansionUpdatedListener(listener?: (code: number, expansion: Map<string, string>, messageUId: string) => void): void;
参数说明
参数 | 类型 | 说明 |
---|---|---|
code | number | 接口回调的状态码,0 代表成功,非 0 代表出现异常 |
expansion | Map<string, string> | 要扩展的信息 |
messageUId | string | 要扩展的全局消息ID |
代码示例
engine.setOnUltraGroupMessageExpansionUpdatedListener(
(
code: number,
expansion: ,
messageUId
) => {}
);
删除消息扩展
方法
removeUltraGroupMessageExpansion(messageUId: string, keys: Array<string>): Promise<number>;
参数说明
参数 | 类型 | 说明 |
---|---|---|
messageUId | string | 要扩展的全局消息ID |
keys | Array<String> | 要删除的key |
返回值
返回值 | 描述 |
---|---|
Promise<number> | 当次接口操作状态码,并不代表最终操作结果,状态码详细信息 |
代码示例
engine.removeUltraGroupMessageExpansion(
messageUId,
keys
)
.then((code: number) => {});
回调方法
- setOnUltraGroupMessageExpansionRemovedListener
setOnUltraGroupMessageExpansionRemovedListener(listener?: (code: number, messageUId: string, keys: Array<string>) => void): void;
参数说明
参数 | 类型 | 说明 |
---|---|---|
code | number | 接口回调的状态码,0 代表成功,非 0 代表出现异常 |
messageUId | String | 要扩展的全局消息ID |
keys | List<String> | 要删除的key |
代码示例
engine.setOnUltraGroupMessageExpansionRemovedListener(
(
code: number,
messageUId: string,
keys: Array<string>
) => {}
);
监听远端消息扩展更新
当远端消息的扩展信息被更新时,会回调此方法。
方法
setOnRemoteUltraGroupMessageExpansionUpdatedListener(listener?: (messages: Array<RCIMIWMessage>) => void): void;
参数说明
参数 | 类型 | 说明 |
---|---|---|
messages | List<RCIMIWMessage> | 发生变化的消息 |
代码示例
engine.setOnRemoteUltraGroupMessageExpansionUpdatedListener(
(
messages: Array<RCIMIWMessage>
) => {}
);