TIM.create
初始化 SDK。TIM.create(options);
Name | Type | Description |
SDKAppID | Number | 即时通信 IM 应用的 SDKAppID |
oversea | Boolean | 如果您的应用需要在海外使用,请设置为 true,SDK 将替换域名,避免在某些国家或地区被干扰 |
// 从v2.11.2起,SDK 支持了 WebSocket,推荐接入;v2.10.2及以下版本,使用 HTTPimport TIM from 'tim-js-sdk';import TIMUploadPlugin from 'tim-upload-plugin';let options = {SDKAppID: 0 // 接入时需要将0替换为您的即时通信 IM 应用的 SDKAppID};// 创建 SDK 实例,`TIM.create()`方法对于同一个 `SDKAppID` 只会返回同一份实例let tim = TIM.create(options); // SDK 实例通常用 tim 表示// 设置 SDK 日志输出级别,详细分级请参见 <a href="https://web.sdk.qcloud.com/im/doc/en/SDK.html#setLogLevel">setLogLevel 接口的说明</a>tim.setLogLevel(0); // 普通级别,日志量较多,接入时建议使用// tim.setLogLevel(1); // release 级别,SDK 输出关键信息,生产环境时建议使用// 注册腾讯云即时通信 IM 上传插件tim.registerPlugin({'tim-upload-plugin': TIMUploadPlugin});
// SDK 进入 ready 状态时触发,接入侧监听此事件,然后可调用 SDK 发送消息等 API,使用 SDK 的各项功能let onSdkReady = function(event) {let message = tim.createTextMessage({ to: 'user1', conversationType: 'C2C', payload: { text: 'Hello world!' }});tim.sendMessage(message);};tim.on(TIM.EVENT.SDK_READY, onSdkReady);// SDK 进入 not ready 状态时触发,此时接入侧将无法使用 SDK 发送消息等功能。如果想恢复使用,接入侧需调用 login 接口,驱动 SDK 进入 ready 状态let onSdkNotReady = function(event) {// 如果想使用发送消息等功能,接入侧需驱动 SDK 进入 ready 状态,重新调用 login 接口即可,如下所示:// tim.login({userID: 'your userID', userSig: 'your userSig'});};tim.on(TIM.EVENT.SDK_NOT_READY, onSdkNotReady);// SDK 收到推送的单聊、群聊、群提示、群系统通知的新消息,接入侧可通过遍历 event.data 获取消息列表数据并渲染到页面let onMessageReceived = function(event) {// event.data - 存储 Message 对象的数组 - [Message]};tim.on(TIM.EVENT.MESSAGE_RECEIVED, onMessageReceived);// SDK 收到消息被修改的通知,消息发送方可通过遍历 event.data 获取消息列表数据并更新页面上同 ID 消息的内容。let onMessageModified = function(event) {// event.data - 存储被修改过的 Message 对象的数组 - [Message]};tim.on(TIM.EVENT.MESSAGE_MODIFIED, onMessageModified);// SDK 收到消息被撤回的通知,可通过遍历 event.data 获取被撤回的消息列表数据并渲染到页面,如单聊会话内可展示为 "对方撤回了一条消息";群聊会话内可展示为 "XXX撤回了一条消息"。let onMessageRevoked = function(event) {// event.data - 存储 Message 对象的数组 - [Message] - 每个 Message 对象的 isRevoked 属性值为 true};tim.on(TIM.EVENT.MESSAGE_REVOKED, onMessageRevoked);// SDK 收到对端已读消息的通知,即已读回执。可通过遍历 event.data 获取对端已读的消息列表数据并渲染到页面,如单聊会话内可将己方发送的消息由“未读”状态改为“已读”。let onMessageReadByPeer = function(event) {// event.data - 存储 Message 对象的数组 - [Message] - 每个 Message 对象的 isPeerRead 属性值为 true};tim.on(TIM.EVENT.MESSAGE_READ_BY_PEER, onMessageReadByPeer);// SDK 收到了群消息的已读回执(v2.18.0起支持)let onMessageReadReceiptReceived = function(event) {// event.data - 存储消息已读回执信息的数组const readReceiptInfoList = event.data;readReceiptInfoList.forEach((item) => {const { groupID, messageID, readCount, unreadCount } = item;const message = tim.findMessage(messageID);if (message) {if (message.readReceiptInfo.unreadCount === 0) {// 全部已读} else {// message.readReceiptInfo.readCount - 消息最新的已读数// 如果想要查询哪些群成员已读了此消息,请使用 [getGroupMessageReadMemberList] 接口}}});};tim.on(TIM.EVENT.MESSAGE_READ_RECEIPT_RECEIVED, onMessageReadReceiptReceived);// 会话列表更新,event.data 是包含 Conversation 对象的数组let onConversationListUpdated = function(event) {console.log(event.data); // 包含 Conversation 实例的数组};tim.on(TIM.EVENT.CONVERSATION_LIST_UPDATED, onConversationListUpdated);// SDK 群组列表更新时触发,可通过遍历 event.data 获取群组列表数据并渲染到页面let onGroupListUpdated = function(event) {console.log(event.data);// 包含 Group 实例的数组};tim.on(TIM.EVENT.GROUP_LIST_UPDATED, onGroupListUpdated);// 群属性更新时触发,可通过 event.data 获取到更新后的群属性数据(v2.14.0起支持)let onGroupAttributesUpdated = function(event) {const groupID = event.data.groupID // 群组IDconst groupAttributes = event.data.groupAttributes // 更新后的群属性console.log(event.data);};tim.on(TIM.EVENT.GROUP_ATTRIBUTES_UPDATED, onGroupAttributesUpdated);// 创建话题时触发(v2.19.1起支持)let onTopicCreated = function(event) {const groupID = event.data.groupID // 话题所属社群 IDconst topicID = event.data.topicID // 话题 IDconsole.log(event.data);};tim.on(TIM.EVENT.TOPIC_CREATED, onTopicCreated);// 删除话题时触发(v2.19.1起支持)let onTopicDeleted = function(event) {const groupID = event.data.groupID // 话题所属社群 IDconst topicIDList = event.data.topicIDList // 删除的话题 ID 列表console.log(event.data);};tim.on(TIM.EVENT.TOPIC_DELETED, onTopicDeleted);// 话题资料更新时触发(v2.19.1起支持)let onTopicUpdated = function(event) {const groupID = event.data.groupID // 话题所属社群 IDconst topic = event.data.topic // 话题资料console.log(event.data);};tim.on(TIM.EVENT.TOPIC_UPDATED, onTopicUpdated);// 自己或好友的资料发生变更时触发,event.data 是包含 Profile 对象的数组let onProfileUpdated = function(event) {console.log(event.data); // 包含 Profile 对象的数组};tim.on(TIM.EVENT.PROFILE_UPDATED, onProfileUpdated);// SDK 黑名单列表更新时触发let onBlacklistUpdated = function(event) {console.log(event.data); // 我的黑名单列表,结构为包含用户 userID 的数组};tim.on(TIM.EVENT.BLACKLIST_UPDATED, onBlacklistUpdated);// 好友列表更新时触发let onFriendListUpdated = function(event) {console.log(event.data);}tim.on(TIM.EVENT.FRIEND_LIST_UPDATED, onFriendListUpdated);// 好友分组列表更新时触发let onFriendGroupListUpdated = function(event) {console.log(event.data);}tim.on(TIM.EVENT.FRIEND_GROUP_LIST_UPDATED, onFriendGroupListUpdated);// FRIEND_APPLICATION_LIST_UPDATEDlet onFriendApplicationListUpdated = function(event) {// friendApplicationList - 好友申请列表 - [FriendApplication]// unreadCount - 好友申请的未读数const { friendApplicationList, unreadCount } = event.data;// 发送给我的好友申请(即别人申请加我为好友)const applicationSentToMe = friendApplicationList.filter((friendApplication) => friendApplication.type === TIM.TYPES.SNS_APPLICATION_SENT_TO_ME);// 我发送出去的好友申请(即我申请加别人为好友)const applicationSentByMe = friendApplicationList.filter((friendApplication) => friendApplication.type === TIM.TYPES.SNS_APPLICATION_SENT_BY_ME);};tim.on(TIM.EVENT.FRIEND_APPLICATION_LIST_UPDATED, onFriendApplicationListUpdated);// 用户被踢下线时触发let onKickedOut = function(event) {console.log(event.data.type);// TIM.TYPES.KICKED_OUT_MULT_ACCOUNT(Web端,同一帐号,多页面登录被踢)// TIM.TYPES.KICKED_OUT_MULT_DEVICE(同一帐号,多端登录被踢)// TIM.TYPES.KICKED_OUT_USERSIG_EXPIRED(签名过期)// TIM.TYPES.KICKED_OUT_REST_API(REST API kick 接口踢出。v2.20.0起支持)};tim.on(TIM.EVENT.KICKED_OUT, onKickedOut);// 网络状态发生改变let onNetStateChange = function(event) {// v2.5.0 起支持// event.data.state 当前网络状态,枚举值及说明如下:// TIM.TYPES.NET_STATE_CONNECTED - 已接入网络// TIM.TYPES.NET_STATE_CONNECTING - 连接中。很可能遇到网络抖动,SDK 在重试。接入侧可根据此状态提示“当前网络不稳定”或“连接中”// TIM.TYPES.NET_STATE_DISCONNECTED - 未接入网络。接入侧可根据此状态提示“当前网络不可用”。SDK 仍会继续重试,若用户网络恢复,SDK 会自动同步消息};tim.on(TIM.EVENT.NET_STATE_CHANGE, onNetStateChange);
tim.destroy();
本页内容是否解决了您的问题?