更新记录

1.8.2（2023-07-17）

适配ios16

1.8.1（2021-12-14）

修复ios发送自定义消息失败的问题

1.8.0（2021-11-11）

新增设置用户信息部分字段

平台兼容性

原生插件通用使用流程：

1. 购买插件，选择该插件绑定的项目。
2. 在HBuilderX里找到项目，在manifest的app原生插件配置中勾选模块，如需要填写参数则参考插件作者的文档添加。
3. 根据插件作者的提供的文档开发代码，在代码中引用插件，调用插件功能。
4. 打包自定义基座，选择插件，得到自定义基座，然后运行时选择自定义基座，进行log输出测试。
5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项：使用HBuilderX2.7.14以下版本，如果同一插件且同一appid下购买并绑定了多个包名，提交云打包界面提示包名绑定不一致时，需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择

TX-TencentIM组件

TX-TencentIM致力于让用户轻松使用im的各种功能，插件永久维护，欢迎提需求👏👏👏

快速接入方法

加载模块

const txIm = uni.requireNativePlugin('TX-TencentIM');

初始化腾讯云SDK

 let isSuccess = txIm.initSDK({
     sdkAppID:1400267352,
     logLevel:0
   },result=>{
        console.log(result);
   })

登录腾讯云IM（一定要先初始化腾讯云SDK后登录）

txIm.login({
                                            sdkAppID: 1400267352,
                                            sdkAppKey: "5f787315061dcad732b8b41185c7b63b09d2a57d8efe1219d803920f84963a0b",
                                            userId: "userTest1",
                                            expireTime:604800,
                                            filePath: plus.io.convertLocalFileSystemURL('_doc')
                                        }, result => {
                                            console.log(result);
                        })

登出腾讯云im

txIm.logout(result=>{
                                            console.log(result);
                        }) 

获取当前登录用户

let user = txIm.getLoginUser();
                console.log(user);

销毁im

    txIm.unInitSDK(result=>{
                    console.log(result);
                })  

获取腾讯云im的登录状态

let status = txIm.getLoginStatus();
console.log(status);

设置基本消息（文本消息和自定义消息）的事件监听器

txIm.addSimpleMsgListener(result=>{
                    console.log(result);
                })

设置高级消息接口监听

    txIm.addAdvancedMsgListener(result=>{
                    console.log(result);
                })

消息字段elemType支持的消息如下

设置群消息监听

    txIm.setGroupListener(result=>{
                    console.log(result);
    })

设置会话监听器

txIm.setConversationListener(result=>{
                    console.log(result);
                })

设置好友消息监听

    txIm.setFriendListener(result=>{
                    console.log(result);
    })

移除基本消息（文本消息和自定义消息）的事件监听器

txIm.removeSimpleMsgListener();

移除高级消息监听

txIm.removeAdvancedMsgListener()

移除群消息监听

txIm.removeGroupListener()

移除好友消息监听

txIm.removeFriendListener()

移除好友监听器

txIm.removeConversationListener()

移除不需要的消息，可以关闭会话的时候调用

txIm.removeMessages({"msgIdList":[this.currentMsgId]},result=>{
                    console.log(result);
                })

添加朋友

txIm.addFriend({"userId":"user","addWording":"你好","addSource":"andriod",addType:1},result=>{
                    console.log(result)
 })

获取当前用户已经加入的群列表

    txIm.getJoinedGroupList(result=>{
                                                console.log(result);
    });

好友列表

    txIm.getFriendList(result=>{
                console.log(result);
    });

获取指定好友资料

txIm.getFriendsInfo({"userIdList":["userTest1","userTest2"]},result=>{
                    console.log(result);
})

拉取群资料

txIm.getGroupsInfo({"groupIdList":["groupTest1","groupTest2"]},result=>{
                    console.log(result);
})

修改群资料

    txIm.setGroupInfo({"groupId":"","groupName":"测试设置       groupName","groupAvatar":"","introduction":"",notification:"","allMuted":false},result=>{
                    console.log(result);
    })

修改群消息接收选项

    txIm.setReceiveMessageOpt({"groupId":"testGroup1","opt":0},result=>{
                    console.log(result);
    })

获取群成员列表

txIm.getGroupMemberList({"groupId":"testGroup1","filter":0,"nextSeq":0},result=>{
                    console.log(result);
    })

获取指定的群成员资料

    txIm.getGroupMembersInfo({"groupId":this.groupId,"memberList":userIdArr},result=>{
                    console.log(result);
                })

修改指定的群成员资料

txIm.setGroupMemberInfo({"groupId":"testGroup1","userId":"userTest1","nameCard":"nameCard"},result=>{
                    console.log(result);
})

