发送消息
本文介绍了 IMLib 如何发送消息。
客户端 SDK 发送消息存在频率限制,每秒最多只能发送 5 条消息。
发送普通消息
开发者在发送文本消息、引用消息、自定义消息时,可以使用下面接口发送。
方法
Future<int> sendMessage(RCIMIWMessage message, {RCIMIWSendMessageCallback? callback});
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
message | RCIMIWMessage | 发送的消息实体 |
callback | RCIMIWSendMessageCallback | 发送消息的事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。 |
返回值
返回值 | 描述 |
---|---|
Future<int> | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码 |
代码示例
RCIMIWSendMessageCallback? callback = RCIMIWSendMessageCallback(onMessageSaved: (RCIMIWMessage? message) {
//...
}, onMessageSent: (int? code, RCIMIWMessage? message) {
//...
});
int? ret = await engine?.sendMessage(message, callback:callback);
回调方法
-
onMessageAttached
消息存入数据库的监听
Function(RCIMIWMessage? message)? onMessageAttached;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
message | RCIMIWMessage | 发送的消息 |
代码示例
engine?.onMessageAttached = (RCIMIWMessage? message) {
//...
};
-
onMessageSent
消息发送结果的监听
Function(int? code, RCIMIWMessage? message)? onMessageSent;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
code | int | 接口回调的状态码,0 代表成功,非 0 代表出现异常 |
message | RCIMIWMessage | 发送的消息 |
代码示例
engine?.onMessageSent = (int? code, RCIMIWMessage? message) {
//...
};
发送媒体消息
开发者在发送图片消息、语音消息、视频消息、文件消息、GIF 消息时,可以使用下面接口发送。
方法
Future<int> sendMediaMessage(RCIMIWMediaMessage message, {RCIMIWSendMediaMessageListener? listener});
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
message | RCIMIWMediaMessage | 发送的媒体消息实体 |
listener | RCIMIWSendMediaMessageListener | 发送媒体消息的事件监听 |
返回值
返回值 | 描述 |
---|---|
Future<int> | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码 |
代码示例
RCIMIWSendMediaMessageListener? listener = RCIMIWSendMediaMessageListener(onMediaMessageSaved: (RCIMIWMediaMessage? message) {
//...
}, onMediaMessageSending: (RCIMIWMediaMessage? message, int? progress) {
//...
}, onSendingMediaMessageCanceled: (RCIMIWMediaMessage? message) {
//...
}, onMediaMessageSent: (int? code, RCIMIWMediaMessage? message) {
//...
});
int? ret = await engine?.sendMediaMessage(message, listener:listener);
回调方法
-
onMediaMessageAttached
消息存入数据库的监听
Function(RCIMIWMediaMessage? message)? onMediaMessageAttached;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
message | RCIMIWMediaMessage | 发送的消息 |
代码示例
engine?.onMediaMessageAttached = (RCIMIWMediaMessage? message) {
//...
};
-
onMediaMessageSending
消息发送进度的监听
Function(RCIMIWMediaMessage? message, int? progress)? onMediaMessageSending;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
message | RCIMIWMediaMessage | 发送的消息 |
progress | int | 发送的进度 |
代码示例
engine?.onMediaMessageSending = (RCIMIWMediaMessage? message, int? progress) {
//...
};
-
onMediaMessageSent
消息发送结果的监听
Function(int? code, RCIMIWMediaMessage? message)? onMediaMessageSent;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
code | int | 接口回调的状态码,0 代表成功,非 0 代表出现异常 |
message | RCIMIWMediaMessage | 发送的消息 |
代码示例
engine?.onMediaMessageSent = (int? code, RCIMIWMediaMessage? message) {
//...
};