IM即时通讯

API参考

初始化

getVersion

  • 函数原型:const char* getVersion()

  • 功能:获取sdk版本号

  • 返回值:版本号字符串

initSDK

  • 函数原型:bool CRIMManager::initSDK(const char *config);

  • 功能:初始化SDK

  • 返回值:初始化结果

  • 参数: json字符串,config详细参数如下:

参数 类型 必传 含义
platformID CRIMPlatform 是 平台类型
sdkServer string 是 服务器地址,如:http://192.168.0.10:8018
skipVerifyCert bool 否 传值true时将不校验Https证书,默认为false,仅sdkServer为https协义时有效
dataDir string 是 数据存储目录路径
logFilePath string 是 日志输出的路径
logLevel CRIMLogLevel 是 日志等级

unInitSDK

  • 函数原型:void CRIMManager::unInitSDK();

  • 功能:反初始化SDK

  • 返回值:无

addCallBack

  • 函数原型:void CRIMManager::addCallBack(CRIMCallbacker *p);

  • 功能:添加回调对象

  • 返回值:无

  • 参数:

参数 类型 必传 含义
p CRIMCallbacker* 是 回调对象指针

rmCallBack

  • 函数原型:void CRIMManager::rmCallBack(CRIMCallbacker *p);

  • 功能:移除回调对象

  • 返回值:无

  • 参数:

参数 类型 必传 含义
p CRIMCallbacker* 是 回调对象指针

登录

loginWithAppID

  • 函数原型: void CRIMManager::loginWithAppID(const char *userID, const char *appId, const char *appSecret, const char *cookie = "");

  • 功能:使用appId和appSecret登录

  • 返回值:无

  • 参数:

参数 类型 必传 含义
userID char* 是 用户ID
appId char* 是 APP ID , 参见登录鉴权
appSecret char* 是 APP Secret
cookie char* 否 上下文参数,在回调时带回

loginWithToken

  • 函数原型: void CRIMManager::loginWithToken(const char *userID, const char *token, const char *cookie = "");

  • 功能:使用token登录

  • 返回值:无

  • 参数:

参数 类型 必传 含义
userID char* 是 用户ID
token char* 是 Token鉴权码, 参见登录鉴权
cookie char* 否 上下文参数,在回调时带回

getLoginStatus

  • 函数原型: CRIMLoginState CRIMManager::getLoginStatus();

  • 功能:获取登录状态

  • 返回值:CRIMLoginState

  • 参数: 无

getLoginUserID

  • 函数原型: CRIMString CRIMManager::getLoginUserID();

  • 功能:获取当前已登录用户的userID

  • 返回值:已登录用户的userID

  • 参数: 无

logout

  • 函数原型: void CRIMManager::logout();

  • 功能:登出

  • 返回值:无

  • 参数: 无

  • 相关回调:
    logoutSuccess
    logoutFailure

loginSuccess

  • 函数原型:virtual void CRIMCallbacker::loginSuccess(const char *data, const char *cookie);

  • 功能:登录成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

loginFailure

  • 函数原型:virtual void CRIMCallbacker::loginFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:登录失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

logoutSuccess

  • 函数原型:virtual void CRIMCallbacker::logoutSuccess(const char *data, const char *cookie);

  • 功能:登出成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

logoutFailure

  • 函数原型:virtual void CRIMCallbacker::logoutFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:登出失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

notifyConnecting

  • 函数原型:virtual void CRIMCallbacker::notifyConnecting();

  • 功能:SDK正在连接到服务器通知

  • 返回值:无

  • 参数:无

notifyConnectSuccess

  • 函数原型:virtual void CRIMCallbacker::notifyConnectSuccess();

  • 功能:SDK已经成功连接到服务器通知

  • 返回值:无

  • 参数:无

notifyConnectFailed

  • 函数原型:virtual void CRIMCallbacker::notifyConnectFailed(int errCode, const char *errMsg, const char *cookie);

  • 功能:SDK连接服务器失败通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

notifyKickedOffline

  • 函数原型:virtual void CRIMCallbacker::notifyKickedOffline();

  • 功能:当前用户被踢下线通知

  • 返回值:无

  • 参数:无

notifyUserTokenExpired

  • 函数原型:virtual void CRIMCallbacker::notifyUserTokenExpired();

  • 功能:登录所用Token即将过期通知

  • 返回值:无

  • 参数:无

notifyUserTokenInvalid

  • 函数原型:virtual void CRIMCallbacker::notifyUserTokenInvalid();

  • 功能:登录所用Token无效

  • 返回值:无

  • 参数:无

notifySyncServerStart

  • 函数原型:virtual void CRIMCallbacker::notifySyncServerStart(int reinstalled);

  • 功能:开始同步服务器数据通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
reinstalled int 是 是否为重新安装后的同步

notifySyncServerProgress

  • 函数原型:virtual void CRIMCallbacker::notifySyncServerProgress(int progress);

  • 功能:同步服务器数据进度通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
progress int 是 同步进度0~100

notifySyncServerFinish

  • 函数原型:virtual void CRIMCallbacker::notifySyncServerFinish(int reinstalled);

  • 功能:同步服务器数据完成通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
reinstalled int 是 是否为重新安装后的同步

notifySyncServerFailed

  • 函数原型:virtual void CRIMCallbacker::notifySyncServerFailed(int reinstalled);

  • 功能:同步服务器数据失败通知

  • 返回值:无

  • 参数:无

用户

getUsersInfo

  • 函数原型: void CRIMManager::getUsersInfo(const char *uids, const char *cookie = "");

  • 功能:批量查询用户信息

  • 返回值:无

  • 参数:

参数 类型 必传 含义
uids char* 是 json字符串, 用户id列表
cookie char* 否 上下文参数,在回调时带回

setSelfInfo

  • 函数原型: void CRIMManager::setSelfInfo(const char *userInfo, const char *cookie = "");

  • 功能:修改当前登录用户信息

  • 返回值:无

  • 参数:

参数 类型 必传 含义
userInfo char* 是 json字符串, 修改的用户信息
cookie char* 否 上下文参数,在回调时带回

userInfo说明:

参数 类型 必传 含义
nickname string 否 昵称
faceURL string 否 头像url
ex string 否 扩展信息

getSelfInfo

  • 函数原型: void CRIMManager::getSelfInfo(const char *cookie = "");

  • 功能:获取当前登录用户信息

  • 返回值:无

  • 参数:

参数 类型 必传 含义
cookie char* 否 上下文参数,在回调时带回

subscribeUsersStatus

  • 函数原型: void CRIMManager::subscribeUsersStatus(const char *userIDs, const char *cookie = "");

  • 功能:订阅指定用户的在线状态, 订阅后用户状态改变时,将收到notifyUserStatusChanged通知。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
userIDs char* 是 json字符串, 用户id列表
cookie char* 否 上下文参数,在回调时带回

unsubscribeUsersStatus

  • 函数原型: void CRIMManager::unsubscribeUsersStatus(const char *userIDs, const char *cookie = "");

  • 功能:取消订阅用户的在线状态

  • 返回值:无

  • 参数:

参数 类型 必传 含义
userIDs char* 是 json字符串, 用户id列表
cookie char* 否 上下文参数,在回调时带回

getSubscribeUsersStatus

  • 函数原型: void CRIMManager::getSubscribeUsersStatus(const char *cookie = "");

  • 功能:获取所有已订阅用户的在线状态

  • 返回值:无

  • 参数:

参数 类型 必传 含义
cookie char* 否 上下文参数,在回调时带回

getUserStatus

  • 函数原型: void CRIMManager::getUserStatus(const char *userIDs, const char *cookie = "");

  • 功能:获取指定用户的在线状态

  • 返回值:无

  • 参数:

参数 类型 必传 含义
userIDs char* 是 json字符串, 用户id列表
cookie char* 否 上下文参数,在回调时带回

getUsersInfoSuccess

  • 函数原型:virtual void CRIMCallbacker::getUsersInfoSuccess(const char *data, const char *cookie);

  • 功能:getUsersInfo成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMUserInfo
cookie char* 是 上下文参数

getUsersInfoFailure

  • 函数原型:virtual void CRIMCallbacker::getUsersInfoFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getUsersInfo失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

setSelfInfoSuccess

  • 函数原型:virtual void CRIMCallbacker::setSelfInfoSuccess(const char *data, const char *cookie);

  • 功能:setSelfInfo成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

setSelfInfoFailure

  • 函数原型:virtual void CRIMCallbacker::setSelfInfoFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:setSelfInfo失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getSelfInfoSuccess

  • 函数原型:virtual void CRIMCallbacker::getSelfInfoSuccess(const char *data, const char *cookie);

  • 功能:getSelfInfo成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMUserInfo
cookie char* 是 上下文参数

getSelfInfoFailure

  • 函数原型:virtual void CRIMCallbacker::getSelfInfoFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getSelfInfo失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

subscribeUsersStatusSuccess

  • 函数原型:virtual void CRIMCallbacker::subscribeUsersStatusSuccess(const char *data, const char *cookie);

  • 功能:subscribeUsersStatus成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMUserStatusInfo>
cookie char* 是 上下文参数

subscribeUsersStatusFailure

  • 函数原型:virtual void CRIMCallbacker::subscribeUsersStatusFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:subscribeUsersStatus失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

unsubscribeUsersStatusSuccess

  • 函数原型:virtual void CRIMCallbacker::unsubscribeUsersStatusSuccess(const char *data, const char *cookie);

  • 功能:unsubscribeUsersStatus成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

unsubscribeUsersStatusFailure

  • 函数原型:virtual void CRIMCallbacker::unsubscribeUsersStatusFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:unsubscribeUsersStatus失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getSubscribeUsersStatusSuccess

  • 函数原型:virtual void CRIMCallbacker::getSubscribeUsersStatusSuccess(const char *data, const char *cookie);

  • 功能:getSubscribeUsersStatus成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, list<CRIMUserStatusInfo>
cookie char* 是 上下文参数

getSubscribeUsersStatusFailure

  • 函数原型:virtual void CRIMCallbacker::getSubscribeUsersStatusFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getSubscribeUsersStatus失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getUserStatusSuccess

  • 函数原型:virtual void CRIMCallbacker::getUserStatusSuccess(const char *data, const char *cookie);

  • 功能:getUserStatus成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, list<CRIMUserStatusInfo>
cookie char* 是 上下文参数

getUserStatusFailure

  • 函数原型:virtual void CRIMCallbacker::getUserStatusFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getUserStatus失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

notifySelfInfoUpdated

  • 函数原型:virtual void CRIMCallbacker::notifySelfInfoUpdated(const char *data);

  • 功能:我的信息改变通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMUserInfo

notifyUserStatusChanged

  • 函数原型:virtual void CRIMCallbacker::notifyUserStatusChanged(const char *data);

  • 功能:用户状态改变通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMUserStatusInfo

会话

getAllConversationList

  • 函数原型:void CRIMManager::getAllConversationList(const char *cookie = "");

  • 功能:获取会话列表

  • 返回值:无

  • 参数:

参数 类型 必传 含义
cookie char* 否 上下文参数,在回调时带回

getConversationListSplit

  • 函数原型:void CRIMManager::getConversationListSplit(int offset, int count, const char *cookie = "");

  • 功能:分页获取会话列表

  • 返回值:无

  • 参数:

参数 类型 必传 含义
offset int 是 起始偏移量
count int 是 获取的数量
cookie char* 否 上下文参数,在回调时带回

getConversationIDBySessionType

  • 函数原型:CRIMString CRIMManager::getConversationIDBySessionType(const char *sourceID, CRIMConversationType sessionType);

  • 功能:获取会话ID

  • 返回值:会话ID

  • 参数:

参数 类型 必传 含义
sessionType CRIMConversationType 是 会话类型
sourceID char* 是 单聊为用户 ID,群聊为群ID

getOneConversation

  • 函数原型:void CRIMManager::getOneConversation(CRIMConversationType sessionType, const char *sourceID, const char *cookie = "");

  • 功能:获取一个会话信息,如果不存在会自动创建

  • 返回值:无

  • 参数:

参数 类型 必传 含义
sessionType CRIMConversationType 是 会话类型
sourceID char* 是 单聊为用户 ID,群聊为群ID
cookie char* 否 上下文参数,在回调时带回

getMultipleConversation

  • 函数原型:void CRIMManager::getMultipleConversation(const char *ids, const char *cookie = "");

  • 功能:获取多个会话信息

  • 返回值:无

  • 参数:

参数 类型 必传 含义
ids char* 是 json字符串, 会话ID列表
cookie char* 否 上下文参数,在回调时带回

deleteConversationAndDeleteAllMsg

  • 函数原型:void CRIMManager::deleteConversationAndDeleteAllMsg(const char* conversationID, const char *cookie = "");

  • 功能:删除一个会话(本地&服务器)

  • 返回值:无

  • 参数:

参数 类型 必传 含义
conversationID char* 是 会话ID
cookie char* 否 上下文参数,在回调时带回

clearConversationAndDeleteAllMsg

  • 函数原型:void CRIMManager::clearConversationAndDeleteAllMsg(const char* conversationID, const char *cookie = "");

  • 功能:清空一个会话(本地&服务器)

  • 返回值:无

  • 参数:

参数 类型 必传 含义
conversationID char* 是 会话ID
cookie char* 否 上下文参数,在回调时带回

setConversationDraft

  • 函数原型:void CRIMManager::setConversationDraft(const char *conversationID, const char *draftText, const char *cookie = "");

  • 功能:设置会话的草稿

  • 返回值:无

  • 参数:

参数 类型 必传 含义
conversationID char* 是 会话ID
draftText char* 是 草稿文本,如果为""则为删除草稿
cookie char* 否 上下文参数,在回调时带回

pinConversation

  • 函数原型:void CRIMManager::pinConversation(const char *conversationID, const char *draftText, const char *cookie = "");

  • 功能:置顶会话。 置顶成功后,会话信息中的isPinned将为true;

  • 返回值:无

  • 参数:

参数 类型 必传 含义
conversationID char* 是 会话ID
draftText char* 是 草稿文本,如果为""则为删除草稿
cookie char* 否 上下文参数,在回调时带回

getAtAllTag

  • 函数原型:CRIMString CRIMManager::getAtAllTag();

  • 功能:获取"@所有人"标识

  • 返回值:标识串

  • 参数:无

markAllConversationMsgAsRead

  • 函数原型:void CRIMManager::markAllConversationMsgAsRead(const char *cookie = "");

  • 功能:清空所有会话未读数。

  • 调用此接口,可以把所有会话内的消息标记为已读。
  • 返回值:无

  • 参数:

参数 类型 必传 含义
cookie char* 否 上下文参数,在回调时带回

markConversationMsgAsRead

  • 函数原型:void CRIMManager::markConversationMsgAsRead(const char *conversationID, const char *cookie = "");

  • 功能:清空会话未读数。

  • 调用此接口,可以把会话内的消息标记为已读。
  • 如果是单聊会话内的消息,会给消息的发送方发送已读回执,触发发送方的notifyRecv1v1ReadReceipt回调。
  • 返回值:无

  • 参数:

参数 类型 必传 含义
conversationID char* 是 会话ID
cookie char* 否 上下文参数,在回调时带回

getTotalUnreadMsgCount

  • 函数原型:void CRIMManager::getTotalUnreadMsgCount(const char *cookie = "");

  • 功能:获取总的消息未读数

  • 返回值:无

  • 参数:

参数 类型 必传 含义
cookie char* 否 上下文参数,在回调时带回

setConversationRecvMsgOpt

  • 函数原型:void CRIMManager::setConversationRecvMsgOpt(const char *conversationID, CRIMReceiveMsgOpt opt, const char *cookie = "");

  • 功能:设置会话免打扰状态

  • 返回值:无

  • 参数:

参数 类型 必传 含义
conversationID char* 是 会话ID
opt CRIMReceiveMsgOpt 是 免打扰状态
cookie char* 否 上下文参数,在回调时带回

setConversationPrivateChat

  • 函数原型:void CRIMManager::setConversationPrivateChat(const char *conversationID, int isPrivate, int duration, const char *cookie = "");

  • 功能:设置会话的“阅后即焚”功能。 开启后发送的消息体上AttachedInfoElem的isPrivateChat为true,burnDuration为设置的时间,界面可以根据这个标识位做阅后即焚的处理。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
conversationID char* 是 会话ID
isPrivate int 是 0:关闭,1:开启
duration int 是 开启时的阅后即焚
cookie char* 否 上下文参数,在回调时带回

resetConversationGrpAtType

  • 函数原型:void CRIMManager::resetConversationGrpAtType(const char *conversationID, const char *cookie = "");

  • 功能:重置at标志位

  • 返回值:无

  • 参数:

参数 类型 必传 含义
conversationID char* 是 会话ID
cookie char* 否 上下文参数,在回调时带回

hideConversation

  • 函数原型:void CRIMManager::hideConversation(const char *conversationID, const char *cookie = "");

  • 功能:隐藏一个本地会话。不会删除会话及会话内的消息,收到新消息时此会话隐藏将自动取消。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
conversationID char* 是 会话ID
cookie char* 否 上下文参数,在回调时带回

hideAllConversations

  • 函数原型:void CRIMManager::hideAllConversations(const char *cookie = "");

  • 功能:隐藏所有本地会话。不会删除会话及会话内的消息,收到新消息时对应会话隐藏将自动取消。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
cookie char* 否 上下文参数,在回调时带回

getAllConversationListSuccess

  • 函数原型:virtual void CRIMCallbacker::getAllConversationListSuccess(const char *data, const char *cookie);

  • 功能:getAllConversationList成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMConversationInfo>
cookie char* 是 上下文参数

getAllConversationListFailure

  • 函数原型:virtual void CRIMCallbacker::getAllConversationListFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getAllConversationList失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getConversationListSplitSuccess

  • 函数原型:virtual void CRIMCallbacker::getConversationListSplitSuccess(const char *data, const char *cookie);

  • 功能:getConversationListSplit成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMConversationInfo>
cookie char* 是 上下文参数

getConversationListSplitFailure

  • 函数原型:virtual void CRIMCallbacker::getConversationListSplitFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getConversationListSplit失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getOneConversationSuccess

  • 函数原型:virtual void CRIMCallbacker::getOneConversationSuccess(const char *data, const char *cookie);

  • 功能:getOneConversation成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMConversationInfo
cookie char* 是 上下文参数

getOneConversationFailure

  • 函数原型:virtual void CRIMCallbacker::getOneConversationFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getOneConversation失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getMultipleConversationSuccess

  • 函数原型:virtual void CRIMCallbacker::getMultipleConversationSuccess(const char *data, const char *cookie);

  • 功能:getMultipleConversation成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMConversationInfo>
cookie char* 是 上下文参数

getMultipleConversationFailure

  • 函数原型:virtual void CRIMCallbacker::getMultipleConversationFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getMultipleConversation失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

deleteConversationAndDeleteAllMsgSuccess

  • 函数原型:virtual void CRIMCallbacker::deleteConversationAndDeleteAllMsgSuccess(const char *data, const char *cookie);

  • 功能:deleteConversationAndDeleteAllMsg成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

deleteConversationAndDeleteAllMsgFailure

  • 函数原型:virtual void CRIMCallbacker::deleteConversationAndDeleteAllMsgFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:deleteConversationAndDeleteAllMsg失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

clearConversationAndDeleteAllMsgSuccess

  • 函数原型:virtual void CRIMCallbacker::clearConversationAndDeleteAllMsgSuccess(const char *data, const char *cookie);

  • 功能:clearConversationAndDeleteAllMsg成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

clearConversationAndDeleteAllMsgFailure

  • 函数原型:virtual void CRIMCallbacker::clearConversationAndDeleteAllMsgFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:clearConversationAndDeleteAllMsg失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

setConversationDraftSuccess

  • 函数原型:virtual void CRIMCallbacker::setConversationDraftSuccess(const char *data, const char *cookie);

  • 功能:setConversationDraft成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

setConversationDraftFailure

  • 函数原型:virtual void CRIMCallbacker::setConversationDraftFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:setConversationDraft失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

pinConversationSuccess

  • 函数原型:virtual void CRIMCallbacker::pinConversationSuccess(const char *data, const char *cookie);

  • 功能:pinConversation成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

pinConversationFailure

  • 函数原型:virtual void CRIMCallbacker::pinConversationFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:pinConversation失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

markAllConversationMsgAsReadSuccess

  • 函数原型:virtual void CRIMCallbacker::markAllConversationMsgAsReadSuccess(const char *data, const char *cookie);

  • 功能:markAllConversationMsgAsRead成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

markAllConversationMsgAsReadFailure

  • 函数原型:virtual void CRIMCallbacker::markAllConversationMsgAsReadFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:markAllConversationMsgAsRead失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

markConversationMsgAsReadSuccess

  • 函数原型:virtual void CRIMCallbacker::markConversationMsgAsReadSuccess(const char *data, const char *cookie);

  • 功能:markConversationMsgAsRead成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

markConversationMsgAsReadFailure

  • 函数原型:virtual void CRIMCallbacker::markConversationMsgAsReadFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:markConversationMsgAsRead失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getTotalUnreadMsgCountSuccess

  • 函数原型:virtual void CRIMCallbacker::getTotalUnreadMsgCountSuccess(const char *data, const char *cookie);

  • 功能:getTotalUnreadMsgCount成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 未读消息数量
cookie char* 是 上下文参数

getTotalUnreadMsgCountFailure

  • 函数原型:virtual void CRIMCallbacker::getTotalUnreadMsgCountFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getTotalUnreadMsgCount失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

setConversationRecvMsgOptSuccess

  • 函数原型:virtual void CRIMCallbacker::setConversationRecvMsgOptSuccess(const char *data, const char *cookie);

  • 功能:setConversationRecvMsgOpt成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

setConversationRecvMsgOptFailure

  • 函数原型:virtual void CRIMCallbacker::setConversationRecvMsgOptFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:setConversationRecvMsgOpt失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

setConversationPrivateChatSuccess

  • 函数原型:virtual void CRIMCallbacker::setConversationPrivateChatSuccess(const char *data, const char *cookie);

  • 功能:setConversationPrivateChat成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

setConversationPrivateChatFailure

  • 函数原型:virtual void CRIMCallbacker::setConversationPrivateChatFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:setConversationPrivateChat失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

resetConversationGrpAtTypeSuccess

  • 函数原型:virtual void CRIMCallbacker::resetConversationGrpAtTypeSuccess(const char *data, const char *cookie);

  • 功能:resetConversationGrpAtType成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

resetConversationGrpAtTypeFailure

  • 函数原型:virtual void CRIMCallbacker::resetConversationGrpAtTypeFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:resetConversationGrpAtType失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

hideConversationSuccess

  • 函数原型:virtual void CRIMCallbacker::hideConversationSuccess(const char *data, const char *cookie);

  • 功能:hideConversation成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

hideConversationFailure

  • 函数原型:virtual void CRIMCallbacker::hideConversationFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:hideConversation失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

hideAllConversationsSuccess

  • 函数原型:virtual void CRIMCallbacker::hideAllConversationsSuccess(const char *data, const char *cookie);

  • 功能:hideAllConversations成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

hideAllConversationsFailure

  • 函数原型:virtual void CRIMCallbacker::hideAllConversationsFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:hideAllConversations失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

notifyNewConversation

  • 函数原型:virtual void CRIMCallbacker::notifyNewConversation(const char *data);

  • 功能:产生新的会话通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMConversationInfo

notifyConversationChanged

  • 函数原型:virtual void CRIMCallbacker::notifyConversationChanged(const char *data);

  • 功能:会话的信息发生变化通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMConversationInfo

notifyTotalUnreadMsgCountChanged

  • 函数原型:virtual void CRIMCallbacker::notifyTotalUnreadMsgCountChanged(int count);

  • 功能:总未读数发生变化通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
count int 是 总的未读数

好友

addFriend

  • 函数原型:void CRIMManager::addFriend(const char *data, const char *cookie = "");

  • 功能:发起好友申请,请求添加对方为好友。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 添加好友请求信息
cookie char* 否 上下文参数,在回调时带回

data说明:

参数 类型 必传 含义
toUserID string 是 对方userID
reqMsg string 是 呈现给对方的文本信息

getFriendReqListAsRecipient

  • 函数原型:void CRIMManager::getFriendReqListAsRecipient(const char* reqDat, const char *cookie = "");

  • 功能:获取收到的好友申请

  • 返回值:无

  • 参数:

参数 类型 必传 含义
reqDat char* 是 json字符串, 详见后面reqDat说明
cookie char* 否 上下文参数,在回调时带回

reqDat说明:

参数 类型 必传 含义
offset int 是 获取的起始位置
count int 是 获取数量

getFriendReqListAsApplicant

  • 函数原型:void CRIMManager::getFriendReqListAsApplicant(const char* reqDat, const char *cookie = "");

  • 功能:获取发出的好友申请

  • 返回值:无

  • 参数:

参数 类型 必传 含义
reqDat char* 是 json字符串, 详见后面reqDat说明
cookie char* 否 上下文参数,在回调时带回

reqDat说明:

参数 类型 必传 含义
offset int 是 获取的起始位置
count int 是 获取数量

acceptFriendReq

  • 函数原型:void CRIMManager::acceptFriendReq(const char *data, const char *cookie = "");

  • 功能:同意某人的好友申请

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 接受好友申请信息
cookie char* 否 上下文参数,在回调时带回

data说明:

参数 类型 必传 含义
toUserID string 是 对方userID
handleMsg string 否 处理说明

refuseFriendReq

  • 函数原型:void CRIMManager::refuseFriendReq(const char *data, const char *cookie = "");

  • 功能:拒绝某人的好友申请

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 拒绝好友申请信息
cookie char* 否 上下文参数,在回调时带回

data说明:

参数 类型 必传 含义
toUserID string 是 对方userID
handleMsg string 否 处理说明

addToBlackList

  • 函数原型:void CRIMManager::addToBlackList(const char *userID, const char *ex, const char *cookie = "");

  • 功能:拒绝某人的好友申请

  • 返回值:无

  • 参数:

参数 类型 必传 含义
userID char* 是 用户ID
ex char* 否 扩展信息
cookie char* 否 上下文参数,在回调时带回

getBlackList

  • 函数原型:void CRIMManager::getBlackList(const char *cookie = "");

  • 功能:获取黑名单

  • 返回值:无

  • 参数:

参数 类型 必传 含义
cookie char* 否 上下文参数,在回调时带回

removeFromBlackList

  • 函数原型:void CRIMManager::removeFromBlackList(const char *userID, const char *cookie = "");

  • 功能:移除黑名单

  • 返回值:无

  • 参数:

参数 类型 必传 含义
userID char* 是 用户ID
cookie char* 否 上下文参数,在回调时带回

getSpecifiedFriendsInfo

  • 函数原型:void CRIMManager::getSpecifiedFriendsInfo(const char *userIDs, bool filterBlack, const char *cookie = "");

  • 功能:获取指定好友列表的相关信息

  • 返回值:无

  • 参数:

参数 类型 必传 含义
userIDs char* 是 json字符串, 用户ID列表
filterBlack bool 是 是否返回结果中排除黑名单人员
cookie char* 否 上下文参数,在回调时带回

getFriendList

  • 函数原型:void CRIMManager::getFriendList(bool filterBlack, const char *cookie = "");

  • 功能:获取所有好友信息

  • 返回值:无

  • 参数:

参数 类型 必传 含义
filterBlack bool 是 是否返回结果中排除黑名单人员
cookie char* 否 上下文参数,在回调时带回

getFriendListPage

  • 函数原型:void CRIMManager::getFriendListPage(int offset, int count, bool filterBlack, const char *cookie = "");

  • 功能:获取分页好友列表

  • 返回值:无

  • 参数:

参数 类型 必传 含义
offset int 是 起始偏移量
count int 是 获取的数量
filterBlack bool 是 是否返回结果中排除黑名单人员
cookie char* 否 上下文参数,在回调时带回

checkFriend

  • 函数原型:void CRIMManager::checkFriend(const char *userIDs, const char *cookie = "");

  • 功能:检查是否好友关系。在自已的好友列表中且不是黑名单,则为好友关系。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
offset int 是 起始偏移量
count int 是 获取的数量
cookie char* 否 上下文参数,在回调时带回

updateFriends

  • 函数原型:void CRIMManager::updateFriends(const char *reqDat, const char *cookie = "");

  • 功能:更新好友信息

  • 返回值:无

  • 参数:

参数 类型 必传 含义
reqDat char* 是 json字符串, 详见后面reqDat说明
cookie char* 否 上下文参数,在回调时带回

reqDat说明:

参数 类型 必传 含义
isPinned bool 否 是否对好友执行了置顶操作
remark string 否 好友备注
ex string 否 更多扩展信息

deleteFriend

  • 函数原型:void CRIMManager::deleteFriend(const char *uid, const char *cookie = "");

  • 功能:删除好友。

  • 好友关系是相互的,删除时将导致双方都互不为好友。
  • 删除好友并不会删除会话,如要删除会话,可以调用删除会话的函数deleteConversationAndDeleteAllMsg。
  • 返回值:无

  • 参数:

参数 类型 必传 含义
uid char* 是 用户ID
cookie char* 否 上下文参数,在回调时带回

searchFriends

  • 函数原型:void CRIMManager::searchFriends(const char *data, const char *cookie = "");

  • 功能:本地搜索好友

  • 返回值:无

  • 参数:

参数 类型 必传 含义
uid char* 是 json字符串, 搜索参数
cookie char* 否 上下文参数,在回调时带回

data说明:

参数 类型 必传 含义
keywordList list<string> 是 搜索的关键词列表, 目前仅支持单个关键词
isSearchUserID bool 是 是否搜索userID
isSearchNickname bool 否 是否搜索昵称,默认false
isSearchRemark bool 否 是否搜索备注,默认false

addFriendSuccess

  • 函数原型:virtual void CRIMCallbacker::addFriendSuccess(const char *data, const char *cookie);

  • 功能:addFriend成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

addFriendFailure

  • 函数原型:virtual void CRIMCallbacker::addFriendFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:addFriend失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getFriendReqListAsRecipientSuccess

  • 函数原型:virtual void CRIMCallbacker::getFriendReqListAsRecipientSuccess(const char *data, const char *cookie);

  • 功能:getFriendReqListAsRecipient成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMFriendReqInfo>
cookie char* 是 上下文参数

getFriendReqListAsRecipientFailure

  • 函数原型:virtual void CRIMCallbacker::getFriendReqListAsRecipientFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getFriendReqListAsRecipient失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getFriendReqListAsApplicantSuccess

  • 函数原型:virtual void CRIMCallbacker::getFriendReqListAsApplicantSuccess(const char *data, const char *cookie);

  • 功能:getFriendReqListAsApplicant成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMFriendReqInfo>
cookie char* 是 上下文参数

getFriendReqListAsApplicantFailure

  • 函数原型:virtual void CRIMCallbacker::getFriendReqListAsApplicantFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getFriendReqListAsApplicant失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

acceptFriendReqSuccess

  • 函数原型:virtual void CRIMCallbacker::acceptFriendReqSuccess(const char *data, const char *cookie);

  • 功能:acceptFriendReq成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

acceptFriendReqFailure

  • 函数原型:virtual void CRIMCallbacker::acceptFriendReqFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:acceptFriendReq失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

refuseFriendReqSuccess

  • 函数原型:virtual void CRIMCallbacker::refuseFriendReqSuccess(const char *data, const char *cookie);

  • 功能:refuseFriendReq成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

refuseFriendReqFailure

  • 函数原型:virtual void CRIMCallbacker::refuseFriendReqFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:refuseFriendReq失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

addToBlackListSuccess

  • 函数原型:virtual void CRIMCallbacker::addToBlackListSuccess(const char *data, const char *cookie);

  • 功能:addToBlackList成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

addToBlackListFailure

  • 函数原型:virtual void CRIMCallbacker::addToBlackListFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:addToBlackList失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getBlackListSuccess

  • 函数原型:virtual void CRIMCallbacker::getBlackListSuccess(const char *data, const char *cookie);

  • 功能:getBlackList成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMBlackListInfo>
cookie char* 是 上下文参数

getBlackListFailure

  • 函数原型:virtual void CRIMCallbacker::getBlackListFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getBlackList失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

removeFromBlackListSuccess

  • 函数原型:virtual void CRIMCallbacker::removeFromBlackListSuccess(const char *data, const char *cookie);

  • 功能:removeFromBlackList成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

removeFromBlackListFailure

  • 函数原型:virtual void CRIMCallbacker::removeFromBlackListFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:removeFromBlackList失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getSpecifiedFriendsInfoSuccess

  • 函数原型:virtual void CRIMCallbacker::getSpecifiedFriendsInfoSuccess(const char *data, const char *cookie);

  • 功能:getSpecifiedFriendsInfo成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMFullUserInfo>
cookie char* 是 上下文参数

getSpecifiedFriendsInfoFailure

  • 函数原型:virtual void CRIMCallbacker::getSpecifiedFriendsInfoFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getSpecifiedFriendsInfo失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getFriendListSuccess

  • 函数原型:virtual void CRIMCallbacker::getFriendListSuccess(const char *data, const char *cookie);

  • 功能:getFriendList成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMFullUserInfo>
cookie char* 是 上下文参数

getFriendListFailure

  • 函数原型:virtual void CRIMCallbacker::getFriendListFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getFriendList失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getFriendListPageSuccess

  • 函数原型:virtual void CRIMCallbacker::getFriendListPageSuccess(const char *data, const char *cookie);

  • 功能:getFriendListPage成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMFullUserInfo>
cookie char* 是 上下文参数

getFriendListPageFailure

  • 函数原型:virtual void CRIMCallbacker::getFriendListPageFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getFriendListPage失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

checkFriendSuccess

  • 函数原型:virtual void CRIMCallbacker::checkFriendSuccess(const char *data, const char *cookie);

  • 功能:checkFriend成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMSimpleResultInfo>
cookie char* 是 上下文参数

checkFriendFailure

  • 函数原型:virtual void CRIMCallbacker::checkFriendFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:checkFriend失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

updateFriendsSuccess

  • 函数原型:virtual void CRIMCallbacker::updateFriendsSuccess(const char *data, const char *cookie);

  • 功能:updateFriends成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

updateFriendsFailure

  • 函数原型:virtual void CRIMCallbacker::updateFriendsFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:updateFriends失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

deleteFriendSuccess

  • 函数原型:virtual void CRIMCallbacker::deleteFriendSuccess(const char *data, const char *cookie);

  • 功能:deleteFriend成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

deleteFriendFailure

  • 函数原型:virtual void CRIMCallbacker::deleteFriendFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:deleteFriend失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

searchFriendsSuccess

  • 函数原型:virtual void CRIMCallbacker::searchFriendsSuccess(const char *data, const char *cookie);

  • 功能:searchFriends成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMFriendInfo>
cookie char* 是 上下文参数

searchFriendsFailure

  • 函数原型:virtual void CRIMCallbacker::searchFriendsFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:searchFriends失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

notifyFriendAdded

  • 函数原型:virtual void CRIMCallbacker::notifyFriendAdded(const char *data);

  • 功能:好友新增通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMFriendInfo

notifyFriendDeleted

  • 函数原型:virtual void CRIMCallbacker::notifyFriendDeleted(const char *data);

  • 功能:好友删除通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMFriendInfo

notifyFriendInfoChanged

  • 函数原型:virtual void CRIMCallbacker::notifyFriendInfoChanged(const char *data);

  • 功能:好友资料变更通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMFriendInfo

notifyFriendReqAdded

  • 函数原型:virtual void CRIMCallbacker::notifyFriendReqAdded(const char *data);

  • 功能:好友申请新增通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMFriendReqInfo

notifyFriendReqDeleted

  • 函数原型:virtual void CRIMCallbacker::notifyFriendReqDeleted(const char *data);

  • 功能:好友申请被删除通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMFriendReqInfo

notifyFriendReqAccepted

  • 函数原型:virtual void CRIMCallbacker::notifyFriendReqAccepted(const char *data);

  • 功能:好友申请被接受通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMFriendReqInfo

notifyFriendReqRejected

  • 函数原型:virtual void CRIMCallbacker::notifyFriendReqRejected(const char *data);

  • 功能:好友申请被拒绝通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMFriendReqInfo

notifyBlackListAdded

  • 函数原型:virtual void CRIMCallbacker::notifyBlackListAdded(const char *data);

  • 功能:好友黑名单新增通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMBlackListInfo

notifyBlackListDeleted

  • 函数原型:virtual void CRIMCallbacker::notifyBlackListDeleted(const char *data);

  • 功能:好友黑名单移除通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMBlackListInfo

群组

createGrp

  • 函数原型: void CRIMManager::createGrp(const char* data, const char *cookie = "");

  • 功能:创建群

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 建群参数, json字符串, 定义参见:CRIMGrpCreateInfo
cookie char* 否 上下文参数,在回调时带回

joinGrp

  • 函数原型: void CRIMManager::joinGrp(const char* gid, const char* reqMsg, CRIMJoinType joinSource, const char* ex, const char *cookie = "");

  • 功能:申请加入群组

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
reqMsg char* 是 申请描述信息
joinSource CRIMJoinType 是 进群方式
ex char* 否 扩展信息
cookie char* 否 上下文参数,在回调时带回

quitGrp

  • 函数原型: void CRIMManager::quitGrp(const char* gid, const char *cookie = "");

  • 功能:退群。 退出时并不会删除会话,如要删除会话,可以调用删除会话的函数deleteConversationAndDeleteAllMsg。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
cookie char* 否 上下文参数,在回调时带回

isJoinGrp

  • 函数原型: void CRIMManager::isJoinGrp(const char* gid, const char *cookie = "");

  • 功能:检测自已是否为目标群成员

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
cookie char* 否 上下文参数,在回调时带回

getJoinedGrpList

  • 函数原型: void CRIMManager::getJoinedGrpList(const char *cookie = "");

  • 功能:获取已加入的群列表

  • 返回值:无

  • 参数:

参数 类型 必传 含义
cookie char* 否 上下文参数,在回调时带回

getSpecifiedGrpsInfo

  • 函数原型: void CRIMManager::getSpecifiedGrpsInfo(const char* gids, const char *cookie = "");

  • 功能:获取指定群资料

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gids char* 是 json字符串, 群ID列表
cookie char* 否 上下文参数,在回调时带回

setGrpInfo

  • 函数原型: void CRIMManager::setGrpInfo(const char* data, const char *cookie = "");

  • 功能:更新群资料。 仅群主和管理员有权限。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 群资料, json字符串, CRIMGrpInfo
cookie char* 否 上下文参数,在回调时带回

getGrpMemberList

  • 函数原型: void CRIMManager::getGrpMemberList(const char* gid, CRIMGroupMemberFilter filter, int offset, int count, const char *cookie = "");

  • 功能:获取群成员列表

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
filter CRIMGroupMemberFilter 是 群成员过滤选项
offset int 是 起始偏移量
count int 是 获取的数量
cookie char* 否 上下文参数,在回调时带回

getSpecifiedGrpMembersInfo

  • 函数原型: void CRIMManager::getSpecifiedGrpMembersInfo(const char* gid, const char* userIDs, const char *cookie = "");

  • 功能:获取群内指定群成员信息

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
userIDs char* 是 json字符串, 用户ID列表
cookie char* 否 上下文参数,在回调时带回

kickGrpMember

  • 函数原型: void CRIMManager::kickGrpMember(const char* gid, const char* reason, const char* userIDs, const char *cookie = "");

  • 功能:踢出群。 仅群主和管理员有权限。 被踢出群后并不会删除会话,如要删除会话,可以调用删除会话的函数deleteConversationAndDeleteAllMsg。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
reason char* 是 原因描述
userIDs char* 是 json字符串, 要踢出群的用户id列表
cookie char* 否 上下文参数,在回调时带回

transferGrpOwner

  • 函数原型: void CRIMManager::transferGrpOwner(const char* gid, const char* userID, const char *cookie = "");

  • 功能:转让群主。仅群主能操作。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
userID char* 是 用户id
cookie char* 否 上下文参数,在回调时带回

inviteUserToGrp

  • 函数原型: void CRIMManager::inviteUserToGrp(const char* gid, const char* reason, const char* userIDs, const char *cookie = "");

  • 功能:邀请入群

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
reason char* 是 原因描述
userIDs char* 是 json字符串,邀请的用户id列表
cookie char* 否 上下文参数,在回调时带回

getGrpReqListAsRecipient

  • 函数原型: void CRIMManager::getGrpReqListAsRecipient(const char* reqDat, const char *cookie = "");

  • 功能:获取收到的群成员申请进群列表

  • 返回值:无

  • 参数:

参数 类型 必传 含义
reqDat char* 是 json字符串, 详见后面reqDat说明
cookie char* 否 上下文参数,在回调时带回

reqDat说明:

参数 类型 必传 含义
offset int 是 获取的起始位置
count int 是 获取数量

getGrpReqListAsApplicant

  • 函数原型: void CRIMManager::getGrpReqListAsApplicant(const char* reqDat, const char *cookie = "");

  • 功能:获取发出的入群申请列表

  • 返回值:无

  • 参数:

参数 类型 必传 含义
reqDat char* 是 json字符串, 详见后面reqDat说明
cookie char* 否 上下文参数,在回调时带回

reqDat说明:

参数 类型 必传 含义
offset int 是 获取的起始位置
count int 是 获取数量

acceptGrpReq

  • 函数原型: void CRIMManager::acceptGrpReq(const char* gid, const char* userID, const char* handleMsg, const char *cookie = "");

  • 功能:同意某人进入某群。 仅群主和管理员有权限。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
userID char* 是 用户ID
handleMsg char* 是 处理说明
cookie char* 否 上下文参数,在回调时带回

refuseGrpReq

  • 函数原型: void CRIMManager::refuseGrpReq(const char* gid, const char* userID, const char* handleMsg, const char *cookie = "");

  • 功能:拒绝某人进入某群。 仅群主和管理员有权限。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
userID char* 是 用户ID
handleMsg char* 是 处理说明
cookie char* 否 上下文参数,在回调时带回

dismissGrp

  • 函数原型: void CRIMManager::dismissGrp(const char* gid, const char *cookie = "");

  • 功能:解散群。 仅群主有权限。 群解散后并不会删除会话,如要删除会话,可以调用删除会话的函数deleteConversationAndDeleteAllMsg。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
cookie char* 否 上下文参数,在回调时带回

changeGrpMemberMute

  • 函数原型: void CRIMManager::changeGrpMemberMute(const char* gid, const char* userID, int mutedSeconds, const char *cookie = "");

  • 功能:禁言或取消禁言某群成员。 仅群主和管理员有权限。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
userID char* 是 用户ID
mutedSeconds int 是 禁主时长,单位秒。 0代表取消禁言
cookie char* 否 上下文参数,在回调时带回

changeGrpMute

  • 函数原型: void CRIMManager::changeGrpMute(const char* gid, bool isMute, const char *cookie = "");

  • 功能:设置群禁言状态。 仅群主和管理员有权限。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
isMute bool 是 是否禁言
cookie char* 否 上下文参数,在回调时带回

searchGrps

  • 函数原型: void CRIMManager::searchGrps(const char* data, const char *cookie = "");

  • 功能:搜索群

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 搜索参数
cookie char* 否 上下文参数,在回调时带回

data说明:

参数 类型 必传 含义
keywordList list<string> 是 关键词列表,目前仅支持单个关键词
isSearchGroupID bool 是 是否以关键词搜索群组ID
isSearchGroupName bool 是 是否以关键词搜索群名字

setGrpMemberInfo

  • 函数原型: void CRIMManager::setGrpMemberInfo(const char* data, const char *cookie = "");

  • 功能:群主可以修改管理员和普通成员信息,管理员可以修改普通成员信息

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串,定义参见:CRIMGrpMemberInfo
cookie char* 否 上下文参数,在回调时带回

setGrpMemberNickname

  • 函数原型: void CRIMManager::setGrpMemberNickname(const char* gid, const char* userID, const char* nickname, const char *cookie = "");

  • 功能:群主可以修改管理员和普通成员昵称,管理员可以修改普通成员昵称

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
userID char* 是 用户ID
nickname char* 是 新的群内昵称
cookie char* 否 上下文参数,在回调时带回

setGrpMemberRoleLevel

  • 函数原型: void CRIMManager::setGrpMemberRoleLevel(const char* gid, const char* userID, const char* nickname, const char *cookie = "");

  • 功能:群主可以修改管理员和普通成员的身份,管理员可以修改普通成员昵称

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
userID char* 是 用户ID
nickname char* 是 新的群内昵称
cookie char* 否 上下文参数,在回调时带回

getGrpMemberListByJoinTimeFilter

  • 函数原型: void CRIMManager::getGrpMemberListByJoinTimeFilter(const char* gid, int offset, int count, int64_t joinTimeBegin, int64_t joinTimeEnd, const char* filterUserIDList, const char *cookie = "");

  • 功能:根据加入时间分页获取组成员列表

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
offset int 是 起始偏移量
count int 是 获取的数量
joinTimeBegin int64_t 是 加入开始时间,为0时不限制
joinTimeEnd int64_t 是 加入结束时间,为0时不限制
cookie char* 否 上下文参数,在回调时带回

setGrpVerification

  • 函数原型: void CRIMManager::setGrpVerification(const char* gid, CRIMGroupVerificationType verificationType, const char *cookie = "");

  • 功能:设置进群验证方式

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
verificationType CRIMGroupVerificationType 是 验证方式
cookie char* 否 上下文参数,在回调时带回

getGrpMemberOwnerAndAdmin

  • 函数原型: void CRIMManager::getGrpMemberOwnerAndAdmin(const char* gid, const char *cookie = "");

  • 功能:获取拥有者和管理者

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
cookie char* 否 上下文参数,在回调时带回

setGrpApplyMemberFriend

  • 函数原型: void CRIMManager::setGrpApplyMemberFriend(const char* gid, int rule, const char *cookie = "");

  • 功能:设置群成员之间是否可添加好友

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
rule int 是 0:可添加(默认值), 1:不可添加
cookie char* 否 上下文参数,在回调时带回

setGrpLookMemberInfo

  • 函数原型: void CRIMManager::setGrpLookMemberInfo(const char* gid, int rule, const char *cookie = "");

  • 功能:设置能否查看群成员信息

  • 返回值:无

  • 参数:

参数 类型 必传 含义
gid char* 是 群ID
rule int 是 0:可查看(默认值), 1:不可查看
cookie char* 否 上下文参数,在回调时带回

searchGrpMembers

  • 函数原型: void CRIMManager::searchGrpMembers(const char* data, const char *cookie = "");

  • 功能:搜索群成员

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 搜索参数, json字符串
cookie char* 否 上下文参数,在回调时带回

data说明:

参数 类型 必传 含义
groupID string 是 群ID
keywordList list<string> 是 搜索的关键词列表, 目前仅支持单个关键词
isSearchUserID bool 是 是否搜索用户ID
isSearchMemberNickname bool 是 是否搜索昵称
offset int 是 起始偏移量
count int 是 获取的数量

createGrpSuccess

  • 函数原型:virtual void CRIMCallbacker::createGrpSuccess(const char *data, const char *cookie);

  • 功能:createGrp成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMGrpInfo
cookie char* 是 上下文参数

createGrpFailure

  • 函数原型:virtual void CRIMCallbacker::createGrpFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:createGrp失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

joinGrpSuccess

  • 函数原型:virtual void CRIMCallbacker::joinGrpSuccess(const char *data, const char *cookie);

  • 功能:joinGrp成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

joinGrpFailure

  • 函数原型:virtual void CRIMCallbacker::joinGrpFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:joinGrp失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

quitGrpSuccess

  • 函数原型:virtual void CRIMCallbacker::quitGrpSuccess(const char *data, const char *cookie);

  • 功能:quitGrp成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

quitGrpFailure

  • 函数原型:virtual void CRIMCallbacker::quitGrpFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:quitGrp失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

isJoinGrpSuccess

  • 函数原型:virtual void CRIMCallbacker::isJoinGrpSuccess(const char *data, const char *cookie);

  • 功能:isJoinGrp成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

isJoinGrpFailure

  • 函数原型:virtual void CRIMCallbacker::isJoinGrpFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:isJoinGrp失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getJoinedGrpListSuccess

  • 函数原型:virtual void CRIMCallbacker::getJoinedGrpListSuccess(const char *data, const char *cookie);

  • 功能:getJoinedGrpList成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMGrpInfo>
cookie char* 是 上下文参数

getJoinedGrpListFailure

  • 函数原型:virtual void CRIMCallbacker::getJoinedGrpListFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getJoinedGrpList失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getSpecifiedGrpsInfoSuccess

  • 函数原型:virtual void CRIMCallbacker::getSpecifiedGrpsInfoSuccess(const char *data, const char *cookie);

  • 功能:getSpecifiedGrpsInfo成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMGrpInfo>
cookie char* 是 上下文参数

getSpecifiedGrpsInfoFailure

  • 函数原型:virtual void CRIMCallbacker::getSpecifiedGrpsInfoFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getSpecifiedGrpsInfo失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

setGrpInfoSuccess

  • 函数原型:virtual void CRIMCallbacker::setGrpInfoSuccess(const char *data, const char *cookie);

  • 功能:setGrpInfo成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

setGrpInfoFailure

  • 函数原型:virtual void CRIMCallbacker::setGrpInfoFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:setGrpInfo失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getGrpMemberListSuccess

  • 函数原型:virtual void CRIMCallbacker::getGrpMemberListSuccess(const char *data, const char *cookie);

  • 功能:getGrpMemberList成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMGrpMemberInfo>
cookie char* 是 上下文参数

getGrpMemberListFailure

  • 函数原型:virtual void CRIMCallbacker::getGrpMemberListFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getGrpMemberList失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getSpecifiedGrpMembersInfoSuccess

  • 函数原型:virtual void CRIMCallbacker::getSpecifiedGrpMembersInfoSuccess(const char *data, const char *cookie);

  • 功能:getSpecifiedGrpMembersInfo成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMGrpMemberInfo>
cookie char* 是 上下文参数

getSpecifiedGrpMembersInfoFailure

  • 函数原型:virtual void CRIMCallbacker::getSpecifiedGrpMembersInfoFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getSpecifiedGrpMembersInfo失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

kickGrpMemberSuccess

  • 函数原型:virtual void CRIMCallbacker::kickGrpMemberSuccess(const char *data, const char *cookie);

  • 功能:kickGrpMember成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMSimpleResultInfo>
cookie char* 是 上下文参数

kickGrpMemberFailure

  • 函数原型:virtual void CRIMCallbacker::kickGrpMemberFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:kickGrpMember失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

transferGrpOwnerSuccess

  • 函数原型:virtual void CRIMCallbacker::transferGrpOwnerSuccess(const char *data, const char *cookie);

  • 功能:transferGrpOwner成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

transferGrpOwnerFailure

  • 函数原型:virtual void CRIMCallbacker::transferGrpOwnerFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:transferGrpOwner失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

inviteUserToGrpSuccess

  • 函数原型:virtual void CRIMCallbacker::inviteUserToGrpSuccess(const char *data, const char *cookie);

  • 功能:inviteUserToGrp成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMSimpleResultInfo>
cookie char* 是 上下文参数

inviteUserToGrpFailure

  • 函数原型:virtual void CRIMCallbacker::inviteUserToGrpFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:inviteUserToGrp失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getGrpReqListAsRecipientSuccess

  • 函数原型:virtual void CRIMCallbacker::getGrpReqListAsRecipientSuccess(const char *data, const char *cookie);

  • 功能:getGrpReqListAsRecipient成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMGrpReqInfo>
cookie char* 是 上下文参数

getGrpReqListAsRecipientFailure

  • 函数原型:virtual void CRIMCallbacker::getGrpReqListAsRecipientFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getGrpReqListAsRecipient失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getGrpReqListAsApplicantSuccess

  • 函数原型:virtual void CRIMCallbacker::getGrpReqListAsApplicantSuccess(const char *data, const char *cookie);

  • 功能:getGrpReqListAsApplicant成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMGrpReqInfo>
cookie char* 是 上下文参数

getGrpReqListAsApplicantFailure

  • 函数原型:virtual void CRIMCallbacker::getGrpReqListAsApplicantFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getGrpReqListAsApplicant失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

acceptGrpReqSuccess

  • 函数原型:virtual void CRIMCallbacker::acceptGrpReqSuccess(const char *data, const char *cookie);

  • 功能:acceptGrpReq成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

acceptGrpReqFailure

  • 函数原型:virtual void CRIMCallbacker::acceptGrpReqFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:acceptGrpReq失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

refuseGrpReqSuccess

  • 函数原型:virtual void CRIMCallbacker::refuseGrpReqSuccess(const char *data, const char *cookie);

  • 功能:refuseGrpReq成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

refuseGrpReqFailure

  • 函数原型:virtual void CRIMCallbacker::refuseGrpReqFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:refuseGrpReq失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

dismissGrpSuccess

  • 函数原型:virtual void CRIMCallbacker::dismissGrpSuccess(const char *data, const char *cookie);

  • 功能:dismissGrp成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

dismissGrpFailure

  • 函数原型:virtual void CRIMCallbacker::dismissGrpFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:dismissGrp失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

changeGrpMemberMuteSuccess

  • 函数原型:virtual void CRIMCallbacker::changeGrpMemberMuteSuccess(const char *data, const char *cookie);

  • 功能:changeGrpMemberMute成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

changeGrpMemberMuteFailure

  • 函数原型:virtual void CRIMCallbacker::changeGrpMemberMuteFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:changeGrpMemberMute失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

changeGrpMuteSuccess

  • 函数原型:virtual void CRIMCallbacker::changeGrpMuteSuccess(const char *data, const char *cookie);

  • 功能:changeGrpMute成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

changeGrpMuteFailure

  • 函数原型:virtual void CRIMCallbacker::changeGrpMuteFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:changeGrpMute失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

searchGrpsSuccess

  • 函数原型:virtual void CRIMCallbacker::searchGrpsSuccess(const char *data, const char *cookie);

  • 功能:searchGrps成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMGrpInfo>
cookie char* 是 上下文参数

searchGrpsFailure

  • 函数原型:virtual void CRIMCallbacker::searchGrpsFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:searchGrps失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

setGrpMemberInfoSuccess

  • 函数原型:virtual void CRIMCallbacker::setGrpMemberInfoSuccess(const char *data, const char *cookie);

  • 功能:setGrpMemberInfo成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

setGrpMemberInfoFailure

  • 函数原型:virtual void CRIMCallbacker::setGrpMemberInfoFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:setGrpMemberInfo失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

setGrpMemberNicknameSuccess

  • 函数原型:virtual void CRIMCallbacker::setGrpMemberNicknameSuccess(const char *data, const char *cookie);

  • 功能:setGrpMemberNickname成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

setGrpMemberNicknameFailure

  • 函数原型:virtual void CRIMCallbacker::setGrpMemberNicknameFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:setGrpMemberNickname失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

setGrpMemberRoleLevelSuccess

  • 函数原型:virtual void CRIMCallbacker::setGrpMemberRoleLevelSuccess(const char *data, const char *cookie);

  • 功能:setGrpMemberRoleLevel成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

setGrpMemberRoleLevelFailure

  • 函数原型:virtual void CRIMCallbacker::setGrpMemberRoleLevelFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:setGrpMemberRoleLevel失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getGrpMemberListByJoinTimeFilterSuccess

  • 函数原型:virtual void CRIMCallbacker::getGrpMemberListByJoinTimeFilterSuccess(const char *data, const char *cookie);

  • 功能:getGrpMemberListByJoinTimeFilter成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMGrpMemberInfo>
cookie char* 是 上下文参数

getGrpMemberListByJoinTimeFilterFailure

  • 函数原型:virtual void CRIMCallbacker::getGrpMemberListByJoinTimeFilterFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getGrpMemberListByJoinTimeFilter失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

setGrpVerificationSuccess

  • 函数原型:virtual void CRIMCallbacker::setGrpVerificationSuccess(const char *data, const char *cookie);

  • 功能:setGrpVerification成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

setGrpVerificationFailure

  • 函数原型:virtual void CRIMCallbacker::setGrpVerificationFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:setGrpVerification失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getGrpMemberOwnerAndAdminSuccess

  • 函数原型:virtual void CRIMCallbacker::getGrpMemberOwnerAndAdminSuccess(const char *data, const char *cookie);

  • 功能:getGrpMemberOwnerAndAdmin成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMGrpMemberInfo>
cookie char* 是 上下文参数

getGrpMemberOwnerAndAdminFailure

  • 函数原型:virtual void CRIMCallbacker::getGrpMemberOwnerAndAdminFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getGrpMemberOwnerAndAdmin失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

setGrpApplyMemberFriendSuccess

  • 函数原型:virtual void CRIMCallbacker::setGrpApplyMemberFriendSuccess(const char *data, const char *cookie);

  • 功能:setGrpApplyMemberFriend成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

setGrpApplyMemberFriendFailure

  • 函数原型:virtual void CRIMCallbacker::setGrpApplyMemberFriendFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:setGrpApplyMemberFriend失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

setGrpLookMemberInfoSuccess

  • 函数原型:virtual void CRIMCallbacker::setGrpLookMemberInfoSuccess(const char *data, const char *cookie);

  • 功能:setGrpLookMemberInfo成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

setGrpLookMemberInfoFailure

  • 函数原型:virtual void CRIMCallbacker::setGrpLookMemberInfoFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:setGrpLookMemberInfo失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

searchGrpMembersSuccess

  • 函数原型:virtual void CRIMCallbacker::searchGrpMembersSuccess(const char *data, const char *cookie);

  • 功能:searchGrpMembers成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:list<CRIMGrpMemberInfo>
cookie char* 是 上下文参数

searchGrpMembersFailure

  • 函数原型:virtual void CRIMCallbacker::searchGrpMembersFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:searchGrpMembers失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

notifyGrpInfoChanged

  • 函数原型:virtual void CRIMCallbacker::notifyGrpInfoChanged(const char *data);

  • 功能:群信息变化通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMGrpInfo

notifyJoinedGrpDismissed

  • 函数原型:virtual void CRIMCallbacker::notifyJoinedGrpDismissed(const char *data);

  • 功能:群信息变化通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMGrpInfo

notifyJoinedGrpAdded

  • 函数原型:virtual void CRIMCallbacker::notifyJoinedGrpAdded(const char *data);

  • 功能:进入群通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMGrpInfo

notifyJoinedGrpDeleted

  • 函数原型:virtual void CRIMCallbacker::notifyJoinedGrpDeleted(const char *data);

  • 功能:离开群通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMGrpInfo

notifyGrpMemberInfoChanged

  • 函数原型:virtual void CRIMCallbacker::notifyGrpMemberInfoChanged(const char *data);

  • 功能:群成员信息变化通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMGrpMemberInfo

notifyGrpMemberAdded

  • 函数原型:virtual void CRIMCallbacker::notifyGrpMemberAdded(const char *data);

  • 功能:有新成员加入群通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMGrpMemberInfo

notifyGrpMemberDeleted

  • 函数原型:virtual void CRIMCallbacker::notifyGrpMemberDeleted(const char *data);

  • 功能:有成员离开群通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMGrpMemberInfo

notifyGrpReqAdded

  • 函数原型:virtual void CRIMCallbacker::notifyGrpReqAdded(const char *data);

  • 功能:有人申请加群通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMGrpReqInfo

notifyGrpReqDeleted

  • 函数原型:virtual void CRIMCallbacker::notifyGrpReqDeleted(const char *data);

  • 功能:群申请删除通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMGrpReqInfo

notifyGrpReqAccepted

  • 函数原型:virtual void CRIMCallbacker::notifyGrpReqAccepted(const char *data);

  • 功能:群申请被接受通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMGrpReqInfo

notifyGrpReqRejected

  • 函数原型:virtual void CRIMCallbacker::notifyGrpReqRejected(const char *data);

  • 功能:群申请被接受通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMGrpReqInfo

消息

createTextMsg

  • 函数原型:CRIMString CRIMManager::createTextMsg(const char *text);

  • 功能:创建文本消息

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
text char* 是 消息内容

createTextAtMsg

  • 函数原型:CRIMString CRIMManager::createTextAtMsg(const char *text, const char *atUserList, const char *atUsersInfo, const char *quoteMsg);

  • 功能:创建@文本消息

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
text char* 是 消息内容
atUserList char* 是 json字符串, @的userID列表
atUsersInfo char* 是 json字符串, @的用户信息列表, 定义参见:list<CRIMAtInfo>
quoteMsg char* 否 json字符串, 引用的消息,可为空。定义参见:CRIMMessage

createImageMsgFromFullPath

  • 函数原型:CRIMString CRIMManager::createImageMsgFromFullPath(const char *imagePath);

  • 功能:通过本地图片路径创建图片消息

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
imagePath char* 是 图片路径

createImageMsgByURL

  • 函数原型:CRIMString CRIMManager::createImageMsgByURL(const char *sourcePath, const char *sourcePicture, const char *bigPicture, const char *snapshotPicture);

  • 功能:通过图片URL创建图片消息

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
sourcePath char* 是 源图完整路径文件名,可以为空
sourcePicture char* 是 json字符串, 源图信息, 定义参见:CRIMPictureInfo
bigPicture char* 是 json字符串, 大图信息, 可为空, 定义参见:CRIMPictureInfo
snapshotPicture char* 是 json字符串, 缩略图信息, 可为空, 定义参见:CRIMPictureInfo

createSoundMsgFromFullPath

  • 函数原型:CRIMString CRIMManager::createSoundMsgFromFullPath(const char *soundPath, int64_t duration);

  • 功能:通过本地音频路径创建音频消息

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
soundPath char* 是 音频完整路径文件名
duration int64_t 是 时长

