apicloud融云模块文档笔记

apicloud融云模块文档笔记

APICloud融云模块V2.0.0
方法归类

  • 配置类
  • 发送类
  • 获取信息类
  • 操作类

配置类

-1、 init初始化

var rong = api.require('rongCloud2');

rong.init(function(ret, err){
     
    if (ret.status == 'error')
        api.toast({ msg: err.code });
});

-2、 setConnectionStatusListener
设置连接状态变化的监听器,请在调用 init 方法之后,调用 connect 方法之前设置

var rong = api.require('rongCloud2');

// 之前调用 init 的代码省略

rong.setConnectionStatusListener(function(ret, err){
     
    api.toast({ msg: ret.result.connectionStatus });
});

// 之后调用 connect 的代码省略

-3、 connect
连接融云 IM 服务器,进行后续各种方法操作前务必要先调用此方法

var rong = api.require('rongCloud2');

// 之前调用 init 的代码省略

rong.setConnectionStatusListener(function(ret, err){
     
    api.toast({ msg: ret.result.connectionStatus });
});

rong.connect({
    token: 'ThptTWyiPPPvZHvuSiuri82yq+hfEluLjZ78E1qo4hEVSFQNpqdoPu406urMWKN4Z3/olWR+v9JVLAwfOQoLrA=="},
    function(ret, err){
     
        if (ret.status == 'success')
            api.toast({ msg: ret.result.userId });
});

-4、 disconnect断开连接

var rong = api.require('rongCloud2');

// 之前调用 init 的代码省略

rong.setConnectionStatusListener(function(ret, err){
     
    api.toast({ msg: ret.result.connectionStatus });
});

rong.connect({
    token: 'ThptTWyiPPPvZHvuSiuri82yq+hfEluLjZ78E1qo4hEVSFQNpqdoPu406urMWKN4Z3/olWR+v9JVLAwfOQoLrA=="},
    function(ret, err){
     
        if (ret.status == 'success')
            api.toast({ msg: ret.result.userId });
});


 rong.disconnect({
         isReceivePush: true
     },function (ret, err) {
     
           if ('success' == ret.status) {
               api.toast({msg: '断开连接成功!'});
           }
       }
 );  // 断开,且不再接收 Push
  • 5、setNotificationQuietHours

设置消息通知免打扰时间

setNotificationQuietHours({params}, callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.setNotificationQuietHours({
        startTime: '22:00:00',
        spanMinutes: 6

    }, function (ret, err) {
     
        api.toast({ msg: ret.status });
})
  • 6、removeNotificationQuietHours

移除消息通知免打扰时间

removeNotificationQuietHours(callback(ret, err))

这里写代码片
  • 7、setOnReceiveMessageListener
    设置接收消息的监听器,请在调用 init 方法之后,调用 connect 方法之前设置
    所有接收到的消息、通知、状态都经由此处设置的监听器处理。包括私聊消息、讨论组消息、群组消息、聊天室消息以及各种其他消息、通知、状态等
    setOnReceiveMessageListener(callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 的代码省略

rong.setOnReceiveMessageListener(function (ret, err) {
     
    api.toast({ msg: JSON.stringify(ret.result.message) });
    api.toast({ msg: ret.result.message.left });
})

// 之后调用 connect 的代码省略

发送类

  • conversationType 会话类型
    区分不同的会话形式,字符串类型
    取值范围
    • PRIVATE // 单聊
    • DISCUSSION // 讨论组
    • GROUP // 群组
    • CHATROOM // 聊天室
    • CUSTOMER_SERVICE // 客服
    • SYSTEM // 系统
  • targetId: 接收方ID
  • text:消息的文字内容
  • voicePath:语音文件的路径,支持 fs://,如:fs:///voice/123.amr。文件要求为 AMR 格式
  • duration:语音消息的时长,单位为秒
  • imagePath:图片的路径,支持 fs://,如:fs:///image/123.jpg
  • title:消息的标题
  • description:消息的内容描述
  • imageUrl:消息图片的网络地址
  • latitude: 纬度例如-39.9139**直接传值即可不需要字符串**
  • longitude: 经度例如-116.3917**直接传值即可不需要字符串**
  • poi: 位置的名称例如-‘北京市朝阳区北苑路北辰泰岳大厦’
  • imagePath: 地图缩率图的路径,支持 fs://,如:’fs:///xxx/xxx/location.jpg’,
  • extra:消息的附加信息
  • name:命令的名称
  • data:命令的数据
  • -

列表

  • 1、 sendTextMessage发送文字消息
    sendTextMessage({params}, callback(ret, err))
var rong = api.require('rongCloud2');

rong.init(function(ret, err){
     
    if (ret.status == 'error')
        api.toast({ msg: err.code });
});
// 之前调用 init 的代码省略

rong.setConnectionStatusListener(function(ret, err){
     
    api.toast({ msg: ret.result.connectionStatus });
});

rong.connect({
    token: 'ThptTWyiPPPvZHvuSiuri82yq+hfEluLjZ78E1qo4hEVSFQNpqdoPu406urMWKN4Z3/olWR+v9JVLAwfOQoLrA=="},
    function(ret, err){
     
        if (ret.status == 'success')
            api.toast({ msg: ret.result.userId });
});
rong.sendTextMessage({
        conversationType: 'PRIVATE',
        targetId: '9527',
        text: 'Hello world.',
        extra: ''
    }, function (ret, err) {
     
        if (ret.status == 'prepare')
            api.toast({ msg: JSON.stringify(ret.result.message) });
        else if (ret.status == 'success')
            api.toast({ msg: ret.result.message.messageId });
        else if (ret.status == 'error')
            api.toast({ msg: err.code });
    }
);
  • 2、 sendVoiceMessage发送语音消息
    sendVoiceMessage({params}, callback(ret, err))
  • 3、 sendImageMessage发送图片消息
    sendImageMessage({params}, callback(ret, err))
  • 4、 sendRichContentMessage发送图文消息
    sendRichContentMessage({params}, callback(ret, err))
  • 5、sendCommandNotificationMessage
    发送命令消息,可以用来实现任何自定义消息的发送(例如添加好友)
    sendCommandNotificationMessage({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.sendCommandNotificationMessage({
        conversationType: 'PRIVATE',
        targetId: '9527',
        name: 'AddFriend',
        data: '{\"inviteUserId\":123}'
    }, function (ret, err) {
     
        if (ret.status == 'prepare')
            api.toast({ msg: JSON.stringify(ret.result.message) });
        else if (ret.status == 'success')
            api.toast({ msg: ret.result.message.messageId });
        else if (ret.status == 'error')
            api.toast({ msg: err.code });
    }
);
  • 6、sendCommandMessage
    发送命令消息,您需要这种类型的消息时可以直接使用,不需要再自定义。此消息不保存、不计数。
    sendCommandMessage({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.sendCommandMessage({
        conversationType: 'PRIVATE',
        targetId: '9527',
        name: 'AddFriend',
        data: '{\"inviteUserId\":123}'
    }, function (ret, err) {
     
        if (ret.status == 'prepare')
            api.toast({ msg: JSON.stringify(ret.result.message) });
        else if (ret.status == 'success')
            api.toast({ msg: ret.result.message.messageId });
        else if (ret.status == 'error')
            api.toast({ msg: err.code });
    }
);

获取类

getConnectionStatus

获取连接状态

getConnectionStatus(callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getConnectionStatus(function (ret, err) {
     
        api.toast({ msg: ret.result.connectionStatus });
})

logout

注销登录(不再接收 Push 消息)

logout(callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.logout(function (ret, err) {
     
        if (ret.status == 'error')
            api.toast({ msg: err.code });
}); // 断开,且不再接收 Push
  • 1、getConversationList获取会话列表
    会话列表按照时间从前往后排列,如果有置顶会话,则置顶会话在前
    getConversationList(callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getConversationList(function (ret, err) {
     
    api.toast({ msg: JSON.stringify(ret.result) });
})
  • 2、getConversation获取某一会话信息
    getConversation({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getConversation({
        conversationType: 'PRIVATE',
        targetId: '9527'
    }, function (ret, err) {
     
        api.toast({ msg: JSON.stringify(ret.result) });
})
  • 3、getConversationNotificationStatus获取某一会话的通知状态
    getConversationNotificationStatus({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getConversationNotificationStatus({
        conversationType: 'PRIVATE',
        targetId: '9527'
    }, function (ret, err) {
     
        if (ret.status == 'success')
            api.toast({ msg: ret.result.code });
        else
            api.toast({ msg: err.code });
})
  • 4、getLatestMessages获取某一会话的最新消息记录
    getLatestMessages({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getLatestMessages({
        conversationType: 'PRIVATE',
        targetId: '9527',
        count: 20
    }, function (ret, err) {
     
        api.toast({ msg: JSON.stringify(ret.result) });
})
  • 5、getHistoryMessages获取某一会话的历史消息记录
    getHistoryMessages({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getHistoryMessages({
        conversationType: 'PRIVATE',
        targetId: '9527',
        oldestMessageId: 688,
        count: 20
    }, function (ret, err) {
     
        api.toast({ msg: JSON.stringify(ret.result) });
})
  • 6、getHistoryMessagesByObjectName按照消息类型获取历史消息记录
    getHistoryMessagesByObjectName({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getHistoryMessagesByObjectName({
        conversationType: 'PRIVATE',
        targetId: '9527',
        objectName: 'RC:TxtMsg',
        oldestMessageId: 688,
        count: 20
    }, function (ret, err) {
     
        api.toast({ msg: JSON.stringify(ret.result) });
})
  • 7、getTotalUnreadCount获取所有未读消息数
    getTotalUnreadCount(callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getTotalUnreadCount(function (ret, err) {
     
    api.toast({ msg: ret.result });
})
  • 8、getUnreadCount获取来自某用户(某会话)的未读消息数
    getUnreadCount({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getUnreadCount({
        conversationType: 'PRIVATE',
        targetId: '9527'
    }, function (ret, err) {
     
        api.toast({ msg: ret.result });
})
  • 9、getUnreadCountByConversationTypes
    获取某(些)会话类型的未读消息数
    getUnreadCountByConversationTypes({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getUnreadCountByConversationTypes({
        conversationTypes: ['PRIVATE', 'GROUP']
    }, function (ret, err) {
     
        api.toast({ msg: ret.result });
})
  • 10、getTextMessageDraft获取某一会话的文字消息草稿
    getTextMessageDraft({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getTextMessageDraft({
        conversationType: 'PRIVATE',
        targetId: '9527'
    }, function (ret, err) {
     
        api.toast({ msg: ret.result });
})
  • 11、getRemoteHistoryMessages
    获取历史消息记录(特别说明:调用此方法需要开启历史消息漫游;当用户因换设备或重装app导致本地本地存储丢失的情况,可用此方法获取记录;此方法返回值中messageId均为0,融云服务器不会保存此值)
    getRemoteHistoryMessages({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getRemoteHistoryMessages({
        conversationType: 'PRIVATE',
        targetId: '9527',
        dateTime: 1418971531533,
        count: 20
    }, function (ret, err) {
     
        api.toast({ msg: JSON.stringify(ret.result) });
})
  • 12、getBlacklistStatus

获取某用户是否在黑名单中

getBlacklistStatus({params}, callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getBlacklistStatus({
        userId: '688'
    }, function (ret, err) {
     
        api.toast({ msg: ret.status });
})
  • 13、getBlacklist

获取当前用户的黑名单列表

getBlacklist(callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getBlacklist(function (ret, err) {
     
        api.toast({ msg: JSON.stringify(ret.result) });
})
  • 14、getNotificationQuietHours
    获取消息通知免打扰时间
    getNotificationQuietHours(callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getNotificationQuietHours( function (ret, err) {
     
        api.toast({ msg:  JSON.stringify(ret.result) });
})
  • 15、getCurrentUserId

获取当前连接用户的信息

getCurrentUserId(callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getCurrentUserId( function (ret, err) {
     
        api.toast({ msg: ret.result });
})

操作类(发布命令)

  • 1、removeConversation
    从会话列表中移除某一会话,但是不删除会话内的消息
    如果此会话中有新的消息,该会话将重新在会话列表中显示,并显示最近的历史消息
    removeConversation({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.removeConversation({
        conversationType: 'PRIVATE',
        targetId: '9527'
    }, function (ret, err) {
     
        api.toast({ msg: ret.status });
})
  • 2、clearConversations清空所有会话及会话消息
    clearConversations({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.clearConversations({
        conversationTypes: ['PRIVATE', 'GROUP']
    }, function (ret, err) {
     
        api.toast({ msg: ret.status });
})
  • 3、setConversationToTop设置某一会话为置顶或者取消置顶
    setConversationToTop({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.setConversationToTop({
        conversationType: 'PRIVATE',
        targetId: '9527',
        isTop: true
    }, function (ret, err) {
     
        api.toast({ msg: ret.status });
})
  • 4、setConversationNotificationStatus设置某一会话的通知状态
    setConversationNotificationStatus({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.setConversationNotificationStatus({
        conversationType: 'PRIVATE',
        targetId: '9527',
        notificationStatus: 'DO_NOT_DISTURB'
    }, function (ret, err) {
     
        if (ret.status == 'success')
            api.toast({ msg: ret.result.code });
        else
            api.toast({ msg: err.code });
})
  • 5、deleteMessages删除指定的一条或者一组消息
    deleteMessages({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.deleteMessages({
        messageIds: [688, 689]
    }, function (ret, err) {
     
        api.toast({ msg: ret.status });
})
  • 6、clearMessages清空某一会话的所有聊天消息记录
    clearMessages({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.clearMessages({
        conversationType: 'PRIVATE',
        targetId: '9527'
    }, function (ret, err) {
     
        api.toast({ msg: ret.status });
})
  • 7、setMessageReceivedStatus设置接收到的消息状态
    **UNREAD // 未读
    READ // 已读
    LISTENED // 已收听
    DOWNLOADED // 已下载**
    setMessageReceivedStatus({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.setMessageReceivedStatus({
        messageId: '688',
        receivedStatus: 'READ'
    }, function (ret, err) {
     
        api.toast({ msg: ret.status });
})
  • 8、clearMessagesUnreadStatus清除某一会话的消息未读状态
    clearMessagesUnreadStatus({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.clearMessagesUnreadStatus({
        conversationType: 'PRIVATE',
        targetId: '9527'
    }, function (ret, err) {
     
        api.toast({ msg: ret.status });
})
  • 10、setMessageExtra
    设置消息的附加信息,此信息只保存在本地
    setMessageExtra({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.setMessageExtra({
        messageId: '688',
        value: 'extra info'
    }, function (ret, err) {
     
        api.toast({ msg: ret.status });
})
  • 11、saveTextMessageDraft
    保存某一会话的文字消息草稿
    saveTextMessageDraft({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.saveTextMessageDraft({
        conversationType: 'PRIVATE',
        targetId: '9527',
        content: 'Hello w'
    }, function (ret, err) {
     
        api.toast({ msg: ret.status });
})
  • 12、clearTextMessageDraft
    清除某一会话的文字消息草稿
    clearTextMessageDraft({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.clearTextMessageDraft({
        conversationType: 'PRIVATE',
        targetId: '9527'
    }, function (ret, err) {
     
        api.toast({ msg: ret.status });
})
  • 13、addToBlacklist
    将某个用户加到黑名单中
    addToBlacklist({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.removeFromBlacklist({
        userId: '688'
    }, function (ret, err) {
     
        api.toast({ msg: ret.status });
})
  • 14、removeFromBlacklist
    将个某用户从黑名单中移出
    removeFromBlacklist({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.removeFromBlacklist({
        userId: '688'
    }, function (ret, err) {
     
        api.toast({ msg: ret.status });
})
  • 15、setMessageSentStatus

设置消息发送状态

setMessageSentStatus({params}, callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.setMessageSentStatus({
        messageId: 8,
        sentStatus: 'READ'
    }, function (ret, err) {
     
        api.toast({ msg: ret.status });
})
  • 16、disableLocalNotification

设置本地消息不提示

disableLocalNotification(callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.disableLocalNotification( function (ret, err) {
     
        api.toast({ msg: ret.status });
})

创建讨论组 建群等相关操作

  • 1、createDiscussion创建讨论组
    createDiscussion({params}, callback(ret, err))
var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.createDiscussion({
        name: 'Ironman, Batman',//讨论组名称,如:当前所有成员的名字的组合。
        userIdList: ['1234', '4321']//讨论组成员 Id 列表
    }, function (ret, err) {
     
        if (ret.status == 'success')
            api.toast({ msg: ret.result.discussionId });
        else
            api.toast({ msg: err.code });
})

返回字段包括创建成功的讨论组id
ret返回值

{
    status: 'success', // 状态码:success / error
    result: {
        discussionId: "1b9f7abe-a5ae-463d-8ff8-d96deaf40b59" // 创建成功的讨论组 Id
    }
}
  • 2、getDiscussion

获取讨论组信息和设置

getDiscussion({params}, callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.getDiscussion({
        discussionId: '1b9f7abe-a5ae-463d-8ff8-d96deaf40b59'
    }, function (ret, err) {
     
        if (ret.status == 'success')
            api.toast({ msg: JSON.stringify(ret.result.discussion) });
        else
            api.toast({ msg: err.code });
})

ret返回值

{
    status: 'success', // 状态码:success / error
    result: {
        creatorId: '55', // 讨论组创建者 Id
        id: '1b9f7abe-a5ae-463d-8ff8-d96deaf40b59', //讨论组 Id
        name: 'Ironman, Batman', // 讨论组名称
        memberIdList: [ '1234', '4321' ], // 成员 Id 列表
        inviteStatus: 'OPENED' // 是否公开好友邀请:OPENED / CLOSED,参见 讨论组邀请状态
    }
}
  • 3、setDiscussionName

设置讨论组名称

setDiscussionName({params}, callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.setDiscussionName({
        discussionId: '1b9f7abe-a5ae-463d-8ff8-d96deaf40b59',
        name: 'Ironman, Hulk'
    }, function (ret, err) {
     
        if (ret.status == 'success')
            api.toast({ msg: JSON.stringify(ret.status) });
        else
            api.toast({ msg: err.code });
})
  • 4、addMemberToDiscussion

添加一名或者一组用户加入讨论组

addMemberToDiscussion({params}, callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.addMemberToDiscussion({
        discussionId: '1b9f7abe-a5ae-463d-8ff8-d96deaf40b59',
        userIdList: ['4567', '7654']
    }, function (ret, err) {
     
        if (ret.status == 'success')
            api.toast({ msg: JSON.stringify(ret.status) });
        else
            api.toast({ msg: err.code });
})
  • 5、removeMemberFromDiscussion

供创建者将某用户移出讨论组

移出自己或者调用者非讨论组创建者将产生 -1 未知错误

removeMemberFromDiscussion({params}, callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.removeMemberFromDiscussion({
        discussionId: '1b9f7abe-a5ae-463d-8ff8-d96deaf40b59',
        userId: '4567'
    }, function (ret, err) {
     
        if (ret.status == 'success')
            api.toast({ msg: JSON.stringify(ret.status) });
        else
            api.toast({ msg: err.code });
})
  • 6、quitDiscussion

退出当前用户所在的某讨论组

quitDiscussion({params}, callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.quitDiscussion({
        discussionId: '1b9f7abe-a5ae-463d-8ff8-d96deaf40b59'
    }, function (ret, err) {
     
        if (ret.status == 'success')
            api.toast({ msg: JSON.stringify(ret.status) });
        else
            api.toast({ msg: err.code });
})
  • 7、setDiscussionInviteStatus

设置讨论组成员邀请权限

取值范围
OPENED // 开放邀请
CLOSED // 关闭邀请
setDiscussionInviteStatus({params}, callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.setDiscussionInviteStatus({
        discussionId: '1b9f7abe-a5ae-463d-8ff8-d96deaf40b59',
        inviteStatus: 'OPENED'
    }, function (ret, err) {
     
        if (ret.status == 'success')
            api.toast({ msg: JSON.stringify(ret.status) });
        else
            api.toast({ msg: err.code });
})
  • 7、syncGroup

同步当前用户所属的群组信息到融云服务器

syncGroup({params}, callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.syncGroup({
        groups: [
            {
                groupId: '123',
                groupName: 'Ski Club',
                portraitUrl: 'http://club.com/ski.jpg'
            }, {
                groupId: '456',
                groupName: 'Diving Club',
                portraitUrl: 'http://club.com/diving.jpg'
            }
        ]
    }, function (ret, err) {
     
        if (ret.status == 'success')
            api.toast({ msg: JSON.stringify(ret.status) });
        else
            api.toast({ msg: err.code });
})
  • 8、joinGroup

当前用户加入某群组

joinGroup({params}, callback(ret, err))

ong.joinGroup({
        groupId: '123',
        groupName: 'Ski Club'
    }, function (ret, err) {
     
        if (ret.status == 'success')
            api.toast({ msg: JSON.stringify(ret.status) });
        else
            api.toast({ msg: err.code });
})
  • 9、quitGroup

当前用户退出某群组

quitGroup({params}, callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.quitGroup({
        groupId: '123'
    }, function (ret, err) {
     
        if (ret.status == 'success')
            api.toast({ msg: JSON.stringify(ret.status) });
        else
            api.toast({ msg: err.code });
})
  • 10、joinChatRoom

当前用户加入某聊天室

joinChatRoom({params}, callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.joinChatRoom({
        chatRoomId: '123',
        defMessageCount: 20
    }, function (ret, err) {
     
        if (ret.status == 'success')
            api.toast({ msg: JSON.stringify(ret.status) });
        else
            api.toast({ msg: err.code });
})
  • 11、quitChatRoom

当前用户退出某聊天室

quitChatRoom({params}, callback(ret, err))

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.quitChatRoom({
        chatRoomId: '123'
    }, function (ret, err) {
     
        if (ret.status == 'success')
            api.toast({ msg: JSON.stringify(ret.status) });
        else
            api.toast({ msg: err.code });
})

你可能感兴趣的:(APIcloud开发,融云模块,即时聊天,融云模块文档笔记)