禁言群成员

txIm.muteGroupMember({"groupId":"testGroup1","userId":"userTest1","stime":1000},result=>{
                    console.log(result);
    })

邀请他人入群

    txIm.inviteUserToGroup({"groupId":"testGroup1","userIdList":["userTest1"]},result=>{
                    console.log(result);
                })

踢人

    txIm.kickGroupMember({"groupId":"testGroup1","userIdList":["userTest1"],"reason":"reason"},result=>{
                    console.log(result);
                })

切换群成员的角色

txIm.setGroupMemberRole({"groupId":"testGroup1","userId":"userTest1","role":300},result=>{
                    console.log(result);
    })

转让群

txIm.transferGroupOwner({"groupId":"testGroup1","userId":"userTest2"},result=>{
                    console.log(result);
                })

获取加群的申请列表

txIm.getGroupApplicationList(result=>{
                    console.log(result);
                    if(result.groupApplicationList.length > 0) {
                        this.groupApplicationIndex = 0;
                    }
                })

获取加群的申请列表

txIm.getGroupApplicationList(result=>{
                    console.log(result);
                    if(result.groupApplicationList.length > 0) {
                        this.groupApplicationIndex = 0;
                    }
})

同意某一条加群申请

txIm.acceptGroupApplication({"index":0},result=>{
                    console.log(result);
    })

拒绝某一条加群申请

    txIm.refuseGroupApplication({"index":0},result=>{
                    console.log(result);
                })

标记申请列表为已读

txIm.setGroupApplicationRead(result=>{
                    console.log(result);
                })

获取会话列表

txIm.getConversationList({nextSeq:0,count:100},result=>{
                    console.log(result);
                    if(result.conversationList.length > 0) {
                        this.conversationId = result.conversationList[0].conversationId
                    }
    })

删除会话

    txIm.deleteConversation({conversationId:""},result=>{
                    console.log(result);
        })

设置会话草稿

txIm.setConversationDraft({conversationId:"",draftText:""},result=>{

})

获取用户资料

txIm.getUsersInfo({userIdList:["userTest1"]},result=>{
                    console.log(result);
        })

修改个人资料

    txIm.setSelfProfile({"userName":"myUserName","userAvatar":"",gender:1},result=>{
                    console.log(result);
                })

设置会话草稿

    txIm.setConversationDraft({"conversationId":"test","draftText":"test"},result=>{
                    console.log(result);
                })

发送群文本消息

    txIm.sendGroupTextMessage({"textMsg":"hello my group message","groupId":"testGroup1","priority":0},result=>{
                    console.log(result);
                })

发送群自定义消息

txIm.sendGroupCustomMessage({"customMsg":"hello my group custom message","groupId":"","priority":0},result=>{
                    console.log(result);
        })

发送一对一消息

txIm.sendC2CTextMessage({"textMsg":"hello","userId":"userTest1"},result=>{
                    console.log(result);
    });

发送一对一自定义消息

txIm.sendC2CCustomMessage({"customMsg":"hello","userId":"userTest1"},result=>{
                    console.log(result);
    });

发送图片消息

txIm.sendImageMessage({"path":"","userId":"userTest1"},result=>{
                    console.log(result);
    });

发送声音消息

    txIm.sendSoundMessage({"path":"","userId":"userTest1","duration":1},result=>{
                console.log(result); 
    });

发送视频消息

    txIm.sendVideoMessage({"path":"","userId":"userTest1","duration":1},result=>{
                console.log(result); 
    });

发送文件消息

txIm.sendFileMessage({"path":res.filePath,"userId":user,fileName:res.fileName},result=>{
                                        console.log(result);
    });

发送位置消息

txIm.sendLocationMessage({"userId":user,"des":"","longitude":66,"latitude":66,"priority":0},result=>{
                            console.log(result);
    });

发送表情包消息

    txIm.sendFaceMessage({
                    "userId":user,
                    faceIndex:19,
                    faceData:""
                },result=>{
                    console.log(result);
    })

也可以直接创建消息后使用sendMessage发送，如果你需要一些特殊的操作，比如创建后拼接一些附加消息，建议使用这种方式

创建文本消息

    let message = txIm.createTextMessage({textMsg:"test"});

创建自定义消息

    let message = txIm.createCustomMessage({customMsg:"test",desc:"",extension:""});

创建图片消息

    let message = txIm.createImageMessage({path:this.imagePath});

创建语音消息

    let message = txIm.createSoundMessage({path:"",duration:0}) 

创建视频消息

    let message = txIm.createVideoMessage({path:"",type:0,duration:0,snapshotPath:""}); 

创建文件消息

    let message = txIm.createFileMessage({path:"",fileName:""});    