createSoundMsgByURL

  • 函数原型:CRIMString CRIMManager::createSoundMsgByURL(const char *data);

  • 功能:通过音频URL创建音频消息

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMSoundElem

createVideoMsgFromFullPath

  • 函数原型:CRIMString CRIMManager::createVideoMsgFromFullPath(const char *videoPath, const char *videoType, int64_t duration, const char *snapshotPath);

  • 功能:通过本地视频路径创建视频消息

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
videoPath char* 是 完整路径文件名
videoType char* 是 mine type
duration int64_t 是 时长, 未知时填:-1
snapshotPath char* 是 缩略图完整路径文件名

createVideoMsgByURL

  • 函数原型:CRIMString CRIMManager::createVideoMsgByURL(const char *data);

  • 功能:通过视频URL创建视频消息

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMVideoElem

createFileMsgFromFullPath

  • 函数原型:CRIMString CRIMManager::createFileMsgFromFullPath(const char *filePath, const char *fileName);

  • 功能:通过本地文件创建文件消息

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
filePath char* 是 完整路径文件名
fileName char* 是 显示的文件名

createFileMsgByURL

  • 函数原型:CRIMString CRIMManager::createFileMsgByURL(const char *data);

  • 功能:通过文件URL创建文件消息

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
filePath char* 是 json字符串, 定义参见:CRIMFileElem

createForwardMsg

  • 函数原型:CRIMString CRIMManager::createForwardMsg(const char *msg);

  • 功能:创建转发消息

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
msg char* 是 待转发的消息,json字符串,定义参见:CRIMMessage

createLocationMsg

  • 函数原型:CRIMString CRIMManager::createLocationMsg(const char *description, double longitude, double latitude);

  • 功能:创建位置消息

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
description char* 是 位置描述
longitude double 是 纬度
latitude double 是 经度

createQuoteMsg

  • 函数原型:CRIMString CRIMManager::createQuoteMsg(const char *text, const char *message);

  • 功能:创建引用消息

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
text char* 是 文本内容
message char* 是 待引用的消息,json字符串,定义参见:CRIMMessage

createCardMsg

  • 函数原型:CRIMString CRIMManager::createCardMsg(const char *data);

  • 功能:创建名片消息

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
data char* 是 卡片信息,json字符串,定义参见:CRIMCardElem

createCustomMsg

  • 函数原型:CRIMString CRIMManager::createCustomMsg(const char *data, const char *extension, const char *description);

  • 功能:创建自定义消息

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
data char* 是 自定义文本内容
extension char* 是 自定义扩展内容
description char* 是 描述内容

createMergerMsg

  • 函数原型:CRIMString CRIMManager::createMergerMsg(const char *messageList, const char *title, const char *summaryList);

  • 功能:创建合并消息

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
messageList char* 是 待合并的消息列表,json字符串,定义参见:list<CRIMMessage>
title char* 是 消息标题
summaryList char* 是 消息摘要列表, json字符串, 定义为:list<string>

createFaceMsg

  • 函数原型:CRIMString CRIMManager::createFaceMsg(int index, const char *data);

  • 功能:创建自定义表情

  • 返回值:消息内容, json字符串, 定义参见:CRIMMessage

  • 参数:

参数 类型 必传 含义
index int 是 各端使用同样的表情包时表情的索引(若各端不同步表情包时, 此字段应传-1, 改用data字段)
data char* 是 自定义表情数据, 可为空

sendMsg

  • 函数原型:void CRIMManager::sendMsg(const char *message, const char *recvID, const char *grpID, const char *offlinePushInfo, bool isOnlineOnly, const char *cookie = "");

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

  • 返回值:无

  • 参数:

参数 类型 必传 含义
message char* 是 消息内容, json字符串, 定义参见:list<CRIMMessage>
recvID char* 是 单聊的用户ID,如果为群聊则为""
grpID char* 是 群聊的群ID,如果为单聊则为""
offlinePushInfo char* 是 离线推送的消息, json字符串, 定义参见:list<CRIMOfflinePushInfo>
isOnlineOnly bool 是 消息是否只发送给在线用户
cookie char* 否 上下文参数,在回调时带回

revokeMsg

  • 函数原型:void CRIMManager::revokeMsg(const char *conversationID, const char *clientMsgID, const char *cookie = "");

  • 功能:撤回一条消息。 支持撤回自己的消息,管理员与群主撤回群成员消息。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
conversationID char* 是 会话ID
clientMsgID char* 是 待撤回消息的clientMsgID
cookie char* 否 上下文参数,在回调时带回

typingStatusUpdate

  • 函数原型:void CRIMManager::typingStatusUpdate(const char *recvID, const char *msgTip, const char *cookie = "");

  • 功能:单聊正在输入消息。 接收者将收到notifyRecvNewMsgs通知, 消息类型为CRIM_MsgType_Typing, 消息中的typingElem将存储msgTip数据;

  • 返回值:无

  • 参数:

参数 类型 必传 含义
recvID char* 是 接收者的用户ID
msgTip char* 是 自定义内容
cookie char* 否 上下文参数,在回调时带回

markMsgAsReadByMsgID

  • 函数原型:void CRIMManager::markMsgAsReadByMsgID(const char *conversationID, const char *clientMsgIDs, const char *cookie = "");

  • 功能:标记消息已读

  • 调用标记指定消息已读接口,可以把对应消息标记为已读。
  • 如果是单聊会话内的消息,会给消息的发送方发送已读回执,触发发送方的notifyRecv1v1ReadReceipt回调。
  • 返回值:无

  • 参数:

参数 类型 必传 含义
conversationID char* 是 会话id
clientMsgIDs char* 是 json字符串,消息clientMsgID列表
cookie char* 否 上下文参数,在回调时带回

deleteMsgFromLocal

  • 函数原型:void CRIMManager::deleteMsgFromLocal(const char *conversationID, const char *clientMsgID, const char *cookie = "");

  • 功能:从本地删除一条消息

  • 卸载程序重装后,同步服务器数据时将会重新获取到;
  • 如果删除的是会话的最新消息,则会触发notifyConversationChanged通知。
  • 返回值:无

  • 参数:

参数 类型 必传 含义
conversationID char* 是 会话id
clientMsgIDs char* 是 json字符串,消息clientMsgID列表
cookie char* 否 上下文参数,在回调时带回

deleteMsg

  • 函数原型:void CRIMManager::deleteMsg(const char *conversationID, const char *clientMsgID, const char *cookie = "");

  • 功能:删除一条消息(本地&服务器)

  • 删除操作,不会同步到帐号的其它终端; 但在新的终端上同步服务器数据时,将不再有被删除的消息。
  • 如果删除的是会话的最新消息,则会触发notifyConversationChanged通知。
  • 返回值:无

  • 参数:

参数 类型 必传 含义
conversationID char* 是 会话id
clientMsgIDs char* 是 json字符串,消息clientMsgID列表
cookie char* 否 上下文参数,在回调时带回

deleteAllMsgFromLocal

  • 函数原型:void CRIMManager::deleteAllMsgFromLocal(const char *cookie = "");

  • 功能:从本地删除所有消息

  • 删除本地所有会话中的消息,会话仍会保留。 卸载重装后还能获取到这些消息。
  • 返回值:无

  • 参数:

参数 类型 必传 含义
cookie char* 否 上下文参数,在回调时带回

deleteAllMsg

  • 函数原型:void CRIMManager::deleteAllMsg(const char *cookie = "");

  • 功能:删除所有消息(本地&服务器)

  • 删除消息后,会话仍会保留。
  • 返回值:无

  • 参数:

参数 类型 必传 含义
cookie char* 否 上下文参数,在回调时带回

insertSingleMsgToLocal

  • 函数原型:void CRIMManager::insertSingleMsgToLocal(const char* message, const char* recvID, const char* sendID, const char *cookie = "");

  • 功能:插入一条单聊消息到本地

  • 返回值:无

  • 参数:

参数 类型 必传 含义
message char* 是 待插入的消息,json字符串, 定义参见:list<CRIMMessage>
recvID char* 是 接收者的用户ID
sendID char* 是 发送者的用户ID
cookie char* 否 上下文参数,在回调时带回

insertGrpMsgToLocal

  • 函数原型:void CRIMManager::insertGrpMsgToLocal(const char* message, const char* grpID, const char* sendID, const char *cookie = "");

  • 功能:插入一条群聊消息到本地

  • 返回值:无

  • 参数:

参数 类型 必传 含义
message char* 是 待插入的消息,json字符串, 定义参见:list<CRIMMessage>
grpID char* 是 群ID
sendID char* 是 发送者的用户ID
cookie char* 否 上下文参数,在回调时带回

findMsgList

  • 函数原型:void CRIMManager::findMsgList(const char* params, const char *cookie = "");

  • 功能:根据消息 ID 查找本地消息

  • 返回值:无

  • 参数:

参数 类型 必传 含义
params char* 是 查找配置, json字符串, [{"conversationID":"xxx", "clientMsgIDList":["clientMsgID1", "clientMsgID2"]}]
cookie char* 否 上下文参数,在回调时带回

searchLocalMsgs

  • 函数原型:void CRIMManager::searchLocalMsgs(const char* params, const char *cookie = "");

  • 功能:根据消息 ID 查找本地消息

  • 返回值:无

  • 参数:

参数 类型 必传 含义
params char* 是 找到配置, json字符串
cookie char* 否 上下文参数,在回调时带回

params说明:

参数 类型 必传 含义
conversationID string 是 会话ID
keywordList list<string> 是 关键词列表,目前仅支持单个关键词
keywordListMatchType list<string> 否 关键词匹配模式,1:代表与,2:代表或,暂时未用
senderUserIDList list<string> 否 用户ID列表
messageTypeList list<CRIMMsgType> 否 消息类型列表
searchTimePosition int 否 起始时间,UTC时间,单位秒,0表示从当前时间开始
searchTimePeriod int 否 从起始时间往前的秒数,如:3600表示往前1小时,传0表示不限制时间范围
pageIndex int 是 开始页数,首次查询传1
count int 是 每页消息数

getAdvancedHistoryMsgList

  • 函数原型:void CRIMManager::getAdvancedHistoryMsgList(const char* params, const char *cookie = "");

  • 功能:获取某条消息之前的历史消息(获取时间更老的消息)

  • 返回值:无

  • 参数:

参数 类型 必传 含义
params char* 是 配置, json字符串
cookie char* 否 上下文参数,在回调时带回

params说明:

