connection

Methods

acceptInviteFromGroup(options)

Deprecated:

• Yes

Parameters:

addGroupMembers(options)

Deprecated:

• Yes

Example

Attention the sequence: message first (每个成员单独发一条message), iq second (多个成员可以合成一条iq发)
 <!-- 添加成员通知：send -->
 <message to='easemob-demo#chatdemoui_1477482739698@conference.easemob.com'>
 <x xmlns='http://jabber.org/protocol/muc#user'>
 <invite to='easemob-demo#chatdemoui_lwz2@easemob.com'>
 <reason>liuwz invite you to join group '谢谢'</reason>
 </invite>
 </x>
 </message>
 <!-- 添加成员：send -->
 <iq id='09DFB1E5-C939-4C43-B5A7-8000DA0E3B73_easemob_occupants_change_affiliation' to='easemob-demo#chatdemoui_1477482739698@conference.easemob.com' type='set'>
 <query xmlns='http://jabber.org/protocol/muc#admin'>
 <item affiliation='member' jid='easemob-demo#chatdemoui_lwz2@easemob.com'/>
 </query>
 </iq>

Parameters:

addRoster(options)

Deprecated:

• Yes

Parameters:

addToBlackList(options)

Parameters:

addToGroupBlackList(options)

Deprecated:

• Yes

Parameters:

agreeJoinGroup(opt)

Parameters:

blockGroup(opt)

Since:

• 1.4.11

Parameters:

changeGroupSubject(options)

Deprecated:

• Yes

Parameters:

close(reason)

Parameters:

createGroup(options)

Deprecated:

• Yes

Example

1. 创建申请 -> 得到房主身份
2. 获取房主信息 -> 得到房间form
3. 完善房间form -> 创建成功
4. 添加房间成员
5. 消息通知成员

Parameters:

createGroupAsync(p)

Deprecated:

• Yes

Parameters:

createGroupNew(opt)

Since:

• 1.4.11

Parameters:

destroyGroup(options)

Deprecated:

• Yes

Example

<iq id="9BEF5D20-841A-4048-B33A-F3F871120E58" to="easemob-demo#chatdemoui_1477462231499@conference.easemob.com" type="set">
 <query xmlns="http://jabber.org/protocol/muc#owner">
 <destroy>
 <reason>xxx destory group yyy</reason>
 </destroy>
 </query>
 </iq>

Parameters:

dissolveGroup(opt)

Parameters:

event:unsubscribed(options)

Parameters:

getBlacklist(options)

Parameters:

getChatRooms(options)

Parameters:

getGroup(opt)

Since:

• 1.4.11

Parameters:

getGroupAdmin(opt)

Since:

• 1.4.11

Parameters:

getGroupBlacklist(options)

Deprecated:

• Yes

Parameters:

getGroupBlacklistNew(opt)

Parameters:

getGroupInfo(opt)

Since:

• 1.4.11

Parameters:

getMuted(opt)

Parameters:

getRoster(options)

Parameters:

getUniqueId(prefix)

Parameters:

groupBlockMulti(opt)

Parameters:

groupBlockSingle(opt)

Parameters:

inviteToGroup(opt)

Parameters:

joinChatRoom(options)

Parameters:

joinGroup(opt)

Since:

• 1.4.11

Parameters:

joinPublicGroup(options)

Deprecated:

• Yes

Parameters:

leaveGroup(options)

Deprecated:

• Yes

Example

<iq id="9fb25cf4-1183-43c9-961e-9df70e300de4:sendIQ" to="easemob-demo#chatdemoui_1477481597120@conference.easemob.com" type="set" xmlns="jabber:client">
 <query xmlns="http://jabber.org/protocol/muc#admin">
 <item affiliation="none" jid="easemob-demo#chatdemoui_lwz4@easemob.com"/>
 <item jid="easemob-demo#chatdemoui_lwz4@easemob.com" role="none"/>
 <item affiliation="none" jid="easemob-demo#chatdemoui_lwz2@easemob.com"/>
 <item jid="easemob-demo#chatdemoui_lwz2@easemob.com" role="none"/>
 </query>
 </iq>

Parameters:

leaveGroupBySelf(options)

Deprecated:

• Yes

Example