创建位置消息

    let message = txIm.createLocationMessage({des:"",longitude:0,latitude:0});  

创建表情消息

    let message = txIm.createFaceMessage({faceIndex:0,faceData:""});    

创建@消息

    let message = txIm.createTextAtMessage({textMsg:"",userIdList:[]}); 

发送消息

    txIm.sendMessage({"userId":user,"createMessageId":this.createMessageId},result=>{
                    console.log(result);
                })      

消息操作函数（用在特定消息后再拼接自定义消息）

    txIm.appendElem({"text":"hello ext text","createMessageId":this.createMessageId},result=>{
                    console.log(result);
                })

创建群

    txIm.createGroup({
                    groupType: "Work",
                    groupId: this.groupId,
                    groupName: "my_group"
                }, result => {
                    console.log(result);

                })

选择群成员创建群

txIm.createGroupWithMemberList({
                    groupType: "Public",
                    groupId: this.groupId,
                    groupName: "my_group",
                    groupAvatar:"",
                    introduction:"",
                    memberList:[
                        {
                            userId:"MyGroupUserId1",
                            role:400
                        },
                        {
                            "userId":"MyGroupUserId2",
                            "role":0
                        },
                        {
                            "userId":"MyGroupUserId3",
                            "role":400
                        }

                    ]
                }, result => {
                    console.log(result);

                })

加入群

txIm.joinGroup({"groupId":"testGroup1",msg:""},result=>{
                    console.log(result);
})

离开群

    txIm.quitGroup({"groupId":"testGroup1"},result=>{
                    console.log(result);
    })

删除群

    txIm.deleteGroup({"groupId":"testGroup1"},result=>{
                    console.log(result);
    })

获取指定群在线人数

    txIm.getGroupOnlineMemberCount({groupId:this.groupId},result=>{
                    console.log(result);
                })

初始化群属性

    txIm.initGroupAttributes({groupId:this.groupId,attributes:{key:"key1"}},result=>{
                    console.log(result);
                })

获取群属性

    txIm.getGroupAttributes({groupId:this.groupId},result=>{
                    console.log(result);
                })

设置群属性

txIm.setGroupAttributes({groupId:this.groupId,attributes:{
                        "key1":"value1",
                        "key2":"value2"
                    }},result=>{
                        console.log(result);
                    })

删除群属性

    txIm.deleteGroupAttributes({groupId:this.groupId,keys:["key1","key2"]},result=>{
                    console.log(result);
                })

禁言

删除好友

txIm.deleteFromFriendList({
                    "userIdList":["userTest2"],
                    "deleteType":1
                },result=>{
                    console.log(result);
    })

删除消息

  txIm.deleteMessages({"msgIdList":[this.currentMsgId]},result=>{
                    console.log(result);
                })  

检查指定用户的好友关系

txIm.checkFriend({
                    "userId":"userTest2",
                },result=>{
                    console.log(result);
    })

获取好友申请列表

txIm.getFriendApplicationList(result=>{
                    console.log(result);
    })

接受好友申请

txIm.acceptFriendApplication({
                    "userId":"userTest2",
                    "type":0
                },result=>{
                    console.log(result);
    })

拒绝好友申请

txIm.refuseFriendApplication({
                    "userId":"userTest2"
                },result=>{
                    console.log(result);
    })

删除好友申请

txIm.deleteFriendApplication({
                    "userId":"userTest2"
                },result=>{
                    console.log(result);
    })

置好友申请已读

txIm.setFriendApplicationRead(
        result=>{
                    console.log(result);
    })

添加用户到黑名单

txIm.addToBlackList({
                    "userIdList":["userTest2"]
                },result=>{
                    console.log(result);
    })

获取黑名单列表

txIm.getBlackList(
                    result=>{
                        console.log(result);
                    }
    )

把用户从黑名单中删除

txIm.deleteFromBlackList({"userIdList":["userTest1"]},
                    result=>{
                        console.log(result);
                    }
                )

新建好友分组

txIm.createFriendGroup({"groupName":this.friendGroupName,"userIdList":["userTest2"]},
                    result=>{
                        console.log(result);
                    }
                )

获取分组信息

txIm.getFriendGroupList({"groupNameList":["friendGroupName"]},result=>{
                    console.log(result);
    })

删除好友分组

txIm.deleteFriendGroup({"groupNameList":["friendGroupName"]},result=>{
                    console.log(result);
})

修改好友分组的名称

txIm.renameFriendGroup({"oldName":"oldName","newName":"newName"},result=>{
                    console.log(result);
    })

添加好友到一个好友分组

