new connection(options) → {Class}
The connection class.
Parameters:
Name |
Type |
Description |
options |
Object
|
创建连接的初始化参数
Properties
Name |
Type |
Description |
url |
String
|
xmpp服务器的URL |
apiUrl |
String
|
API服务器的URL |
isHttpDNS |
Boolean
|
防止域名劫持 |
isMultiLoginSessions |
Boolean
|
为true时同一账户可以同时在多个Web页面登录(多标签登录,默认不开启,如有需要请联系商务),为false时同一账号只能在一个Web页面登录 |
https |
Boolean
|
是否启用wss. |
heartBeatWait |
Number
|
发送心跳包的时间间隔(毫秒) |
isAutoLogin |
Boolean
|
登录成功后是否自动出席 |
autoReconnectNumMax |
Number
|
掉线后重连的最大次数 |
autoReconnectInterval |
Number
|
掉线后重连的间隔时间(毫秒) |
isWindowSDK |
Boolean
|
是否运行在WindowsSDK上 |
encrypt |
Boolean
|
是否加密文本消息 |
delivery |
Boolean
|
是否发送delivered ack |
|
Returns:
连接实例
-
Type
-
Class
Methods
addToBlackList(options)
将好友加入到黑名单
Parameters:
Name |
Type |
Description |
options |
Object
|
Properties
Name |
Type |
Description |
name |
Array.<Object>
|
用户ID,添加一个为单个用户ID;批量添加为用户ID数组,如["user1","user2",...] |
|
addUsersToChatRoomWhitelist(opt)
增加白名单群成员 操作权限:app admin、群组owner、群组admin及以上身份
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
chatRoomId |
string
|
聊天室ID |
users |
Array
|
成员 ['username'] |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
addUsersToGroupWhitelist(opt)
增加白名单群成员 操作权限:app admin、群组owner、群组admin及以上身份
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
users |
Array
|
成员 ['username'] |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
agreeInviteIntoGroup(opt)
通过RestFul API同意加群邀请
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
invitee |
string
|
处理群邀请用户的用户名 |
groupId |
Object
|
群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
agreeJoinGroup(opt)
通过RestFul API同意用户加入群
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
applicant |
string
|
申请加群的用户ID |
groupId |
Object
|
群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
blockGroup(opt)
- Since:
通过RestFul API屏蔽群组,只对移动端有效
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
需要屏蔽的群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
changeOwner(opt)
通过restful api转让群组
Parameters:
Name |
Type |
Description |
opt |
Object
|
Properties
Name |
Type |
Description |
groupId |
String
|
群组id |
newOwner |
String
|
群组的新管理员 ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
chatRoomBlockMulti(opt)
通过RestFul API添加用户至聊天室黑名单(批量)
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
usernames |
Array.<string>
|
用户ID数组 |
chatRoomId |
string
|
聊天室ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
chatRoomBlockSingle(opt)
通过RestFul API添加用户至聊天室黑名单(单个)
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
chatRoomId |
string
|
聊天室ID |
username |
stirng
|
用户ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
close(reason)
断开连接,同时心跳停止
Parameters:
Name |
Type |
Description |
reason |
String
|
断开原因 |
createGroupNew(opt)
- Since:
通过RestFul API接口创建群组
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
data |
Object
|
群组信息
Properties
Name |
Type |
Description |
groupname |
string
|
群组名 |
desc |
string
|
群组描述 |
members |
Array.<string>
|
好友id数组,群好友列表 |
public |
Boolean
|
true: 公开群,false: 私有群 |
approval |
Boolean
|
前提:opt.data.public=true, true: 加群需要审批,false: 加群无需审批 |
allowinvites |
Boolean
|
前提:opt.data.public=false, true: 允许成员邀请入群,false: 不允许成员邀请入群 |
|
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
deleteChatRoomSharedFile(options)
删除聊天室共享文件
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
roomId |
Object
|
聊天室id |
fileId |
Object
|
文件id |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
deleteGroupSharedFile(options)
删除群共享文件
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
Object
|
群组id |
fileId |
Object
|
文件id |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
disableSendChatRoomMsg(opt)
聊天室一键禁言. 操作权限:app admin、群组owner、群组admin及以上身份
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
chatRoomId |
string
|
聊天室ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
disableSendGroupMsg(opt)
群一键禁言. 操作权限:app admin、群组owner、群组admin及以上身份
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
dissolveGroup(opt)
通过RestFul API解散群组
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
downloadChatRoomSharedFile(options)
下载聊天室共享文件
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
roomId |
Object
|
聊天室id |
fileId |
Object
|
文件id |
onFileDownloadComplete |
Object
|
文件下载成功的回调 |
onFileDownloadError |
Object
|
文件下载失败的回调 |
|
downloadGroupSharedFile(options)
下载群共享文件
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
Object
|
群组id |
fileId |
Object
|
文件id |
onFileDownloadComplete |
Object
|
文件下载成功的回调 |
onFileDownloadError |
Object
|
文件下载失败的回调 |
|
enableSendChatRoomMsg(opt)
聊天室除群一键禁言. 操作权限:app admin、群组owner、群组admin及以上身份
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
chatRoomId |
string
|
聊天室ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
enableSendGroupMsg(opt)
解除群一键禁言. 操作权限:app admin、群组owner、群组admin及以上身份
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
fetchChatRoomAnnouncement(options)
获取聊天室公告
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
roomId |
Object
|
聊天室id |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
fetchChatRoomSharedFileList(options)
获取聊天室共享文件列表
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
roomId |
Object
|
聊天室id |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
fetchGroupAnnouncement(options)
获取群公告
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
Object
|
群组id |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
fetchGroupSharedFileList(options)
获取群共享文件列表
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
Object
|
群组id |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
fetchHistoryMessages(options)
获取对话历史消息
Parameters:
Name |
Type |
Description |
options |
Object
|
Properties
Name |
Type |
Description |
queue |
String
|
对方用户名Id |
count |
String
|
拉取条数 |
isGroup |
Boolean
|
是否是群聊,默认为false |
success |
function
|
|
fail |
Funciton
|
|
|
getBlacklist(options)
获取好友黑名单
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
getChatRoomBlacklistNew(opt)
通过RestFul API获取聊天室黑名单
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
chatRoomId |
string
|
聊天室ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
getChatRoomMuted(opt)
通过RestFul API获取聊天室下所有被禁言成员
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
chatRoomId |
string
|
聊天室ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
getChatRooms(options)
获取聊天室列表(分页)
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
apiUrl |
String
|
rest的接口地址 |
pagenum |
Number
|
页码,默认1 |
pagesize |
Number
|
每页数量,默认20 |
success |
function
|
成功之后的回调,默认为空 |
|
getChatRoomWhitelist(opt)
获取白名单聊天室成员 操作权限:需app admin、群组admin及以上身份;
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
chatRoomId |
string
|
聊天室ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
getGroup(opt)
- Since:
通过RestFul API列出某用户所加入的所有群组
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
getGroupAdmin(opt)
- Since:
通过RestFul API获取群组下所有管理员
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
getGroupBlacklistNew(opt)
通过RestFul API获取群组黑名单
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
getGroupInfo(opt)
- Since:
通过RestFul API根据groupId获取群组详情
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
getGroupMsgReadUser(options)
查询群组消息都被哪些用户读过
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
String
|
群组id |
msgId |
String
|
消息id |
success |
function
|
成功的回调 |
error |
function
|
失败的回调 |
|
getGroupWhitelist(opt)
获取白名单群成员 操作权限:需app admin、群组admin及以上身份;
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
getMuted(opt)
通过RestFul API获取群组下所有被禁言成员
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
getRoster(options)
获取联系人
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
getUniqueId(prefix)
随机生成一个id用于消息id
Parameters:
Name |
Type |
Description |
prefix |
String
|
前缀,默认为"WEBIM_" |
groupBlockMulti(opt)
通过RestFul API添加用户至群组黑名单(批量)
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
usernames |
Array.<string>
|
用户ID数组 |
groupId |
string
|
群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
groupBlockSingle(opt)
通过RestFul API添加用户至群组黑名单(单个)
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
username |
stirng
|
用户ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
inviteToGroup(opt)
通过RestFul API邀请群成员
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组名 |
users |
Array.<string>
|
用户ID数组 |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
isGroupWhiteUser(opt)
查询群成员是否是白名单用户 操作权限:app admin可查询所有用户;app user可查询自己
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
userName |
string
|
用户名 |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
joinChatRoom(options)
加入聊天室
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
roomId |
String
|
聊天室的ID |
|
opt.message |
stirng
|
原因,可选项 |
options.success |
function
|
成功之后的回调,默认为空 |
options.error |
function
|
失败之后的回调,默认为空 |
joinGroup(opt)
- Since:
通过RestFul API发出入群申请
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
String
|
加入群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
listen(options)
注册监听函数
Parameters:
Name |
Type |
Description |
options |
Object
|
回调函数集合
Properties
Name |
Type |
Description |
onOpened |
connection~onOpened
|
处理登录的回调 |
onTextMessage |
connection~onTextMessage
|
处理文本消息的回调 |
onEmojiMessage |
connection~onEmojiMessage
|
处理表情消息的回调 |
onPictureMessage |
connection~onPictureMessage
|
处理图片消息的回调 |
onAudioMessage |
connection~onAudioMessage
|
处理音频消息的回调 |
onVideoMessage |
connection~onVideoMessage
|
处理视频消息的回调 |
onFileMessage |
connection~onFileMessage
|
处理文件消息的回调 |
onLocationMessage |
connection~onLocationMessage
|
处理位置消息的回调 |
onCmdMessage |
connection~onCmdMessage
|
处理命令消息的回调 |
onCustomMessage |
connection~onCustomMessage
|
处理自定义消息 |
onPresence |
connection~onPresence
|
处理Presence消息的回调 |
onError |
connection~onError
|
处理错误消息的回调 |
onReceivedMessage |
connection~onReceivedMessage
|
处理Received消息的回调 |
onInviteMessage |
connection~onInviteMessage
|
处理邀请消息的回调 /..... |
onDeliverdMessage |
connection~onDeliverdMessage
|
处理Delivered ACK消息的回调 |
onReadMessage |
connection~onReadMessage
|
处理Read ACK消息的回调 //..... |
onRecallMessage |
connection~onRecallMessage
|
处理Recall 消息的回调 //..... |
onMutedMessage |
connection~onMutedMessage
|
处理禁言消息的回调 |
onOffline |
connection~onOffline
|
处理断网的回调 |
onOnline |
connection~onOnline
|
处理联网的回调 |
onCreateGroup |
connection~onCreateGroup
|
处理创建群组的回调 |
|
listGroupMember(opt)
通过RestFul API分页列出群组的所有成员
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
pageNum |
Number
|
页码,默认1 |
pageSize |
Number
|
每一页的最大群成员数目,最大值1000 |
groupId |
string
|
群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
listGroups(opt)
- Since:
通过RestFul API分页获取群组列表
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Default |
Description |
limit |
Number
|
|
每一页群组的最大数目 |
cursor |
string
|
null
|
游标,如果数据还有下一页,API 返回值会包含此字段,传递此字段可获取下一页的数据,为null时获取第一页数据 |
success |
function
|
|
成功之后的回调,默认为空 |
error |
function
|
|
失败之后的回调,默认为空 |
|
modifyGroup(opt)
通过RestFul API修改群信息
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
groupName |
string
|
群组名 |
description |
string
|
群组简介 |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
mute(opt)
- Since:
通过RestFul API禁止群用户发言
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
username |
string
|
被禁言的群成员的ID |
muteDuration |
Number
|
被禁言的时长,单位ms,如果是“-1000”代表永久 |
groupId |
string
|
群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
muteChatRoomMember(opt)
- Since:
通过RestFul API禁止聊天室用户发言
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
username |
string
|
被禁言的聊天室成员的ID |
muteDuration |
Number
|
被禁言的时长,单位ms,如果是“-1000”代表永久 |
chatRoomId |
string
|
聊天室ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
open(options)
登录
Parameters:
Name |
Type |
Description |
options |
Object
|
用户信息
Properties
Name |
Type |
Description |
user |
String
|
用户名 |
pwd |
String
|
用户密码,跟token二选一 |
accessToken |
String
|
token,跟密码二选一 |
appKey |
String
|
Appkey |
apiUrl |
String
|
Rest 服务地址,非必须。可在项目的WebIMConfig配置 |
xmppURL |
String
|
Xmpp 服务地址,非必须。可在项目的WebIMConfig配置 |
success |
function
|
成功之后的回调,默认为空,token登录没有该回调 |
error |
function
|
失败之后的回调,默认为空,token登录没有该回调 |
|
quitChatRoom(options)
退出聊天室
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
roomId |
String
|
聊天室的ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
quitGroup(opt)
通过RestFul API离开群组
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
recallMessage(option)
发送撤回消息
Parameters:
Name |
Type |
Description |
option |
Object
|
-
Properties
Name |
Type |
Description |
mid |
Object
|
回撤消息id |
to |
Object
|
消息的接收方 |
type |
Object
|
chat(单聊) groupchat(群组聊天) chatroom(聊天室聊天) |
|
rejectInviteIntoGroup(opt)
通过RestFul API拒绝加群邀请
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
invitee |
string
|
处理群邀请用户的用户名 |
groupId |
Object
|
群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
rejectJoinGroup(opt)
通过RestFul API拒绝用户加入群
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
applicant |
string
|
申请加群的用户ID |
groupId |
Object
|
群组ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
removeAdmin(opt)
通过RestFul API取消群管理员
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
gorupId |
string
|
群组ID |
username |
string
|
用户ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
removeChatRoomBlockMulti(opt)
通过RestFul API将用户从聊天室黑名单移除(批量)
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
chatRoomId |
string
|
聊天室ID |
usernames |
string
|
用户id的数组 ['user1', 'user2'] |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
removeChatRoomBlockSingle(opt)
通过RestFul API将用户从聊天室黑名单移除(单个)
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
chatRoomId |
string
|
聊天室ID |
username |
string
|
用户ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
removeFromBlackList(options)
将好友从黑名单移除
Parameters:
Name |
Type |
Description |
options |
Object
|
Properties
Name |
Type |
Description |
name |
Array.<Object>
|
用户ID,删除一个为单个用户ID,如 "user1";批量删除为用户ID数组,如 ["user1","user2",...] |
|
removeGroupBlockMulti(opt)
通过RestFul API将用户从群黑名单移除(批量)
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
usernames |
string
|
用户id的数组 ['user1', 'user2'] |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
removeGroupBlockSingle(opt)
通过RestFul API将用户从群黑名单移除(单个)
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
username |
string
|
用户ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
removeMultiGroupMember(opt)
通过RestFul API删除多个群成员
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
users |
Array.<string>
|
用户ID数组 |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
removeMute(opt)
- Since:
通过RestFul API取消对群成员禁言
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
username |
string
|
被取消禁言的群用户ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
removeMuteChatRoomMember(opt)
- Since:
通过RestFul API取消对聊天室成员禁言
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
chatRoomId |
string
|
聊天室ID |
username |
string
|
被取消禁言的群用户ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
removeRoster(options)
删除联系人
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
to |
String
|
联系人ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
removeSingleGroupMember(opt)
通过RestFul API删除单个群成员
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
username |
string
|
用户ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
rmUsersFromChatRoomWhitelist(opt)
删除白名单聊天室成员 操作权限:app admin、群组owner、群组admin及以上身份
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
chatRoomId |
string
|
聊天室ID |
userName |
string
|
成员 |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
rmUsersFromGroupWhitelist(opt)
删除白名单群成员 操作权限:app admin、群组owner、群组admin及以上身份
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
userName |
string
|
成员 |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
send(messageSource)
发送消息
Example
let deliverMessage = new WebIM.message('delivery', msgId);
deliverMessage.set({
id: msgId,
to: msg.from
});
conn.send(deliverMessage.body);
Parameters:
Name |
Type |
Description |
messageSource |
Object
|
由 Class Message 生成 |
setAdmin(opt)
通过RestFul API设置群管理员
Parameters:
Name |
Type |
Description |
opt |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
string
|
群组ID |
username |
string
|
用户ID |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
subscribe(options)
添加联系人
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
to |
String
|
想要订阅的联系人ID |
nick |
String
|
想要订阅的联系人昵称 (非必须) |
message |
String
|
发送给想要订阅的联系人的验证消息(非必须) |
|
subscribed(options)
被订阅后确认同意被订阅
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
to |
String
|
订阅人的ID |
message |
String
|
默认为[resp:true],后续将去掉该参数 |
|
unsubscribed(options)
拒绝对方的订阅请求
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
to |
String
|
订阅人的ID |
message |
String
|
发送给拒绝订阅的联系人的验证消息(非必须) |
|
updateChatRoomAnnouncement(options)
设置更新聊天室公告
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
roomId |
Object
|
聊天室id |
announcement |
Object
|
公告内容 |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
updateGroupAnnouncement(options)
设置更新群公告
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
Object
|
群组id |
announcement |
Object
|
公告内容 |
success |
function
|
成功之后的回调,默认为空 |
error |
function
|
失败之后的回调,默认为空 |
|
uploadChatRoomSharedFile(options)
上传聊天室共享文件
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
roomId |
Object
|
聊天室id |
file |
Object
|
上传的文件对象 |
onFileUploadProgress |
Object
|
上传进度的回调 |
onFileUploadComplete |
Object
|
上传完成的回调 |
onFileUploadError |
Object
|
上传失败的回调 |
onFileUploadCanceled |
Object
|
上传取消的回调 |
|
uploadGroupSharedFile(options)
上传群共享文件
Parameters:
Name |
Type |
Description |
options |
Object
|
-
Properties
Name |
Type |
Description |
groupId |
Object
|
群组id |
file |
Object
|
上传的文件对象 |
onFileUploadProgress |
Object
|
上传进度的回调 |
onFileUploadComplete |
Object
|
上传完成的回调 |
onFileUploadError |
Object
|
上传失败的回调 |
onFileUploadCanceled |
Object
|
上传取消的回调 |
|