<iq id="5CD33172-7B62-41B7-98BC-CE6EF840C4F6_easemob_occupants_change_affiliation" to="easemob-demo#chatdemoui_1477481609392@conference.easemob.com" type="set">
 <query xmlns="http://jabber.org/protocol/muc#admin">
 <item affiliation="none" jid="easemob-demo#chatdemoui_lwz2@easemob.com"/>
 </query>
 </iq>
 <presence to="easemob-demo#chatdemoui_1479811172349@conference.easemob.com/mt002" type="unavailable"/>

Parameters:

listen(options)

Parameters:

listGroupMember(opt)

Parameters:

listGroups(opt)

Since:

• 1.4.11

Parameters:

listRooms(options)

Deprecated:

• Yes

Parameters:

modifyGroup(opt)

Parameters:

mute(opt)

Since:

• 1.4.11

Parameters:

open(options)

Parameters:

queryRoomInfo(options)

Deprecated:

• Yes

Parameters:

queryRoomMember(options)

Deprecated:

• Yes

Parameters:

queryRoomOccupants(options)

Deprecated:

• Yes

Parameters:

quitChatRoom(options)

Parameters:

quitGroup(opt)

Parameters:

registerUser(options)

Parameters:

rejectInviteFromGroup(options)

Deprecated:

• Yes

Example

throw request for now 暂时不处理，直接丢弃

 <message to='easemob-demo#chatdemoui_mt002@easemob.com' from='easmeob-demo#chatdemoui_mt001@easemob.com' id='B83B7210-BCFF-4DEE-AB28-B9FE5579C1E2'>
 <x xmlns='http://jabber.org/protocol/muc#user'>
 <apply to='easemob-demo#chatdemoui_groupid1@conference.easemob.com' from='easmeob-demo#chatdemoui_mt001@easemob.com' toNick='llllll'>
 <reason>reject</reason>
 </apply>
 </x>
 </message>

Parameters:

rejectJoinGroup(opt)

Parameters:

removeAdmin(opt)

Parameters:

removeFromBlackList(options)

Parameters:

removeGroupBlockMulti(opt)

Parameters:

removeGroupBlockSingle(opt)

Parameters:

removeGroupMemberFromBlacklist(options)

Deprecated:

• Yes

Parameters:

removeMultiGroupMember(opt)

Parameters:

removeMute(opt)

Since:

• 1.4.11

Parameters:

removeRoster(options)

Example

connection.removeRoster({
  to: id,
  success: function() {
     connection.unsubscribed({
         to: id
     })
  },
  error: function() {

  }
})

Parameters:

Fires:

• connection#event:unsubscribed

removeSingleGroupMember(opt)

Parameters:

send(messageSource)

Example

let deliverMessage = new WebIM.message('delivery', msgId);
deliverMessage.set({
 id: msgId, 
 to: msg.from
});
conn.send(deliverMessage.body);

Parameters:

setAdmin(opt)

Parameters:

subscribe(options)

Example

A订阅B（A添加B为好友）
A执行：
 conn.subscribe({
        to: 'B',
        message: 'Hello~'
    });
 B的监听函数onPresence参数message.type == subscribe监听到有人订阅他
 B执行：
 conn.subscribed({
    to: 'A',
    message: '[resp:true]'
 });
 同意A的订阅请求
 B继续执行：
 conn.subscribe({
    to: 'A',
    message: '[resp:true]'
 });
 反向订阅A，这样才算双方添加好友成功。
 若B拒绝A的订阅请求，只需执行：
 conn.unsubscribed({
    to: 'A',
    message: 'I don't want to be subscribed'
 });
 另外，在监听函数onPresence参数message.type == "subscribe"这个case中，加一句
 if (message && message.status === '[resp:true]') {
    return;
 }
 否则会进入死循环

Parameters:

subscribed(options)

Parameters:

unsubscribe(options)

Deprecated:

• Yes

Parameters:

Type Definitions

onAudioMessage()

onCmdMessage()

onCreateGroup()

onDeliverdMessage()

onEmojiMessage()

onError()

onFileMessage()

onInviteMessage()

onLocationMessage()

onMutedMessage()

onOffline()

onOnline()

onOpened()

onPictureMessage()

onPresence()

onReadMessage()

onReceivedMessage()

onTextMessage()

onVideoMessage()