txIm.addFriendsToFriendGroup({"groupName":"friendGroupName","userIdList":["userTest1"]},
                    result=>{
                        console.log(result);
                    }
    )

从好友分组中删除好友

txIm.deleteFriendsFromFriendGroup({"groupName":"friendGroupName","userIdList":["userTest1"]},
                    result=>{
                        console.log(result);
                    }
)

获取单聊历史消息

txIm.getC2CHistoryMessageList({"userId":"userTest1","count":10,"msgId":""},result=>{
                    console.log(result);
    })

获取群组历史消息

txIm.getGroupHistoryMessageList({"groupId":"groupTest1","count":10,"msgId":""},result=>{
                    console.log(result);
    })

撤回消息

    txIm.revokeMessage({"msgId":this.currentMsgId},result=>{
                    console.log(result);
    });

设置单聊消息已读

    txIm.markC2CMessageAsRead({"userId":"userTest2"},result=>{
                    console.log(result);
    })

设置群组消息已读

txIm.markGroupMessageAsRead({"groupId":this.groupId},result=>{
                    console.log(result);
    })

删除本地消息

    txIm.deleteMessageFromLocalStorage({"msgId":this.currentMsgId},result=>{
                    console.log(result);
    });

向群组消息列表中添加一条消息

txIm.insertGroupMessageToLocalStorage({"createMessageId":this.createMessageId,"groupId":this.groupId,"userId":this.currentUser},result=>{
                    console.log(result);
    });

插入一对一单聊消息

txIm.insertC2CMessageToLocalStorage({"createMessageId":this.createMessageId,"sender":this.currentUser,"to":user},result=>{
                    console.log(result);
    });

发送群@消息

txIm.sendTextAtMessage({"textMsg":"@消息","groupId":this.groupId,"userIdList":["userTest1","all"]},result=>{
                    console.log(result);
    });

设置指定好友资料

txIm.setFriendInfo({"userId":"userTest2","friendRemark":"friendRemarkValue"},result=>{
                    console.log(result);
    });

添加信令监听

  txIm.addSignalingListener(result=>{
                                                    console.log(result);
                                                });

邀请某个人

txIm.invite({"invitee":user,"data":JSON.stringify(data),"onlineUserOnly":false},result=>{
                    console.log(result);
                });

移除信令监听

txIm.removeSignalingListener();

邀请群内的某些人

txIm.inviteInGroup({"groupId":this.group,"inviteeList":[user],"data":JSON.stringify(data),"onlineUserOnly":false},result=>{
                    console.log(result);
                });

接收方接受邀请

txIm.accept({"inviteId":this.inviteData.inviteId,data:JSON.stringify(data)},result=>{
                        console.log(result);
                    });

接收方拒绝邀请

txIm.reject({"inviteId":this.inviteData.inviteId,data:JSON.stringify(data)},result=>{
                        console.log(result);
                    });

邀请方取消邀请

txIm.cancel({"inviteId":this.inviteData.inviteId,data:JSON.stringify(data)},result=>{
                        console.log(result);
                    });

下载图片

txIm.downloadImage({"msgId":msg.msgId},progressResult=>{
                                console.log(progressResult);
                            },succResult=>{
                                console.log(succResult);
                            },failResult=>{
                                console.log(failResult);
                            })

下载语音

txIm.downloadSound({"msgId":msg.msgId},progressResult=>{
                                console.log(progressResult);
                            },succResult=>{
                                console.log(succResult);
                            },failResult=>{
                                console.log(failResult);
                            })

下载视频

txIm.downloadVideo({"msgId":msg.msgId},progressResult=>{
                                console.log(progressResult);
                            },succResult=>{
                                console.log(succResult);
                            },failResult=>{
                                console.log(failResult);
                            })

下载文件

txIm.downloadFile({"msgId":msg.msgId},progressResult=>{
                                console.log(progressResult);
                            },succResult=>{
                                console.log(succResult);
                            },failResult=>{
                                console.log(failResult);
                            })

获取image的url

txIm.getImageUrl({"msgId":msg.msgId},result=>{
                                console.log(result);
                            })

获取sound资源url

txIm.getSoundUrl({"msgId":msg.msgId},result=>{
                                console.log(result);
                            })

获取视频资源url

txIm.getVideoUrl({"msgId":msg.msgId},result=>{
                                console.log(result);
                            })

获取文件url

txIm.getFileUrl({"msgId":msg.msgId},result=>{
                                console.log(result);
                            })

上传apple推送证书

txIm.setAPNS({businessId:23834},result=>{

                                                });

上传安卓平台证书

txIm.setOfflinePushConfig({"businessId":11632,"token":""},result=>{
                                                    console.log(result);
                                                })

获取ios的token

let token = txIm.getPushToken();