参数 类型 必传 含义
conversationID string 是 会话ID
startClientMsgID string 是 从startClientMsgID开始拉取之前历史消息(结果不包含本条消息)
count int 是 拉取的记录数
lastMinSeq int 否 上一次拉取返回值数据中的lastMinSeq,获取首页不传

getAdvancedHistoryMsgListReverse

  • 函数原型:void CRIMManager::getAdvancedHistoryMsgListReverse(const char* params, const char *cookie = "");

  • 功能:获取某条消息之后的历史消息(获取时间更新的消息)

  • 返回值:无

  • 参数:

参数 类型 必传 含义
params char* 是 配置, json字符串
cookie char* 否 上下文参数,在回调时带回

params说明:

参数 类型 必传 含义
conversationID string 是 会话ID
startClientMsgID string 是 从startClientMsgID开始拉取之后历史消息(结果不包含本条消息)
count int 是 拉取的记录数
lastMinSeq int 否 上一次拉取返回值数据中的lastMinSeq,获取首页不传

setMsgLocalEx

  • 函数原型:void CRIMManager::setMsgLocalEx(const char* conversationID, const char* clientMsgID, const char* localEx, const char *cookie = "");

  • 功能:修改本地消息的ex字段。 (用途如:下载文件后设置本地保存路径等。)

  • 返回值:无

  • 参数:

参数 类型 必传 含义
conversationID char* 是 会话ID
clientMsgID char* 是 消息的clientMsgID
localEx char* 是 ex内容
cookie char* 否 上下文参数,在回调时带回

uploadFile

  • 函数原型:void CRIMManager::uploadFile(const char *param, const char *cookie = "")

  • 功能:上传文件到服务器

  • 返回值:无

  • 参数:

参数 类型 必传 含义
param char* 是 json字符串, 上传参数
cookie char* 否 上下文参数,在回调时带回

params说明:

参数 类型 必传 含义
filepath string 是 完整路径文件名
name string 是 文件名(显示给用户)
cause string 否 文件分类
contentType string 否 文件的mimeType

sendMsgSuccess

  • 函数原型:virtual void CRIMCallbacker::sendMsgSuccess(const char *data, const char *cookie);

  • 功能:sendMsg成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

sendMsgFailure

  • 函数原型:virtual void CRIMCallbacker::sendMsgFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:sendMsg失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

sendMsgProgress

  • 函数原型:virtual void CRIMCallbacker::sendMsgProgress(int progress, const char *cookie);

  • 功能:sendMsg进度通知。 需要sdk内部上传文件的消息才会有此通知。

  • 返回值:无

  • 参数:

参数 类型 必传 含义
progress int 是 上传进度0~100;
cookie char* 是 上下文参数

revokeMsgSuccess

  • 函数原型:virtual void CRIMCallbacker::revokeMsgSuccess(const char *data, const char *cookie);

  • 功能:revokeMsg成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

revokeMsgFailure

  • 函数原型:virtual void CRIMCallbacker::revokeMsgFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:revokeMsg失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

typingStatusUpdateSuccess

  • 函数原型:virtual void CRIMCallbacker::typingStatusUpdateSuccess(const char *data, const char *cookie);

  • 功能:typingStatusUpdate成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

typingStatusUpdateFailure

  • 函数原型:virtual void CRIMCallbacker::typingStatusUpdateFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:typingStatusUpdate失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

markMsgAsReadByMsgIDSuccess

  • 函数原型:virtual void CRIMCallbacker::markMsgAsReadByMsgIDSuccess(const char *data, const char *cookie);

  • 功能:markMsgAsReadByMsgID成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

markMsgAsReadByMsgIDFailure

  • 函数原型:virtual void CRIMCallbacker::markMsgAsReadByMsgIDFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:markMsgAsReadByMsgID失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

deleteMsgFromLocalSuccess

  • 函数原型:virtual void CRIMCallbacker::deleteMsgFromLocalSuccess(const char *data, const char *cookie);

  • 功能:deleteMsgFromLocal成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

deleteMsgFromLocalFailure

  • 函数原型:virtual void CRIMCallbacker::deleteMsgFromLocalFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:deleteMsgFromLocal失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

deleteMsgSuccess

  • 函数原型:virtual void CRIMCallbacker::deleteMsgSuccess(const char *data, const char *cookie);

  • 功能:deleteMsg成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

deleteMsgFailure

  • 函数原型:virtual void CRIMCallbacker::deleteMsgFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:deleteMsg失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

deleteAllMsgFromLocalSuccess

  • 函数原型:virtual void CRIMCallbacker::deleteAllMsgFromLocalSuccess(const char *data, const char *cookie);

  • 功能:deleteAllMsgFromLocal成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

deleteAllMsgFromLocalFailure

  • 函数原型:virtual void CRIMCallbacker::deleteAllMsgFromLocalFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:deleteAllMsgFromLocal失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

deleteAllMsgSuccess

  • 函数原型:virtual void CRIMCallbacker::deleteAllMsgSuccess(const char *data, const char *cookie);

  • 功能:deleteAllMsg成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

deleteAllMsgFailure

  • 函数原型:virtual void CRIMCallbacker::deleteAllMsgFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:deleteAllMsg失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

insertSingleMsgToLocalSuccess

  • 函数原型:virtual void CRIMCallbacker::insertSingleMsgToLocalSuccess(const char *data, const char *cookie);

  • 功能:insertSingleMsgToLocal成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

insertSingleMsgToLocalFailure

  • 函数原型:virtual void CRIMCallbacker::insertSingleMsgToLocalFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:insertSingleMsgToLocal失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

insertGrpMsgToLocalSuccess

  • 函数原型:virtual void CRIMCallbacker::insertGrpMsgToLocalSuccess(const char *data, const char *cookie);

  • 功能:insertGrpMsgToLocal成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

insertGrpMsgToLocalFailure

  • 函数原型:virtual void CRIMCallbacker::insertGrpMsgToLocalFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:insertGrpMsgToLocal失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

findMsgListSuccess

  • 函数原型:virtual void CRIMCallbacker::findMsgListSuccess(const char *data, const char *cookie);

  • 功能:findMsgList成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 查找结果,json字符串
cookie char* 是 上下文参数

data说明:

参数 类型 必传 含义
totalCount int 是 获取到的总的消息数量
findResultItems list<CRIMSearchResultItem> 是 获取到的消息列表

findMsgListFailure

  • 函数原型:virtual void CRIMCallbacker::findMsgListFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:findMsgList失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

searchLocalMsgsSuccess

  • 函数原型:virtual void CRIMCallbacker::searchLocalMsgsSuccess(const char *data, const char *cookie);

  • 功能:searchLocalMsgs成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 查找结果,json字符串
cookie char* 是 上下文参数

data说明:

参数 类型 必传 含义
totalCount int 是 获取到的总的消息数量
searchResultItems list<CRIMSearchResultItem> 是 获取到的消息列表

searchLocalMsgsFailure

  • 函数原型:virtual void CRIMCallbacker::searchLocalMsgsFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:searchLocalMsgs失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getAdvancedHistoryMsgListSuccess

  • 函数原型:virtual void CRIMCallbacker::getAdvancedHistoryMsgListSuccess(const char *data, const char *cookie);

  • 功能:getAdvancedHistoryMsgList成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 查找结果,json字符串,定义为:CRIMAdvancedMsg
cookie char* 是 上下文参数

getAdvancedHistoryMsgListFailure

  • 函数原型:virtual void CRIMCallbacker::getAdvancedHistoryMsgListFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getAdvancedHistoryMsgList失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

getAdvancedHistoryMsgListReverseSuccess

  • 函数原型:virtual void CRIMCallbacker::getAdvancedHistoryMsgListReverseSuccess(const char *data, const char *cookie);

  • 功能:getAdvancedHistoryMsgListReverse成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 查找结果,json字符串,定义为:CRIMAdvancedMsg
cookie char* 是 上下文参数

getAdvancedHistoryMsgListReverseFailure

  • 函数原型:virtual void CRIMCallbacker::getAdvancedHistoryMsgListReverseFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:getAdvancedHistoryMsgListReverse失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

setMsgLocalExSuccess

  • 函数原型:virtual void CRIMCallbacker::setMsgLocalExSuccess(const char *data, const char *cookie);

  • 功能:setMsgLocalEx成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 保留参数
cookie char* 是 上下文参数

setMsgLocalExFailure

  • 函数原型:virtual void CRIMCallbacker::setMsgLocalExFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:setMsgLocalEx失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

uploadFileSuccess

  • 函数原型:virtual void CRIMCallbacker::uploadFileSuccess(const char *data, const char *cookie);

  • 功能:uploadFile成功回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 上传结果url,json字符串, {"url":"xxx"}
cookie char* 是 上下文参数

uploadFileFailure

  • 函数原型:virtual void CRIMCallbacker::uploadFileFailure(int errCode, const char *errMsg, const char *cookie);

  • 功能:uploadFile失败回调

  • 返回值:无

  • 参数:

参数 类型 必传 含义
errCode int 是 错误码
errMsg char* 是 错误描述
cookie char* 是 上下文参数

uploadFileProgress

  • 函数原型:virtual void CRIMCallbacker::uploadFileProgress(int64_t totalBytes, int64_t currentBytes, int64_t saveBytes, const char *cookie);

  • 功能:uploadFile进度

  • 返回值:无

  • 参数:

参数 类型 必传 含义
totalBytes int64_t 是 总大小
currentBytes int64_t 是 已传输大小
saveBytes int64_t 是 保留参数
cookie char* 是 上下文参数

notifyRecvNewMsgs

  • 函数原型:virtual void CRIMCallbacker::notifyRecvNewMsgs(const char *data);

  • 功能:收到新消息通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 新消息列表, json字符串, 定义参见:list<CRIMMessage>

notifyRecvMsgRevoked

  • 函数原型:virtual void CRIMCallbacker::notifyRecvMsgRevoked(const char *data);

  • 功能:收到消息撤回通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMRevokedInfo

notifyMsgDeleted

  • 函数原型:virtual void CRIMCallbacker::notifyMsgDeleted(const char *data);

  • 功能:收到消息删除通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMMessage

notifyRecv1v1ReadReceipt

  • 函数原型:virtual void CRIMCallbacker::notifyRecv1v1ReadReceipt(const char *data);

  • 功能:单聊消息已读回执通知

  • 返回值:无

  • 参数:

参数 类型 必传 含义
data char* 是 json字符串, 定义参见:CRIMReadReceiptInfo