IM即时通讯

收发消息

接收消息

接收消息需要先添加消息监听器,开发者可通过 setAdvancedMsgListener 来接收消息,所有的 IM 消息都通过该监听接收。更多回调函数请参考 OnAdvancedMsgListener。

  • 调用接口:
CRIM.iMManager.msgManager.setAdvancedMsgListener(OnAdvancedMsgListener(
  onRecvNewMsg: (Message msg) {
    // 收到消息后,根据消息类型 contentType 进行 UI 展示
  },
  onRecvOfflineNewMsg: (Message msg) {
    // 收到离线新消息
  },
  onNewRecvMsgRevoked: (RevokedInfo info) {
    // 消息被撤回
  },
  onRecv1v1ReadReceipt: (List<ReadReceiptInfo> list) {
    // 单聊消息已读回执
  },
  onMsgDeleted: (Message msg) {
    // 消息被删除
  },
));

相关 API 请参考:

发送消息

发送消息需要先构造消息实例,支持构造的消息类型有普通文本、图片、视频、文件、音频、地理位置、引用、转发、at 消息等,构造完消息后调用 SDK 的发送接口即可完成消息的发送。

创建文本消息

  • 调用接口:
final Message message = await CRIM.iMManager.msgManager.createTextMsg(
  text: "这是一条文本消息",
);

相关 API 请参考:

创建多媒体消息

多媒体消息支持的媒体类型包括图片、视频、语音、文件。
我们提供了两种方式发送多媒体消息,一种是 SDK 上传文件,一种是发送方自行上传,这里我们以图片消息为例分别说明。

SDK 上传文件

发送方调用发送消息接口后,SDK 内部会负责把文件上传到 IM 系统 OSS 存放,接收方收到消息后自行下载。

  • 调用接口:
final Message message =
    await CRIM.iMManager.msgManager.createImageMsgFromFullPath(
  imagePath: "文件绝对路径",
);

发送方自行上传

发送方可以调用 uploadFile 接口把文件上传到 IM 系统 OSS,也可以自己把文件上传到第三方存储,创建消息时把文件的下载 URL 传给 SDK,接收方收到消息后用 URL 自行下载。

  • 调用接口:
final Message message = await CRIM.iMManager.msgManager.createImageMsgByURL(
  sourcePicture: PictureInfo(
    size: 512,
    width: 320,
    height: 320,
    url: "https://xxxxxxxxxxxx",
  ),
  bigPicture: PictureInfo(
    size: 512,
    width: 320,
    height: 320,
    url: "https://xxxxxxxxxxxx",
  ),
  snapshotPicture: PictureInfo(
    size: 512,
    width: 120,
    height: 120,
    url: "https://xxxxxxxxxxxx",
  ),
);

相关 API 请参考:

创建位置消息

创建位置消息需要开发者采集到经纬度参数。

  • 调用接口:
final Message message = await CRIM.iMManager.msgManager.createLocationMsg(
  description: "位置描述",
  longitude: 116.397428,
  latitude: 39.90923,
);

相关 API 请参考:

创建自定义消息

创建自定义消息的消息内容需要使用 JSON 字符串。

  • 调用接口:
final Message message = await CRIM.iMManager.msgManager.createCustomMsg(
  data: '{"key":"value"}',
  extension: "扩展",
  description: "描述",
);

相关 API 请参考:

发送消息

用于所有 IM 消息的发送。

  • 调用接口:
final Message message = await CRIM.iMManager.msgManager.createTextMsg(
  text: "测试消息",
);

final Message sentMsg = await CRIM.iMManager.msgManager.sendMsg(
  message: message,
  userID: otherUserID,   // 单聊时填写,群聊时留空
  groupID: groupID,      // 群聊时填写,单聊时留空
  offlinePushInfo: OfflinePushInfo(
    title: "新消息",
    desc: "您有一条新消息",
  ),
);

相关 API 请参考: