接受好友申请。
connection.acceptContactInvite('user1')
接受好友申请。
connection.acceptInvitation('user1')
添加好友。
connection.addContact('user1', 'I am Bob')
添加消息 Reaction。
connection.addReaction({messageId: 'messageId', reaction: 'reaction'})
消息 ID。
在消息上添加的 Reaction,最大长度为 128 字符。
添加联系人至黑名单。
connection.addToBlackList({name: 'user1'})
用户 ID。可设置特定用户 ID 添加单个用户,也可输入用户 ID 数组批量添加用户,如 ["user1","user2"]。
添加联系人至黑名单。
connection.addUsersToBlacklist({name: 'user1'})
用户 ID。可设置特定用户 ID 添加单个用户,也可输入用户 ID 数组批量添加用户,如 ["user1","user2"]。
拒绝好友申请。
connection.declineContactInvite('user1')
拒绝好友申请。
connection.declineInvitation('user1')
删除指定好友。
connection.deleteContact('user1')
删除消息的 Reaction。
connection.deleteReaction({messageId: 'messageId', reaction: 'reaction'})
消息 ID。
要删除的 Reaction。
删除会话。
connection.deleteSession()
会话 ID:对方的用户 ID 或群组 ID。
会话类型:
singleChat
:单聊;groupChat
:群聊。删除会话时是否同时删除服务端漫游消息。
true
:是;false
:否。获取对话历史消息。
connection.fetchHistoryMessages({queue:'user1', count: 20})
每次获取的消息条数。默认值为 20。
是否格式化消息。
true
:是;false
:否。是否是群组。
true
:是;false
:不是。对方的用户 ID 或者群组 ID。
起始消息 ID,默认值为 -1,即从最新消息开始。
查询用户属性。
connection.fetchUserInfoById('user1') | fetchUserInfoById(['user1', 'user2'])
获取黑名单列表。
connection.getBlacklist()
获取联系人列表。
connection.getContacts()
获取会话列表以及会话下的最新一条消息。
connection.getConversationList()
获取对话历史消息。
connection.getHistoryMessages({targetId:'user1',chatType:'groupChat', pageSize: 20})
会话类型(SDK V4.0):
singleChat
:单聊;groupChat
:群组聊天;chatRoom
:聊天室聊天。单聊
。起始消息 ID,默认值为 -1,即从最新消息开始。
每次获取的消息条数。默认值为 20,最大值是50。
是否选择正向拉取历史消息(从最老向最新拉取)。
up
:向上搜索;down
:向下搜索;up
。对方的用户 ID 或者群组 ID。
获取 Reaction 详情。
getReactionDetail({messageId: 'messageId', reaction: 'reaction', cursor: '', pageSize: 20})
游标。如果数据还有下一页,该方法的返回值会包含此字段,传递此字段可获取下一页的数据,为 null 时获取第一页数据。
消息 ID。
每页返回的数量。默认为 20,最大为 100。
要获取的 Reaction。
获取消息的 Reaction 列表。
connection.getReactionList({chatType: 'chatType', messageId: 'messageId'})
会话类型:
群组 ID。
消息 ID。
获取联系人列表。
connection.getRoster()
获取会话列表。
connection.getSessionList()
撤回消息。
connection.recallMessage({mid: 'messageId', to: 'user1', type: 'singleChat'})
会话类型(SDK V4.0):
singleChat
:单聊;groupChat
:群组聊天;chatRoom
:聊天室聊天。是否是子区内的消息。
需要撤回的消息 ID。
消息的接收方。
会话类型(SDK V3.0):
chat
:单聊;groupchat
:群组聊天;chatroom
:聊天室聊天。将联系人从黑名单移除。
connection.removeFromBlackList({name: 'user1'})
用户 ID。可设置特定用户 ID 移除单个用户,也可输入用户 ID 数组批量移除用户,如 ["user1","user2"]。
删除联系人。
connection.removeRoster({to: 'user1'})
联系人 ID。
将联系人从黑名单中移除。
connection.removeUserFromBlackList({name: 'user1'})
用户 ID。可设置特定用户 ID 移除单个用户,也可输入用户 ID 数组批量移除用户,如 ["user1","user2"]。
举报消息。
reportMessage()
添加好友。
同意好友申请。
拒绝好友申请。
修改收到推送消息时显示的昵称。该昵称在用户注册时设置。不属于用户属性。
connection.updateCurrentUserNick('Tom')
修改当前用户的用户属性。
connection.updateOwnUserInfo({nickname: 'Tom', avatarurl: 'avatarurl', mail: 'abc@gmail,com', ext: JSON.stringify({hobby: 'football'})})
connection.updateOwnUserInfo('nickname', 'Tom')
将 token 上传到服务器。该方法的使用场景是 SDK 用在原生客户端且准备在客户端集成第三方推送功能。
connection.uploadPushToken({deviceId: 'deviceId', deviceToken: 'deviceToken', notifierName: 'notifierName'})
设备 ID,用于标识设备。用户可自定义设备 ID。
推送 token,用于标识相同的设备。用户可自定义该推送 token。
推送服务的 App ID,对于 Firebase Cloud Messaging (FCM) 是 senderId, 对于 VIVO 推送服务是 “appId+#+AppKey”。
将 token 上传到服务器。该方法的使用场景是 SDK 用在原生客户端且准备在客户端集成第三方推送功能。
connection.uploadToken({deviceId: 'deviceId', deviceToken: 'deviceToken', notifierName: 'notifierName'})
设备 ID,用于标识设备。用户可自定义设备 ID。
推送 token,用于标识相同的设备。用户可自定义该推送 token。
推送服务的 App ID,对于 Firebase Cloud Messaging (FCM) 是 senderId, 对于 VIVO 推送服务是 “appId+#+AppKey”。
Generated using TypeDoc
This is the doc comment for file1.ts
Specify this is a module comment and rename it to my-module: