1 Star 0 Fork 49

im / uni-chat

forked from 野火IM / uni-chat 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
wfc.js 63.24 KB
一键复制 编辑 原始数据 按行查看 历史
heavyrian2012 提交于 2022-06-07 16:12 . uni chat code
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889
/*
* Copyright (c) 2020 WildFireChat. All rights reserved.
*/
import {EventEmitter} from 'events';
import {atob, btoa} from '../util/base64.min.js';
import Long from 'long';
import impl from '../proto/proto.min';
import Config from "../../config";
//import avenginekit from "../av/engine/avenginekitproxy";
export class WfcManager {
/**
* 事件通知,{@link EventType}中定义的事件,都会采用本{@link eventEmitter} 通知
* @type {module:events.internal.EventEmitter}
*/
eventEmitter = new EventEmitter();
constructor() {
impl.eventEmitter = this.eventEmitter;
}
/**
* 初始化,请参考本demo的用法
* 只可以在主窗口调用,其他窗口调用之后,会导致主窗口通知失效。
* 如果其他窗口想调用wfc里面的非通知方法,可以参考{@link attach}
* @param {[]} args,pc 时,传入[node实例]; web 时,可以传入Config配置对象,配置项,请参考{@link Config}
*/
init(args = []) {
console.log('wfc init')
impl.init(args);
//avenginekit.setup(self);
//self.setProxyInfo("", "192.168.1.80", 1080, "", "");
console.log('wfc init end')
}
/**
* 注册新的自定义消息
*
* @param {string} name
* @param {number} flag 用来标识本消息是否需要存储、计数等,{@link PersistFlag}
* @param {number} type 消息类型,{@link MessageContentType}
* @param {class} clazz 消息对应的class
*/
registerMessageContent(name, flag, type, clazz) {
impl.registerMessageContent(name, flag, type, clazz);
}
/**
* 获取clientId,获取用户token时,一定要通过调用此方法获取clientId,否则会连接失败。
* @returns {string} clientId
*/
getClientId() {
return impl.getClientId();
}
/*
* 启用国密加密。注意需要服务器端同步开启国密配置
*/
useSM4() {
impl.useSM4();
}
/**
* 连接服务器
* @param {string} userId 用户id
* @param {string} token 用户token,生成token时,所使用的clientId,一定要通过{@link getClientId}获取
*/
connect(userId, token) {
impl.connect(userId, token);
}
/**
* 设置代理,只支持socks5代理
*
* @param {String} host 代理host,host和ip必须至少有一个。
* @param {String} ip 代理IP,host和ip必须至少有一个。
* @param {number} port 代理端口
* @param {String} username username
* @param {String} password password
*/
setProxyInfo(host, ip, port, username, password) {
impl.setProxyInfo(host, ip, port, username, password);
}
/**
* 设置第三方推送设备token
* @param {number} pushType 推送类型,0-5 移动端已经使用了。
* @param {String} token 设备token
*/
setDeviceToken(pushType, token) {
impl.setDeviceToken(pushType, token);
}
disconnect() {
impl.disconnect();
}
setPackageName(packageName) {
impl.setPackageName(packageName);
}
/**
* 获取当前用户的id
* @returns {string} 当前用户的id
*/
getUserId() {
return impl.getUserId();
}
/**
* 服务器时间和本地时间的差值
* @returns {number} 服务器时间和本地时间的差值
*/
getServerDeltaTime() {
return impl.getServerDeltaTime();
}
/**
* 截图,
* @returns {string} 成功返回'done',同时,图片保存到了系统剪贴板
*/
screenShot() {
return impl.screenShot();
}
/**
* 是否成功登录
* @returns {boolean}
*/
isLogin() {
return impl.isLogin();
}
/**
* 获取连接状态
* @returns {number} 连接状态,参考{@link ConnectionStatus}
*/
getConnectionStatus() {
return impl.getConnectionStatus();
}
/**
* 设置网络策略,仅专业版支持
* @param {int} strategy 网络策略。0 是自动选择;1 选择主网络;2选择备用网络
*
*/
setBackupAddressStrategy(strategy) {
impl.setBackupAddressStrategy(strategy);
}
/**
* 设置备选网络信息,仅专业版支持
* @param {String} backupHost 备选网络主机地址
* @param {int} backupPort 备选网络主机端口
*/
setBackupAddress(backupHost, backupPort) {
impl.setBackupAddress(backupHost, backupPort);
}
/**
* 设置协议栈短连接UA。
*
* @param {string} userAgent 协议栈短连接使用的UA
*/
setProtoUserAgent(userAgent) {
impl.setProtoUserAgent(userAgent);
}
/**
* 添加协议栈短连接自定义Header
*
* @param {string} header 协议栈短连接使用的UA
* @param {string} value 协议栈短连接使用的UA
*/
addHttpHeader(header, value) {
impl.addHttpHeader(header, value)
}
/**
* 设备从睡眠中恢复
*/
onAppResume() {
impl.onAppResume();
}
/**
* 设备进入睡眠状态
*/
onAppSuspend() {
impl.onAppSuspend();
}
/**
* 已废弃,请使用{@link getFavGroupList}
* 获取我保存到通讯录的群组信息列表
* @returns {[GroupInfo]} 参考{@link GroupInfo}
*/
getMyGroupList() {
return impl.getMyGroupList();
}
/**
* 获取我保存到通讯录的群组信息列表
* @returns {[GroupInfo]} 参考{@link GroupInfo}
*/
getFavGroupList() {
return impl.getMyGroupList();
}
/**
* 获取用户的displayName
* @param {string} userId 用户id
* @returns {string} 用户displayName
*/
getUserDisplayName(userId) {
let userInfo = this.getUserInfo(userId, false);
if (!userInfo) {
return '<' + userId + '>';
}
return userInfo.friendAlias ? userInfo.friendAlias : (userInfo.displayName ? userInfo.displayName : '<' + userId + '>');
}
/**
* 获取用户在群里面的displayName
* @param {string} groupId 群id
* @param {string} userId 用户id
* @returns {string} 用户在群里面的displayName
*/
getGroupMemberDisplayName(groupId, userId) {
let userInfo = this.getUserInfo(userId, false, groupId);
if (!userInfo) {
return '<' + userId + '>';
}
return userInfo.groupAlias ? userInfo.groupAlias : (userInfo.friendAlias ? userInfo.friendAlias : (userInfo.displayName ? userInfo.displayName : '<' + userId + '>'))
}
getUserDisplayNameEx(userInfo) {
return userInfo.friendAlias ? userInfo.friendAlias : (userInfo.displayName ? userInfo.displayName : '<' + userInfo.uid + '>');
}
getGroupMemberDisplayNameEx(userInfo) {
return userInfo.groupAlias ? userInfo.groupAlias : (userInfo.friendAlias ? userInfo.friendAlias : (userInfo.displayName ? userInfo.displayName : '<' + userInfo.uid + '>'))
}
/**
* 获取用户信息
* @param {string} userId 用户id
* @param {boolean} refresh 是否刷新用户信息,如果刷新的话,且用户信息有更新,会通过{@link eventEmitter}进行通知,事件的名字是{@link EventType.UserInfosUpdate }
* @param {string} groupId
* @returns {UserInfo}
*/
getUserInfo(userId, refresh = false, groupId = '') {
let userInfo = impl.getUserInfo(userId, refresh, groupId);
if (!userInfo.portrait) {
userInfo.portrait = Config.DEFAULT_PORTRAIT_URL;
}
return userInfo;
}
/**
* 获取用户信息
* @param {string} userId 用户ID
* @param {boolean} refresh 是否强制从服务器更新,如果本地没有或者强制,会从服务器刷新
* @param {function (UserInfo)} success 成功回调,如果本地有该用户信息,则通过回调返回本地的用户信息;如果本地没有,则从服务端拉取该用户信息,并通过回调返回
* @param {function (number)} fail 失败回调
*/
getUserInfoEx(userId, refresh, success, fail) {
impl.getUserInfoEx(userId, refresh, success, fail);
}
/**
* 批量获取用户信息
* @param {[string]} userIds 用户ids
* @param {string} groupId 群组id
* @returns {[UserInfo]}
*/
getUserInfos(userIds, groupId) {
let userInfos = impl.getUserInfos(userIds, groupId);
userInfos.forEach((u) => {
if (!u.portrait) {
u.portrait = Config.DEFAULT_PORTRAIT_URL;
}
});
return userInfos;
}
/**
* 服务端搜索用户
* @param {string} keyword 搜索关键字
* @param {number} searchType 搜索类型,可选值参考{@link SearchType}
* @param {number} page 页数,如果searchType是0,每次搜索20个,可以指定page。如果searchType非0,只能搜索一个,page无意义
* @param {function (keyword, [UserInfo])} successCB
* @param {function (number)}failCB
* @returns {Promise<void>}
*/
async searchUser(keyword, searchType, page, successCB, failCB) {
impl.searchUser(keyword, searchType, page, successCB, failCB);
}
/**
* 本地搜索好友
* @param keyword 搜索关键字
* @returns {[UserInfo]}
*/
searchFriends(keyword) {
return impl.searchFriends(keyword);
}
/**
* 本地搜索群组
* @param keyword 搜索关键字
* @returns {[GroupSearchResult]}
*/
searchGroups(keyword) {
return impl.searchGroups(keyword);
}
/**
* 获取收到的好友请求
* @returns {[FriendRequest]}
*/
getIncommingFriendRequest() {
return impl.getIncommingFriendRequest();
}
/**
* 获取发送出去的好友请求
* @returns {[FriendRequest]}
*/
getOutgoingFriendRequest() {
return impl.getOutgoingFriendRequest();
}
/**
* 获取单条好友请求
* @param {string} userId 对方的用户id
* @param {boolean} incoming 是否是收到的好友请求
* @return {FriendRequest|null}
*/
getOneFriendRequest(userId, incoming = true) {
return impl.getOneFriendRequest(userId, incoming);
}
/**
* 从服务端加载好友请求,如果有更新,会通过{@link eventEmitter}通知
*/
loadFriendRequestFromRemote() {
impl.loadFriendRequestFromRemote(Long.ZERO);
}
/**
* 获取未读的好友请求数
* @returns {number}
*/
getUnreadFriendRequestCount() {
return impl.getUnreadFriendRequestCount();
}
/**
* 清除好友请求未读状态
*/
clearUnreadFriendRequestStatus() {
impl.clearUnreadFriendRequestStatus();
}
/**
* 删除好友
* @param {string} userId 好友id
* @param {function ()} successCB
* @param {function (number) }failCB
* @returns {Promise<void>}
*/
async deleteFriend(userId, successCB, failCB) {
impl.deleteFriend(userId, successCB, failCB);
}
/**
* 处理好友请求
* @param {string} userId 发送好友请求的用户的id
* @param {boolean} accept true,接受好友请求;false,拒绝好友请求
* @param {string} extra 一些额外信息,可用来实现好友来源等,推荐使用json格式
* @param {function ()} successCB
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async handleFriendRequest(userId, accept, extra, successCB, failCB) {
impl.handleFriendRequest(userId, accept, extra, successCB, failCB);
}
/**
* 判断用户是否被加入了黑名单
* @param userId
* @returns {boolean}
*/
isBlackListed(userId) {
return impl.isBlackListed(userId);
}
/**
* 获取黑名单
* @returns {[string]}
*/
getBlackList() {
return impl.getBlackList();
}
/**
* 设置黑名单
* @param {string} userId 用户id
* @param {boolean} block true,加入黑名单;false,移除黑名单
* @param {function ()} successCB
* @param {function (number)} failCB
*/
setBlackList(userId, block, successCB, failCB) {
impl.setBlackList(userId, block, successCB, failCB);
}
/**
* 获取好友列表,返回的时好友id数组
* @param {boolean} fresh 是否刷新好友信息,如果刷新,且有更新的话,会通过{@link eventEmitter}通知
* @returns {[string]}
*/
getMyFriendList(fresh = false) {
return impl.getMyFriendList(fresh);
}
/**
* 好友列表
* @returns {[Friend]}
*/
getFriendList(fresh = false) {
return impl.getFriendList(fresh);
}
/**
* 获取好友别名
* @param {string} userId
* @returns {string}
*/
getFriendAlias(userId) {
return impl.getFriendAlias(userId);
}
getFriendExtra(userId) {
return impl.getFriendExtra(userId);
}
/**
* 设置好友别名
* @param {string} userId 用户id
* @param {string} alias 别名
* @param {function ()} successCB
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async setFriendAlias(userId, alias, successCB, failCB) {
impl.setFriendAlias(userId, alias, successCB, failCB);
}
/**
* 创建群组
* @param {string | null} groupId 群组id,一般情况下,传null;如果有自己的用户系统,自己维护群信息,那么可以传群id
* @param {number} groupType 群类型,可参考 {@link GroupType }
* @param {string} name 群名称
* @param {string} portrait 群头像的链接
* @param {string} groupExtra 群组扩展信息
* @param {[string]} memberIds 群成员id列表
* @param {string} memberExtra 群组成员扩展信息
* @param {[number]} lines 会话线路,默认传[0]即可
* @param {CreateGroupNotification} notifyContent 通知信息,默认传null,服务端会生成默认通知
* @param {function (string)} successCB 回调通知群id
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async createGroup(groupId, groupType, name, portrait, groupExtra, memberIds = [], memberExtra = '', lines = [0], notifyContent, successCB, failCB) {
impl.createGroup(groupId, groupType, name, portrait == null ? "" : portrait, groupExtra, memberIds, memberExtra, lines, notifyContent, successCB, failCB);
}
/**
* 设置全管理员
* @param {string} groupId 群id
* @param {boolean} isSet true,设置;false,取消设置
* @param {[string]} memberIds 将被设置为管理或取消管理远的群成员的用户id
* @param {[number]} lines 默认传[0]即可
* @param {TODO } notifyContent 默认传null即可
* @param {function ()} successCB
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async setGroupManager(groupId, isSet, memberIds, lines, notifyContent, successCB, failCB) {
impl.setGroupManager(groupId, isSet, memberIds, lines, notifyContent, successCB, failCB);
}
/**
* 获取群信息
* @param {string} groupId 群id
* @param {boolean} refresh 是否刷新,如果刷新,且有更新的话,会通过{@link eventEmitter}通知
* @returns {GroupInfo}
*/
getGroupInfo(groupId, refresh = false) {
return impl.getGroupInfo(groupId, refresh);
}
/**
* 获取群信息
* @param {string} groupId 群id
* @param {boolean} refresh 是否刷新,如果刷新,且有更新的话,会通过{@link eventEmitter}通知
* @param {function (GroupInfo)} successCB 成功回调
* @param {function (number)} failCB 失败回调
*/
getGroupInfoEx(groupId, refresh = false, successCB, failCB) {
impl.getGroupInfoEx(groupId, refresh, successCB, failCB);
}
/**
* 添加群成员
* @param {string} groupId 群组id
* @param {[string]} memberIds 新添加的群成员id
* @param {string} extra 群成员扩展信息
* @param {[number]} notifyLines
* @param {AddGroupMemberNotification} notifyMessageContent
* @param successCB
* @param failCB
*/
addGroupMembers(groupId, memberIds, extra, notifyLines, notifyMessageContent, successCB, failCB) {
impl.addGroupMembers(groupId, memberIds, extra, notifyLines, notifyMessageContent, successCB, failCB);
}
/**
* 获取群成员id列表
* @param {string} groupId 群id
* @param {boolean} fresh 是否刷新,刷新时,如果有更新,会通过{@link eventEmitter}通知
* @returns {[string]} 群成员用户id列表
*/
getGroupMemberIds(groupId, fresh = false) {
return impl.getGroupMemberIds(groupId, fresh);
}
/**
* 获取群成员信息
* @param {string} groupId 群id
* @param {boolean} fresh 是否刷新
* @returns {[GroupMember]} 群成员信息
*/
getGroupMembers(groupId, fresh = false) {
return impl.getGroupMembers(groupId, fresh);
}
/**
* 根据群成员类型获取群成员列表
* @param {string} groupId
* @param {number} memberType,可选值参考{@link GroupMemberType}
* @return {[GroupMember]} 群成员列表
*/
getGroupMembersByType(groupId, memberType) {
return impl.getGroupMembersByType(groupId, memberType);
}
/**
* 获取群成员信息
* @param {string} groupId 群id
* @param {boolean} fresh 是否强制从服务器更新,如果不刷新则从本地缓存中读取
* @param {function ([GroupMember])} successCB
* @param {function (number)} failCB
*/
getGroupMembersEx(groupId, fresh = false, successCB, failCB) {
impl.getGroupMembersEx(groupId, fresh, successCB, failCB);
}
/**
* 获取单个群成员信息
* @param {string} groupId 群id
* @param {string} memberId 群成员id
* @returns {GroupMember} 群成员信息
*/
getGroupMember(groupId, memberId) {
return impl.getGroupMember(groupId, memberId);
}
/**
* 将用户从群里移除
* @param {string} groupId 群id
* @param {[string]} memberIds 将要被移除的群成员id列表
* @param {[]} notifyLines 默认传[0]即可
* @param {KickoffGroupMemberNotification} notifyMsg 默认传null即可
* @param {function ()} successCB
* @param {function (number)} failCB
*/
kickoffGroupMembers(groupId, memberIds, notifyLines, notifyMsg, successCB, failCB) {
impl.kickoffGroupMembers(groupId, memberIds, notifyLines, notifyMsg, successCB, failCB);
}
/**
* 对群成员禁言
* @param {string} groupId 群id
* @param {boolean} isSet true,禁言;false,取消禁言
* @param {[string]} memberIds 群成员id列表
* @param {[number]} notifyLines 默认传[0]即可
* @param {MessageContent} notifyMsg 默认传null即可
* @param {function ()} successCB 成功回调
* @param {function (number)} failCB 失败回调
*/
muteGroupMembers(groupId, isSet, memberIds = [], notifyLines = [], notifyMsg, successCB, failCB) {
impl.muteOrAllowGroupMembers(groupId, isSet, false, memberIds, notifyLines, notifyMsg, successCB, failCB);
}
/**
* 群全局禁言之后,允许白名单成员发言
* @param {string} groupId 群id
* @param {boolean} isSet true,加入白名单,允许发言;false,移除白名单,禁止发言
* @param {[string]} memberIds 群成员id列表
* @param {[number]} notifyLines 默认传[0]即可
* @param {MessageContent} notifyMsg 默认传null即可
* @param {function ()} successCB 成功回调
* @param {function (number)} failCB 失败回调
*/
allowGroupMembers(groupId, isSet, memberIds = [], notifyLines = [], notifyMsg, successCB, failCB) {
impl.muteOrAllowGroupMembers(groupId, isSet, true, memberIds, notifyLines, notifyMsg, successCB, failCB);
}
/**
* 退出群组
* @param groupId 群id
* @param {[]} lines 默认传[0]即可
* @param {KickoffGroupMemberNotification} notifyMessageContent 默认传null即可
* @param successCB
* @param failCB
* @returns {Promise<void>}
*/
async quitGroup(groupId, lines, notifyMessageContent, successCB, failCB) {
impl.quitGroup(groupId, lines, notifyMessageContent, successCB, failCB);
}
/**
* 解散群组
* @param {string} groupId 群组id
* @param {[]} lines 默认传[0]即可
* @param {KickoffGroupMemberNotification} notifyMessageContent 默认传null即可
* @param {function ()} successCB
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async dismissGroup(groupId, lines, notifyMessageContent, successCB, failCB) {
impl.dismissGroup(groupId, lines, notifyMessageContent, successCB, failCB);
}
/**
* 修改群信息
* @param {string} groupId 群id
* @param {number} type 修改信息所属类型,可选值参考{@link ModifyGroupInfoType}
* @param {string} newValue 准备修改成什么
* @param {[number]} lines
* @param {GroupNotificationContent} notifyMessageContent
* @param successCB
* @param failCB
* @returns {Promise<void>}
*/
async modifyGroupInfo(groupId, type, newValue, lines, notifyMessageContent, successCB, failCB) {
impl.modifyGroupInfo(groupId, type, newValue, lines, notifyMessageContent, successCB, failCB);
}
/**
* 修改我在群组的别名
* @param {string} groupId 群id
* @param {string} alias 别名
* @param lines
* @param notifyMessageContent
* @param successCB
* @param failCB
* @returns {Promise<void>}
*/
async modifyGroupAlias(groupId, alias, lines, notifyMessageContent, successCB, failCB) {
impl.modifyGroupAlias(groupId, alias, lines, notifyMessageContent, successCB, failCB);
}
/**
* 修改群成员在群组的别名
* @param {string} groupId 群id
* @param {string} memberId 群成员id
* @param {string} alias 别名
* @param lines
* @param notifyMessageContent
* @param successCB
* @param failCB
* @returns {Promise<void>}
*/
async modifyGroupMemberAlias(groupId, memberId, alias, lines, notifyMessageContent, successCB, failCB) {
impl.modifyGroupMemberAlias(groupId, memberId, alias, lines, notifyMessageContent, successCB, failCB);
}
/**
* 修改群成员在群组的附加信息
* @param {string} groupId 群id
* @param {string} memberId 群成员id
* @param {string} extra 群成员附加信息
* @param lines
* @param notifyMessageContent
* @param successCB
* @param failCB
* @returns {Promise<void>}
*/
async modifyGroupMemberExtra(groupId, memberId, extra, lines, notifyMessageContent, successCB, failCB) {
impl.modifyGroupMemberExtra(groupId, memberId, extra, lines, notifyMessageContent, successCB, failCB);
}
/**
* 转移群主
* @param {string} groupId 群id
* @param {string} newOwner 新群主的id
* @param lines
* @param notifyMessageContent
* @param successCB
* @param failCB
*/
transferGroup(groupId, newOwner, lines, notifyMessageContent, successCB, failCB) {
impl.transferGroup(groupId, newOwner, lines, notifyMessageContent, successCB, failCB);
}
/**
* 获取保存到通讯录的群id列表
* @returns {[string]}
*/
getFavGroups() {
return impl.getFavGroups();
}
/**
* 判断群是否保存到了通讯录
* @param {string} groupId
* @returns {boolean}
*/
isFavGroup(groupId) {
return impl.isFavGroup(groupId);
}
/**
* 将群保存到通讯录或移除通讯录
* @param {string} groupId 群id
* @param {boolean} fav true,保存到通讯录;false,从通讯录移除
* @param {function ()} successCB
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async setFavGroup(groupId, fav, successCB, failCB) {
impl.setFavGroup(groupId, fav, successCB, failCB);
}
/**
* 获取用户设置,保存格式可以理解为:scope + key => value
* @param {number} scope 命名空间,可选值参考{@link UserSettingScope}
* @param {string} key key
* @returns {string} 设置的key对应的value
*/
getUserSetting(scope, key) {
return impl.getUserSetting(scope, key);
}
/**
* 获取某个命名空间下的所有设置
* @param scope 命名空间,可选值参考{@link UserSettingScope}
* @returns {Map} key-value
*/
getUserSettings(scope) {
return impl.getUserSettings(scope);
}
/**
* 设置或更新用户设置
* @param {number} scope 命名空间
* @param {string} key 设置的key
* @param {string} value 设置的value
* @param {function ()} successCB 成功回调
* @param {function (number)} failCB 失败回调
* @returns {Promise<void>}
*/
async setUserSetting(scope, key, value, successCB, failCB) {
impl.setUserSetting(scope, key, value, successCB, failCB);
}
/**
* 修改个人信息
* @param {[ModifyMyInfoEntry]} modifyMyInfoEntries 需要修改的信息列表,pc端,一次只允许修改一个项。
* @param successCB
* @param failCB
*/
modifyMyInfo(modifyMyInfoEntries, successCB, failCB) {
impl.modifyMyInfo(modifyMyInfoEntries, successCB, failCB);
}
/**
* 是否全局免打扰
* @returns {boolean}
*/
isGlobalSlient() {
return impl.isGlobalSlient();
}
/**
* 设置全局免打扰
* @param {boolean} silent
* @param {function ()} successCB
* @param failCB
*/
setGlobalSlient(silent, successCB, failCB) {
impl.setGlobalSlient(silent, successCB, failCB);
}
/**
* 是否隐藏通知详情
* @returns {boolean}
*/
isHiddenNotificationDetail() {
return impl.isHiddenNotificationDetail();
}
/**
* 设置或取消设置隐藏通知详情
* @param {boolean} hide 是否隐藏通知详情
* @param {function ()} successCB
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async setHiddenNotificationDetail(hide, successCB, failCB) {
impl.setHiddenNotificationDetail(hide, successCB, failCB);
}
/**
* 是否隐藏群成员昵称
* @param {string} groupId 群id
* @returns {boolean}
*/
isHiddenGroupMemberName(groupId) {
return impl.isHiddenGroupMemberName(groupId);
}
/**
* 设置或取消设置隐藏群成员昵称
* @param {string} groupId 群id
* @param {boolean} hide 是否隐藏
* @param {function ()} successCB
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async setHiddenGroupMemberName(groupId, hide, successCB, failCB) {
impl.setHiddenGroupMemberName(groupId, hide, successCB, failCB);
}
/**
* 加入聊天室
* @param {string} chatroomId 聊天室id
* @param {function ()} successCB
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async joinChatroom(chatroomId, successCB, failCB) {
impl.joinChatroom(chatroomId, successCB, failCB);
}
/**
* 退出聊天室
* @param {string} chatroomId 聊天室id
* @param {function ()} successCB
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async quitChatroom(chatroomId, successCB, failCB) {
impl.quitChatroom(chatroomId, successCB, failCB);
}
/**
* 获取聊天室信息
* @param {string} chatroomId 聊天是id
* @param {number} updateDt 传当前时间对应的毫秒数
* @param {function (ChatRoomInfo)} successCB
* @param failCB
* @returns {Promise<void>}
*/
async getChatroomInfo(chatroomId, updateDt, successCB, failCB) {
return impl.getChatroomInfo(chatroomId, updateDt, successCB, failCB);
}
/**
* 获取聊天室成员信息
* @param {string} chatroomId 聊天室id
* @param {number} maxCount 最多获取多少个聊天室成员信息
* @param {function (ChatRoomMemberInfo)} successCB
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async getChatroomMemberInfo(chatroomId, maxCount, successCB, failCB) {
impl.getChatroomMemberInfo(chatroomId, maxCount, successCB, failCB);
}
/**
* 创建频道
* @param {string} name 频道名称
* @param {string} portrait 频道头像的链接地址
* @param {string} desc 描述
* @param {string} extra 额外信息
* @param {function (string)} successCB 创建成功,会回调通知channelId
* @param {function (number)} failCB
*/
createChannel(name, portrait, desc, extra, successCB, failCB) {
impl.createChannel(name, portrait, desc, extra, successCB, failCB);
}
/**
* 获取频道信息
* @param {string} channelId 频道id
* @param {boolean} refresh 是否强制刷新
* @returns {ChannelInfo|NullChannelInfo}
*/
getChannelInfo(channelId, refresh) {
return impl.getChannelInfo(channelId, refresh);
}
/**
* 修改频道信息
* @param {string} channelId 频道id
* @param {number} type 修改什么,可选值参考{@link ModifyChannelInfoType}
* @param {string} newValue 修改后的值
* @param {function ()} successCB
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async modifyChannelInfo(channelId, type, newValue, successCB, failCB) {
impl.modifyChannelInfo(channelId, type, newValue, successCB, failCB);
}
/**
* 搜索频道
* @param {string} keyword 关键字
* @param {boolean} fuzzy 是否模糊搜索
* @param {function (keyword, [ChannelInfo])} successCB
* @param {function (number)} failCB
*/
searchChannel(keyword, fuzzy, successCB, failCB) {
impl.searchChannel(keyword, successCB, failCB);
}
/**
* 是否已收听/关注某个频道
* @param {string} channelId 频道id
* @returns {boolean}
*/
isListenedChannel(channelId) {
return impl.isListenedChannel(channelId);
}
/**
* 收听或取消收听频道
* @param {string} channelId 频道id
* @param {boolean} listen true,收听;false,取消收听
* @param {function ()} successCB
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async listenChannel(channelId, listen, successCB, failCB) {
impl.listenChannel(channelId, listen, successCB, failCB);
}
/**
* 获取自己创建的频道id列表
* @returns {[string]}
*/
getMyChannels() {
return impl.getMyChannels();
}
/**
* 获取所收听的频道id列表
* @returns {[string]}
*/
getListenedChannels() {
return impl.getListenedChannels();
}
/**
* 销毁频道
* @param {string} channelId 频道id
* @param {function ()} successCB
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async destoryChannel(channelId, successCB, failCB) {
impl.destoryChannel(channelId, successCB, failCB);
}
/**
* 获取会话列表
* @param {[number]} types 想获取的会话类型,可选值参考{@link ConversationType}
* @param {[0]} lines 想获取哪些会话线路的会话,默认传[0]即可
* @returns {[ConversationInfo]}
*/
getConversationList(types, lines) {
return impl.getConversationList(types, lines);
}
/**
* 获取会话详情
* @param {Conversation} conversation
* @returns {ConversationInfo}
*/
getConversationInfo(conversation) {
return impl.getConversationInfo(conversation);
}
/**
* 搜索会话
* @param {string} keyword 关键字
* @param {[number]} types 从哪些类型的会话中进行搜索,可选值可参考{@link ConversationType}
* @param {[number]} lines 从哪些会话线路进行搜索,默认传[0]即可
* @returns {[ConversationSearchResult]}
*/
searchConversation(keyword, types = [0, 1, 2], lines = [0, 1, 2]) {
return impl.searchConversation(keyword, types, lines);
}
/**
* 删除会话
* @param {Conversation} conversation 想删除的目标会话
* @param {boolean} clearMsg 是否已删除的会话的消息
* @returns {Promise<void>}
*/
async removeConversation(conversation, clearMsg) {
impl.removeConversation(conversation, clearMsg);
}
/**
* 会话置顶或取消置顶
* @param {Conversation} conversation 需要置顶或取消置顶的会话
* @param {boolean} top true,置顶;false,取消置顶
* @param {function ()} successCB
* @param {function (number)} failCB
*/
setConversationTop(conversation, top, successCB, failCB) {
impl.setConversationTop(conversation, top, successCB, failCB);
}
/**
* 会话免打扰或取消免打扰
* @param {Conversation} conversation 目标会话
* @param {boolean} silent true,设置为免打扰;false,取消免打扰
* @param {function ()} successCB
* @param {function (number)} failCB
*/
setConversationSlient(conversation, silent, successCB, failCB) {
impl.setConversationSlient(conversation, silent, successCB, failCB);
}
/**
* 保存会话草稿
* @param {Conversation} conversation 目标会话
* @param {string} draft 草稿,传''时,相当于清楚会话草稿
*/
setConversationDraft(conversation, draft = '') {
impl.setConversationDraft(conversation, draft);
}
/**
* 设置会话时间错,当会话不存在时,会创建一个新的会话。
* @param {Conversation} conversation
* @param {number} timestamp
*/
setConversationTimestamp(conversation, timestamp) {
impl.setConversationTimestamp(conversation, timestamp);
}
/**
* 获取未读消息数
* @param {[number]} types 获取未读数时,包含哪些类型的会话,可选值参考{@link ConversationType}
* @param {[number]} lines 获取未读数时,包含哪些会话线路,默认传[0]即可
* @returns {UnreadCount}
*/
getUnreadCount(types = [0, 1, 2], lines = [0]) {
return impl.getUnreadCount(types, lines);
}
/**
* 获取某个会话的未读消息数
* @param {Conversation} conversation 目标会话
* @returns {UnreadCount}
*/
getConversationUnreadCount(conversation) {
return impl.getConversationUnreadCount(conversation);
}
/**
* 清楚会话消息未读状态
* @param {Conversation} conversation 目标会话
*/
clearConversationUnreadStatus(conversation) {
impl.clearConversationUnreadStatus(conversation);
}
/**
* 将会话最后一条消息置为未读
* @param {Conversation} conversation 会话
* @param {boolean} syncToOtherClient 是否同步给其他端
* @return {boolean} 是否操作成功
*/
markConversationAsUnread(conversation, syncToOtherClient) {
return impl.markConversationAsUnread(conversation, syncToOtherClient);
}
/**
* 清除单条消息的未读状态
* @param messageId
*/
clearMessageUnreadStatus(messageId) {
impl.clearMessageUnreadStatus(messageId);
}
/**
* 清楚所有消息的未读状态
*/
clearAllUnreadStatus() {
impl.clearAllUnreadStatus();
}
/**
* 设置媒体消息的状态为已播放
* @param {number} messageId 消息id,不是消息uid!
*/
setMediaMessagePlayed(messageId) {
impl.setMediaMessagePlayed(messageId);
}
/**
* 设置消息本地扩展信息
* @param {number} messageId 消息id,不是消息uid!
* @param {string} extra 扩展信息
*/
setMessageLocalExtra(messageId, extra) {
impl.setMessageLocalExtra(messageId, extra);
}
/**
* 判断是否是好友
* @param {string} userId 用户id
* @returns {boolean}
*/
isMyFriend(userId) {
return impl.isMyFriend(userId);
}
/**
* 获取星标用户id列表
* @returns {[string]}
*/
getFavUsers() {
return impl.getFavUsers();
}
/**
* 判断用户是否是星标用户
* @param {string} userId
* @returns {boolean}
*/
isFavUser(userId) {
return impl.isFavUser(userId);
}
/**
* 设置或取消星标用户
* @param {string} userId 用户id
* @param {boolean} fav true,保存到通讯录;false,从通讯录移除
* @param {function ()} successCB
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async setFavUser(userId, fav, successCB, failCB) {
impl.setFavUser(userId, fav, successCB, failCB);
}
/**
* 发送好友请求
* @param {string} userId 目标用户id
* @param {string} reason 发送好友请求的原因
* @param {string} extra 请求的扩展信息
* @param {function ()} successCB
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async sendFriendRequest(userId, reason, extra, successCB, failCB) {
impl.sendFriendRequest(userId, reason, extra, successCB, failCB);
}
/**
* 获取会话消息
* @param {Conversation} conversation 目标会话
* @param {number} fromIndex messageId,表示从那一条消息开始获取
* @param {boolean} before true, 获取fromIndex之前的消息,即更旧的消息;false,获取fromIndex之后的消息,即更新的消息。都不包含fromIndex对应的消息
* @param {number} count 获取多少条消息
* @param {string} withUser 只有会话类型为{@link ConversationType#Channel}时生效, channel主用来查询和某个用户的所有消息
* @return {[Message]} 会话消息列表,参考{@link Message}
*/
getMessages(conversation, fromIndex = 0, before = true, count = 20, withUser = '') {
return impl.getMessages(conversation, fromIndex, before, count, withUser);
}
/**
* 获取消息
* @param {[number]} conversationTypes 会话类型列表,可选值参考{@link ConversationType}
* @param {[number]} lines 会话线路列表
* @param {number} fromIndex 本参数暂时无效! messageId,表示从那一条消息开始获取
* @param {boolean} before 本参数暂时无效! true, 获取fromIndex之前的消息,即更旧的消息;false,获取fromIndex之后的消息,即更新的消息。都不包含fromIndex对应的消息
* @param {number} count 本参数暂时无效! 获取多少条消息
* @param {string} withUser 只有会话类型为{@link ConversationType#Channel}时生效, channel主用来查询和某个用户的所有消息
* @param {[number]} contentTypes 消息类型列表,可选值参考{@link MessageContentType}
* @return {[Message]} 会话消息列表,参考{@link Message}
*/
getMessagesEx(conversationTypes, lines, fromIndex = 0, before = true, count = 20, withUser = '', contentTypes = []) {
return impl.getMessagesEx(conversationTypes, lines, contentTypes, fromIndex, before, count, withUser);
}
/**
*
* @param {[number]} conversationTypes 会话类型列表,可选值参考{@link ConversationType}
* @param {[number]} lines 会话线路列表
* @param messageStatus 消息状态,可选值参考{@link MessageStatus}
* @param {number} fromIndex 本参数暂时无效! messageId,表示从那一条消息开始获取
* @param {boolean} before 本参数暂时无效! true, 获取fromIndex之前的消息,即更旧的消息;false,获取fromIndex之后的消息,即更新的消息。都不包含fromIndex对应的消息
* @param {number} count 本参数暂时无效! 获取多少条消息
* @param {string} withUser 只有会话类型为{@link ConversationType#Channel}时生效, channel主用来查询和某个用户的所有消息
* @return {[Message]} 会话消息列表,参考{@link Message}
*/
getMessagesEx2(conversationTypes, lines, messageStatus, fromIndex = 0, before = true, count = 20, withUser = '') {
return impl.getMessagesEx2(conversationTypes, lines, messageStatus, fromIndex, before, count, withUser);
}
/**
* 获取用户会话消息
* @param {string} userId 用户id
* @param {Conversation} conversation 目标会话
* @param {number} fromIndex 本参数暂时无效! messageId,表示从那一条消息开始获取
* @param {boolean} before 本参数暂时无效! true, 获取fromIndex之前的消息,即更旧的消息;false,获取fromIndex之后的消息,即更新的消息。都不包含fromIndex对应的消息
* @param {number} count 本参数暂时无效! 获取多少条消息
* @return
*/
getUserMessages(userId, conversation, fromIndex, before = true, count = 20) {
return impl.getUserMessages(userId, conversation, fromIndex, before, count);
}
/**
* 获取用户消息
* @param {string} userId 用户id
* @param {[number]} conversationTypes 想获取的会话类型,可选值参考{@link ConversationType}
* @param {[0]} lines 想获取哪些会话线路的会话,默认传[0]即可
* @param {number} fromIndex 本参数暂时无效! messageId,表示从那一条消息开始获取
* @param {boolean} before 本参数暂时无效! true, 获取fromIndex之前的消息,即更旧的消息;false,获取fromIndex之后的消息,即更新的消息。都不包含fromIndex对应的消息
* @param {number} count 本参数暂时无效! 获取多少条消息
* @param {[number]} contentTypes 消息类型,可选值参考{@link MessageContentType}
* @return
*/
getUserMessagesEx(userId, conversationTypes, lines, fromIndex, before = true, count = 20, contentTypes = []) {
return impl.getUserMessagesEx(userId, conversationTypes, lines, fromIndex, before, count, contentTypes);
}
/**
* 获取会话第一条未读消息的消息id
* @param {Conversation} conversation
* @return {number}
*/
getFirstUnreadMessageId(conversation) {
return impl.getFirstUnreadMessageId(conversation);
}
/**
* 已废弃,请使用{@link loadRemoteConversationMessages}
* 获取会还的远程历史消息
* @param {Conversation} conversation 目标会话
* @param {[number]} contentTypes 消息类型列表,可选值参考{@link MessageContentType}
* @param {number | Long} beforeUid 消息uid,表示拉取本条消息之前的消息
* @param {number} count
* @param {function (Message)} successCB
* @param failCB
*/
loadRemoteMessages(conversation, contentTypes, beforeUid, count, successCB, failCB) {
impl.loadRemoteMessages(conversation, contentTypes, beforeUid, count, successCB, failCB);
}
/**
* 获取会话的远程历史消息
* @param {Conversation} conversation 目标会话
* @param {[number]} contentTypes 消息类型列表,可选值参考{@link MessageContentType}
* @param {number | Long} beforeUid 消息uid,表示拉取本条消息之前的消息
* @param {number} count
* @param {function ([Message])} successCB
* @param failCB
*/
loadRemoteConversationMessages(conversation, contentTypes, beforeUid, count, successCB, failCB) {
impl.loadRemoteMessages(conversation, contentTypes, beforeUid, count, successCB, failCB);
}
/**
* 获取会话的远程历史消息,仅 web 有效
* @param {Conversation} conversation 目标会话
* @param {[number]} contentTypes 消息类型列表,可选值参考{@link MessageContentType}
* @param {number | Long} beforeUid 消息uid,表示拉取本条消息之前的消息
* @param {number} count
* @param {boolean} filterLocalMessage 是否过滤本地已经存在的消息
* @param {function ([Message])} successCB
* @param failCB
*/
loadRemoteConversationMessagesEx(conversation, contentTypes, beforeUid, count, filterLocalMessage, successCB, failCB){
impl.loadRemoteMessages(conversation, contentTypes, beforeUid, count, successCB, failCB, filterLocalMessage);
}
/**
* 根据会话线路,获取远程历史消息
* @param {number} line 会话线路
* @param {number | Long} beforeUid 消息uid,表示拉取本条消息之前的消息
* @param {[number]} contentTypes 消息类型列表,可选值参考{@link MessageContentType}
* @param {number} count
* @param {function ([Message])} successCB
* @param failCB
*/
loadRemoteLineMessages(line, contentTypes, beforeUid, count, successCB, failCB){
impl.loadRemoteLineMessages(line, contentTypes, beforeUid, count, successCB, failCB)
}
/**
* 根据会话线路,获取远程历史消息,仅 web 端有效
* @param {number} line 会话线路
* @param {number | Long} beforeUid 消息uid,表示拉取本条消息之前的消息
* @param {[number]} contentTypes 消息类型列表,可选值参考{@link MessageContentType}
* @param {number} count
* @param {boolean} filterLocalMessage 是否过滤本地已经存在的消息
* @param {function ([Message])} successCB
* @param failCB
*/
loadRemoteLineMessages(line, contentTypes, beforeUid, count, filterLocalMessage, successCB, failCB){
impl.loadRemoteLineMessages(line, contentTypes, beforeUid, count, successCB, failCB, filterLocalMessage)
}
/**
* 根据消息 uid,获取远程消息
* @param {Long} messageUid 消息uid
* @param {function ([Message])} successCB
* @param failCB
*/
loadRemoteMessage(messageUid, successCB, failCB){
impl.loadRemoteMessage(messageUid, successCB, failCB);
}
/**
* 获取消息
* @param {number} messageId 消息id
* @returns {null|Message}
*/
getMessageById(messageId) {
return impl.getMessageById(messageId);
}
/**
* 获取消息
* @param {Long|string|number} messageUid
* @returns {null|Message}
*/
getMessageByUid(messageUid) {
return impl.getMessageByUid(messageUid);
}
/**
* 搜索消息
* @param {Conversation} conversation 目标会话
* @param {string} keyword 关键字
* @returns {[Message]}
*/
searchMessage(conversation, keyword) {
return impl.searchMessage(conversation, keyword);
}
/**
* 搜索消息
* @param {Conversation} conversation 目标会话,如果为空搜索所有会话
* @param {string} keyword 关键字
* @param {boolean} desc 逆序排列
* @param {int} limit 返回数量
* @param {int} offset 偏移
* @returns {Message[]}
*/
searchMessageEx(conversation, keyword, desc, limit, offset) {
return impl.searchMessageEx(conversation, keyword, desc, limit, offset);
}
/**
* 搜索消息
* @param {Conversation} conversation 目标会话,如果为空搜索所有会话
* @param {string} keyword 关键字
* @param {[number]} contentTypes 消息类型列表,可选值参考{@link MessageContentType}
* @param {boolean} desc 逆序排列
* @param {int} limit 返回数量
* @param {int} offset 偏移
* @returns {Message[]}
*/
searchMessageByTypes(conversation, keyword, contentTypes, desc, limit, offset) {
return impl.searchMessageByTypes(conversation, keyword, contentTypes, desc, limit, offset);
}
/**
* 搜索消息
* @param {Conversation} conversation 目标会话,如果为空搜索所有会话
* @param {string} keyword 关键字
* @param {[number]} contentTypes 消息类型列表,可选值参考{@link MessageContentType}
* @param {Long} 消息起始时间,如果为0,则忽略起始时间。
* @param {Long} 消息结束时间,如果为0,测忽略结束时间。
* @param {boolean} desc 逆序排列
* @param {int} limit 返回数量
* @param {int} offset 偏移
* @returns {Message[]}
*/
searchMessageByTypesAndTimes(conversation, keyword, contentTypes, startTime, endTime, desc, limit, offset) {
return impl.searchMessageByTypesAndTimes(conversation, keyword, contentTypes, startTime, endTime, desc, limit, offset);
}
/**
* 搜索消息
* @param {[number]} conversationTypes 会话类型列表,可选值参考{@link ConversationType}
* @param {[number]} lines 会话线路列表
* @param {[number]} contentTypes 消息类型列表,可选值参考{@link MessageContentType}
* @param {string} keyword 关键字
* @param {number} fromIndex messageId,表示从那一条消息开始获取
* @param {boolean} desc 逆序排列
* @param {number} count 最大数量
* @returns {[Message]}
*/
searchMessageEx2(conversationTypes, lines, contentTypes, keyword, fromIndex, desc, count) {
return impl.searchMessageEx2(conversationTypes, lines, contentTypes, keyword, fromIndex, desc, count);
}
/**
* 发送消息
* @param {Conversation} conversation 目标会话
* @param {MessageContent} messageContent 具体的消息内容,一定要求是{@link MessageContent} 的子类,不能是普通的object
* @param {[string]} toUsers 定向发送给会话中的某些用户;为空,则发给所有人;另外对单聊会话,本参数无效
* @param {function (number, number)} preparedCB 消息已插入本地数据的回调,回调的两个参数表示:messageId, timestamp
* @param {function (number, number)} progressCB 媒体上传进度回调,针对媒体消息,且媒体大于100K时有效,回调参数表示:uploaded, total
* @param {function (number, number)} successCB 发送成功回调,回调参数表示:messageUid, timestamp
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async sendConversationMessage(conversation, messageContent, toUsers, preparedCB, progressCB, successCB, failCB) {
impl.sendConversationMessage(conversation, messageContent, toUsers, preparedCB, progressCB, successCB, failCB);
}
/**
* 发送消息,参考{@link sendConversationMessage}
* @param {Message} message 一定要求是{@link Message}类型
* @param preparedCB
* @param progressCB
* @param successCB
* @param failCB
* @returns {Promise<void>}
*/
async sendMessage(message, preparedCB, progressCB, successCB, failCB) {
impl.sendMessage(message, preparedCB, progressCB, successCB, failCB);
}
/**
* 发送消息,参考{@link sendMessage}
* @param message
* @param toUsers
* @param preparedCB
* @param progressCB
* @param successCB
* @param failCB
* @returns {Promise<void>}
*/
async sendMessageEx(message, toUsers = [], preparedCB, progressCB, successCB, failCB) {
impl.sendMessageEx(message, toUsers, preparedCB, progressCB, successCB, failCB);
}
// 更新了原始消息的内容
/**
* 撤回消息
* @param {Long} messageUid
* @param {function ()} successCB
* @param {function (number)} failCB
* @returns {Promise<void>}
*/
async recallMessage(messageUid, successCB, failCB) {
impl.recallMessage(messageUid, successCB, failCB);
}
/**
* 删除消息
* @param {number} messageId 消息id
* @returns {*}
*/
deleteMessage(messageId) {
return impl.deleteMessageById(messageId);
}
/**
* 删除远程消息
* @param {Long | string} msgUid 消息uid
* @param {function ()} successCB
* @param {function (number)} failCB
*/
deleteRemoteMessageByUid(msgUid, successCB, failCB){
impl.deleteRemoteMessage(msgUid, successCB, failCB);
}
/**
* 更新远程消息消息内容,只有专业版支持。客户端仅能更新自己发送的消息,更新的消息类型不能变,更新的消息类型是服务配置允许更新的内容。Server API更新则没有限制。
* @param {Long | string} msgUid 消息uid
* @param {MessageContent} messageContent 具体的消息内容,一定要求是{@link MessageContent} 的子类,不能是普通的object
* @param {boolean} distribute 是否重新分发给其他客户端
* @param {boolean} updateLocal 是否更新本地消息内容
* @param {function ()} successCB
* @param {function (number)} failCB
*/
updateRemoteMessageContent(msgUid, messageContent, distribute, updateLocal, successCB, failCB){
impl.updateRemoteMessageContent(msgUid, messageContent, distribute, updateLocal, successCB, failCB);
}
/**
* 清除会话消息
* @param {Conversation} conversation 目标会话
* @returns {Promise<void>}
*/
async clearMessages(conversation) {
impl.clearMessages(conversation);
}
/**
* 清除远程会话消息
* @param {Conversation} conversation
* @param {function ()} successCB
* @param {function (error)} failCB
* @return {Promise<void>}
*/
async clearRemoteConversationMessages(conversation, successCB, failCB) {
impl.clearRemoteConversationMessages(conversation, successCB, failCB);
}
/**
* 插入消息
* @param {Conversation} conversation 目标会话
* @param {MessageContent} messageContent 具体的消息内容,一定要求是{@link MessageContent} 的子类,不能是普通的object
* @param {number} status 消息状态,可选值参考{@link MessageStatus}
* @param {boolean} notify 是否触发onReceiveMessage
* @param {Number} serverTime 服务器时间,精度到毫秒
*
* @return {Message} 插入的消息
*/
insertMessage(conversation, messageContent, status, notify = false, serverTime = 0) {
return impl.insertMessage(conversation, messageContent, status, notify, serverTime);
}
/**
* 更新消息
* @param {number} messageId 消息id
* @param {MessageContent} messageContent 具体的消息内容,一定要求是{@link MessageContent} 的子类,不能是普通的object
* @returns {Promise<void>}
*/
async updateMessageContent(messageId, messageContent) {
impl.updateMessageContent(messageId, messageContent);
}
/**
* 更新消息状态
* @param {number} messageId 消息id
* @param {MessageStatus} status 消息状态,可选值参考{@link MessageStatus}
*/
async updateMessageStatus(messageId, status) {
impl.updateMessageStatus(messageId, status);
}
/**
* 上传媒体文件
* @param {string} fileName
* @param {string} fileOrData base64格式的dataUri
* @param {number} mediaType 媒体类型,可选值参考{@link MessageContentMediaType}
* @param {function (string)} successCB 回调通知上传成功之后的url
* @param {function (number)} failCB
* @param {function (number, number)} progressCB
* @returns {Promise<void>}
*/
async uploadMedia(fileName, fileOrData, mediaType, successCB, failCB, progressCB) {
impl.uploadMedia(fileName, fileOrData, mediaType, successCB, failCB, progressCB);
}
getVersion() {
return impl.getVersion();
}
/**
* 获取经过认证的下载地址。
*/
getAuthorizedMediaUrl(messageUid, mediaType, mediaPath, successCB, failCB) {
impl.getAuthorizedMediaUrl(messageUid, mediaType, mediaPath, successCB, failCB)
}
/**
* 是否支持上传大文件上传。只有专业版才支持此功能。当支持大文件上传时,调用getUploadMediaUrl获取上传url,然后在应用层上传
*/
isSupportBigFilesUpload() {
return impl.isSupportBigFilesUpload();
}
/**
* 获取上传链接。一般用户大文件上传。
* @param {string} fileName
* @param {number} mediaType 媒体类型,可选值参考{@link MessageContentMediaType}
* @param {string} contentType HTTP请求的ContentType header,为空时默认为"application/octet-stream"
* @param {function (string, string)} successCB 回调通知上传成功之后的url
* @param {function (number)} failCB
*/
getUploadMediaUrl(fileName, mediaType, contentType, successCB, failCB) {
impl.getUploadMediaUrl(fileName, mediaType, contentType, successCB, failCB);
}
/**
* 微信小程序切到前台时调用应用切到了前台
*
*/
onForeground() {
impl.onForeground();
}
/**
*
* 是否开启了已送达报告和已读报告功能
* @return {boolean}
*/
isReceiptEnabled() {
return impl.isReceiptEnabled();
}
/**
* 当前用户是否开启消息回执
* @return {boolean}
*/
isUserReceiptEnabled() {
return impl.isUserReceiptEnabled();
}
/**
* 判断是否是专业版IM服务
* @return {boolean}
*/
isCommercialServer() {
return impl.isCommercialServer();
}
/**
* 判断是否应用禁止草稿同步
* @return {boolean}
*/
isGlobalDisableSyncDraft() {
return impl.isGlobalDisableSyncDraft();
}
/**
*
* @param disable
* @param successCB
* @param failCB
*/
setDisableSyncDraft(disable, successCB, failCB) {
impl.setDisableSyncDraft(disable, successCB, failCB)
}
isDisableSyncDraft() {
return impl.isDisableSyncDraft();
}
/**
* 设置当前用户是否开启消息回执
* @param enable
* @param successCB
* @param failCB
*/
setUserEnableReceipt(enable, successCB, failCB) {
impl.setUserEnableReceipt(enable, successCB, failCB);
}
/**
*
* @param conversation
* @return {Map<string, Long>}
*/
getConversationDelivery(conversation) {
return impl.getConversationDelivery(conversation);
}
/**
*
* @param conversation
* @return {Map<string, Long>}
*/
getConversationRead(conversation) {
return impl.getConversationRead(conversation);
}
/**
* 获取会话中的文件记录
* @param {Conversation} conversation 会话
* @param {String} fromUser 来源用户
* @param {Long} beforeMessageUid 消息uid,表示获取此消息uid之前的文件记录
* @param {number} count 数量
* @param {function (FileRecord[])} successCB 成功回调
* @param {function (number)} failCB 失败回调
*/
getConversationFileRecords(conversation, fromUser, beforeMessageUid, count, successCB, failCB) {
impl.getConversationFileRecords(conversation, fromUser, beforeMessageUid, count, successCB, failCB);
}
/**
* 获取我发送的文件记录
* @param {Long} beforeMessageUid 消息uid,表示获取此消息uid之前的文件记录
* @param {number} count 数量
* @param {function (FileRecord[])} successCB 成功回调
* @param {function (number)} failCB 失败回调
*/
getMyFileRecords(beforeMessageUid, count, successCB, failCB) {
impl.getMyFileRecords(beforeMessageUid, count, successCB, failCB);
}
/**
* 删除文件记录
* @param {Long} messageUid 文件对应的消息的uid
* @param {function ()} successCB 成功回调
* @param {function (number)} failCB 失败回调
*/
deleteFileRecord(messageUid, successCB, failCB) {
impl.deleteFileRecord(messageUid, successCB, failCB);
}
/**
* 搜索远程文件记录
* @param {string} keyword
* @param {Conversation} conversation 会话,如果为空则获取当前用户所有收到和发出的文件记录
* @param {string} fromUser 文件发送用户,如果为空则获取该用户发出的文件记录
* @param {Long | string} beforeMessageId 起始消息的消息id
* @param {number} count
* @param {function (FileRecord[])} successCB
* @param {function (number)} failCB
*/
searchFiles(keyword, conversation, fromUser, beforeMessageId, count, successCB, failCB) {
impl.searchFiles(keyword, conversation, fromUser, beforeMessageId, count, successCB, failCB)
}
/**
* 搜索我自己的远程文件记录
* @param keyword
* @param beforeMessageUid
* @param count
* @param successCB
* @param failCB
*/
searchMyFiles(keyword, beforeMessageUid, count, successCB, failCB) {
impl.searchMyFiles(keyword, beforeMessageUid, count, successCB, failCB);
}
/**
* 获取host
*/
getHost() {
return impl.getHost();
}
getEncodedClientId() {
return impl.getEncodedClientId();
}
/**
*
* @param {string} data 将要编码的数据
* @returns {string} 编码结果,base64格式
*/
encodeData(data) {
return impl.encodeData(data);
}
/**
*
* @param {string} encodedData 将要解码的数据,base64格式
* @returns {null | string} 解码之后的数据
*/
decodeData(encodedData) {
return impl.decodeData(encodedData);
}
/**
* 发送会议相关请求
* @param sessionId
* @param roomId
* @param request
* @param data
* @param callback
*/
sendConferenceRequest(sessionId, roomId, request, data, callback) {
this.sendConferenceRequestEx(sessionId, roomId, request, data, false, callback)
}
sendConferenceRequestEx(sessionId, roomId, request, data, advance, callback) {
impl.sendConferenceRequest(sessionId, roomId, request, data, advance, callback);
}
isUserOnlineStateEnabled(){
return impl.isUserOnlineStateEnabled();
}
/**
*
* @param {number} type 会话类型, 支持{@link ConversationType.Single}和{@link ConversationType.Group}
* @param {string[]} targets 会话类型为单聊时,是用户 id列表;会话类型为群组时,是群组 id 列表
* @param {number} duration 关注时间长度,单位是秒
* @param {function(UserOnlineState[])} successCB
* @param {function(number)} failCB
*/
watchOnlineState(type, targets, duration, successCB, failCB){
impl.watchOnlineState(type, targets, duration, successCB, failCB);
}
unwatchOnlineState(type, targets, successCB, failCB){
impl.unwatchOnlineState(type, targets, successCB, failCB);
}
setMyCustomState(customState, customText, successCB, failCB){
impl.setMyCustomState(customState, customText, successCB, failCB)
}
_getStore() {
return impl._getStore();
}
_getStore() {
return impl._getStore();
}
/**
* 内部使用,electron主窗口之外的,其他窗口,attach到主窗口初始化的proto上,可以调用get相关方法,但没有通知
* @param protoObj
*/
attach(protoObj) {
impl.attach(protoObj);
}
/**
* utf8转base64
* @param {string} str
* @returns {string}
*/
utf8_to_b64(str) {
return btoa(unescape(encodeURIComponent(str)));
}
/**
* base64转utf8
* @param {string} str
* @returns {string}
*/
b64_to_utf8(str) {
return decodeURIComponent(escape(atob(str)));
}
unescape (str) {
return (str + '==='.slice((str.length + 3) % 4))
.replace(/-/g, '+')
.replace(/_/g, '/')
}
escape (str) {
return str.replace(/\+/g, '-')
.replace(/\//g, '_')
.replace(/=/g, '')
}
}
const self = new WfcManager();
export default self;
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/wang_im/uni-chat.git
git@gitee.com:wang_im/uni-chat.git
wang_im
uni-chat
uni-chat
main

搜索帮助

344bd9b3 5694891 D2dac590 5694891