簡(jiǎn)介
因項(xiàng)目需求, 需對(duì)tim-sdk接口進(jìn)行擴(kuò)展。目前僅擴(kuò)展了好友模塊(添加,刪除,校驗(yàn),查詢)
本文將為您詳細(xì)介紹即時(shí)通信(Web & 小程序)端SDK擴(kuò)展功能
- 注意: 因TIM SDK的js已被壓縮,所以只能在器內(nèi)部添加相應(yīng)的方法,需找到對(duì)應(yīng)的地方修改代碼!文檔最后附加已修改的SDK文件
- 版本:2.11.2
一、查詢好友
方法名: getFriendList()
參數(shù): 無(wú)
SDK中已自帶該方法, 無(wú)需重寫。默認(rèn)傳遞當(dāng)前登錄用戶為fromAccount查詢好友列表。詳細(xì)代碼如下
// 格式化后
{
key:"getFriendList",
value:function(){
var e=this,t="".concat(this._className,".getFriendList"),n={};
return n.fromAccount=this._userModule.getMyAccount(),
Ai.info("".concat(t," myAccount:").concat(n.fromAccount)),
this._userModule.request({protocolName:Wc,requestData:n})
.then((function(n){
// 詳細(xì)返回?cái)?shù)據(jù)請(qǐng)參考 [服務(wù)端Api-拉取好友](https://cloud.tencent.com/document/product/269/1647)
Ai.info("".concat(t," ok")),
// 對(duì)返回值格式化后填充到friends中
e._transformFriendList(n);
var o=Jn(e.friends.values());
return $f(o)}
)).catch((function(e){
return Ai.error("".concat(t," failed. error:"),e),Yf(e)}
))
}
}
// 已壓縮
{key:"getFriendList",value:function(){var e=this,t="".concat(this._className,".getFriendList"),n={};return n.fromAccount=this._userModule.getMyAccount(),Ai.info("".concat(t," myAccount:").concat(n.fromAccount)),this._userModule.request({protocolName:Wc,requestData:n}).then((function(n){Ai.info("".concat(t," ok")),e._transformFriendList(n);var o=Jn(e.friends.values());return $f(o)})).catch((function(e){return Ai.error("".concat(t," failed. error:"),e),Yf(e)}))}}
使用示例
tim.getFriendList().then(({data}) => {
for(let i = 0; i < data.length; i++) {
console.log(data)
}
return data
})
二、解析添加/刪除好友時(shí)的數(shù)據(jù)
方法名: _transformChangeFriend
// 已格式化
{
key:"_transformChangeFriend",
value:function(e,c){
var t=e.data;
if(!gu(t)&&!gu(t.resultItem)){
Ai.info("".concat(this._className,"._transformChangeFriend friendNum:").concat(t.resultItem.length));
var _t=this;
// 返回未添加成功的好友信息(包含需要同意申請(qǐng)的)
return t.resultItem.filter(function(it){
it.resultCode!==0&&Ai.error("".concat(_t._className, "._transformChangeFriend ",c,"[").concat(it.to,"] fail:").concat(it.resultInfo));
return it.resultCode!==0
})
}
}
}
// 已壓縮
{key:"_transformChangeFriend",value:function(e,c){var t=e.data;if(!gu(t)&&!gu(t.resultItem)){Ai.info("".concat(this._className,"._transformChangeFriend friendNum:").concat(t.resultItem.length));var _t=this;return t.resultItem.filter(function(it){it.resultCode!==0&&Ai.error("".concat(_t._className, "._transformChangeFriend ",c,"[").concat(it.to,"] fail:").concat(it.resultInfo));return it.resultCode!==0})}}}
三、添加好友
方法名: applyAddFriend()
參數(shù): [{toAccount: userId, addSource: 'AddSource_Type_PC_WEB'}, {...}]
toAccount 為用戶賬號(hào), addSource 要求以 AddSource_Type_ 開頭,詳情請(qǐng)參考 服務(wù)端Api-添加好友
添加的主要方法如下:
{key:"applyAddFriend",value:function(p){var t="".concat(this._className,".applyAddFriend");if(!Array.isArray(p))Ai.error("".concat(t," 參數(shù)必需是數(shù)組")),Yf({code:ql.DEL_FRIEND_INVALID_PARAM,message:Gf});p.length>1000&&(Ai.warn("".concat(t," 添加好友人數(shù)不能超過(guò)1000人")),p.length=1000);var e=this,n={};return n.fromAccount=this._userModule.getMyAccount(),n.addFriendItem=p,Ai.info("".concat(t," myAccount:").concat(n.fromAccount).concat(", addFriendItem: ").concat(p.toString())),this._userModule.request({protocolName:Fadd,requestData:n}).then((function(n){Ai.info("".concat(t," ok"));var o=e._transformChangeFriend(n,Fadd); return $f(o)})).catch((function(e){return Ai.error("".concat(t," failed. error:"),e),Yf(e)}))}}
{key:"applyAddFriend",value:function(e){return this.friendHandler.applyAddFriend(e)}}
{key:"applyAddFriend",value:function(e){return this._moduleManager.getModule(mc).applyAddFriend(e)}}
// 請(qǐng)求接口
this._configMap.set(Fadd,function(e){return{head:Fn(Fn({},e),{},{servcmd:"".concat(B_.NAME.FRIEND,".").concat(B_.CMD.FRIEND_ADD)}),body:{fromAccount:"",addFriendItem:[]}}}(e))
使用示例
let addFriendItem = [{toAccount: userId, addSource: 'AddSource_Type_PC_WEB'}];
tim.applyAddFriend(addFriendItem)
.then(({data}) => {
if (data.length > 0) {
// 需要對(duì)方同意
let needAgree = data.filter(it => it.resultCode === 30539);
if (needAgree.length === data.length) {
Message.success('添加好友申請(qǐng)已發(fā)送!')
} else {
// 對(duì)方未開啟或已屏蔽好友申請(qǐng), 詳細(xì)錯(cuò)誤碼請(qǐng)參考[添加好友錯(cuò)誤碼說(shuō)明](https://cloud.tencent.com/document/product/269/1643#.E9.94.99.E8.AF.AF.E7.A0.81.E8.AF.B4.E6.98.8E)
let noNeedAgree = data.find(it => it.resultCode !== 30539);
Message.error(`${noNeedAgree.to} 添加失敗! ${noNeedAgree.resultInfo} 【${noNeedAgree.resultCode}】`)
}
} else {
Message.success('好友已添加!')
}
dispatch('refreshList')
})
.catch(err => {
})
四、刪除好友
方法名: deleteFriend()
參數(shù): [ userId, userId ] 賬號(hào)數(shù)組
詳情請(qǐng)參考 服務(wù)端Api-刪除好友
添加的主要方法如下:
{key:"deleteFriend",value:function(p){var t="".concat(this._className,".deleteFriend");if(!Array.isArray(p))Ai.error("".concat(t," 參數(shù)必需是數(shù)組")),Yf({code:ql.DEL_FRIEND_INVALID_PARAM,message:Gf});p.length>1000&&(Ai.warn("".concat(t," 刪除好友人數(shù)不能超過(guò)1000人")),p.length=1000);var e=this,n={};return n.fromAccount=this._userModule.getMyAccount(),Ai.info("".concat(t," myAccount:").concat(n.fromAccount).concat(", toAccounts: ").concat(p.toString())),n.toAccount=p,this._userModule.request({protocolName:Fdel,requestData:n}).then((function(n){Ai.info("".concat(t," ok"));var o=e._transformChangeFriend(n,Fdel); return $f(o)})).catch((function(e){return Ai.error("".concat(t," failed. error:"),e),Yf(e)}))}}
{key:"deleteFriend",value:function(e){return this.friendHandler.deleteFriend(e)}}
{key:"deleteFriend",value:function(e){return this._moduleManager.getModule(mc).deleteFriend(e)}}
this._configMap.set(Fdel,function(e){return{head:Fn(Fn({},e),{},{servcmd:"".concat(B_.NAME.FRIEND,".").concat(B_.CMD.FRIEND_DELETE)}),body:{fromAccount:"",toAccount:[],deleteType:"Delete_Type_Single"}}}(e))
使用示例
tim.deleteFriend(idstr.split(','))
.then(({data: errList}) => {
if (errList.length > 0) {
Message.success(errList[0].to + ' 刪除失敗! ' + errList[0].resultInfo)
} else {
Message.success('刪除成功!')
}
dispatch('refreshList')
return resolve(errList);
})
.catch(err => {
return reject(err);
})
鏈接: https://pan.baidu.com/s/1DJUaTB0ePrL8DXVQL0dqjA
提取碼: 57bt