新增功能
This commit is contained in:
+71
@@ -0,0 +1,71 @@
|
||||
# Official JavaScript SDK for Tencent Cloud Lite Chat
|
||||
|
||||
## About Tencent Cloud Lite Chat
|
||||
|
||||
Tencent Cloud Lite Chat provides globally interconnected chat APIs, multi-platform SDKs. Includes message sending/receiving and user management features by default, fulfilling core IM capabilities, with a bundle size under 200 KB. With its flexible plugin architecture, the SDK enables seamless integration of comprehensive IM features. You can selectively include only the features you need, customize plugin combinations, and maintain optimal bundle size.
|
||||
|
||||
Lite Chat SDK provides basic version, standard version and professional version. @tencentcloud/lite-chat points to the standard version by default.
|
||||
|
||||
## Installation
|
||||
|
||||
```javascript
|
||||
npm install @tencentcloud/lite-chat --save
|
||||
```
|
||||
|
||||
## Getting started
|
||||
|
||||
### 1. create an SDK instance
|
||||
|
||||
```javascript
|
||||
import TencentCloudChat from '@tencentcloud/lite-chat';
|
||||
|
||||
// Create an SDK instance.
|
||||
// The `TencentCloudLiteChat.create()` method returns the same instance for the same `SDKAppID`.
|
||||
// The SDK instance is usually represented by `chat`.
|
||||
let chat = TencentCloudLiteChat.create({
|
||||
SDKAppID: 0 // Replace `0` with the `SDKAppID` of your Chat app during access.
|
||||
});
|
||||
```
|
||||
|
||||
### 2. Generate UserSig
|
||||
UserSig is a password used to log in to Tencent Cloud Lite Chat. It is the ciphertext obtained after data such as UserID is encrypted. This [document](https://trtc.io/document/34385) describes how to generate a UserSig.
|
||||
|
||||
### 3. Login in to the Lite Chat SDK
|
||||
|
||||
```javascript
|
||||
let promise = chat.login({userID: 'your userID', userSig: 'your userSig'});
|
||||
promise.then(function(imResponse) {
|
||||
console.log(imResponse.data); // Login successful
|
||||
if (imResponse.data.repeatLogin === true) {
|
||||
// Indicates that the account has logged in and that the current login will be a repeated login.
|
||||
console.log(imResponse.data.errorInfo);
|
||||
}
|
||||
}).catch(function(imError) {
|
||||
console.warn('login error:', imError); // Error information
|
||||
});
|
||||
```
|
||||
|
||||
## Switch to basic version
|
||||
|
||||
```javascript
|
||||
import TencentCloudChat from '@tencentcloud/lite-chat/baisc';
|
||||
```
|
||||
|
||||
## Switch to professional version
|
||||
|
||||
```javascript
|
||||
import TencentCloudChat from '@tencentcloud/lite-chat/professional';
|
||||
```
|
||||
|
||||
## Supported Browsers
|
||||
|
||||
| Browser | Supported versions |
|
||||
| ---- | ---- |
|
||||
| Chrome | 16 or higher |
|
||||
| Edge | 13 or higher |
|
||||
| Firefox | 11 or higher |
|
||||
| Safari | 7 or higher |
|
||||
| Internet Explorer | 10 or higher |
|
||||
| Opera | 12.1 or higher |
|
||||
| iOS Safari | 7 or higher |
|
||||
| Android Browser | 4.4 (Kitkat) or higher |
|
||||
+3144
File diff suppressed because it is too large
Load Diff
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+3144
File diff suppressed because it is too large
Load Diff
+39
@@ -0,0 +1,39 @@
|
||||
{
|
||||
"name": "@tencentcloud/lite-chat",
|
||||
"version": "1.6.9",
|
||||
"description": "Tencent Cloud Chat SDK for Web/Mini Program/uni-app/React Native/Donut",
|
||||
"main": "standard.js",
|
||||
"types": "index.d.ts",
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./index.d.ts",
|
||||
"default": "./standard.js"
|
||||
},
|
||||
"./basic": {
|
||||
"types": "./basic.d.ts",
|
||||
"default": "./basic.js"
|
||||
},
|
||||
"./standard": {
|
||||
"types": "./index.d.ts",
|
||||
"default": "./standard.js"
|
||||
},
|
||||
"./professional": {
|
||||
"types": "./professional.d.ts",
|
||||
"default": "./professional.js"
|
||||
},
|
||||
"./plugins/*": {
|
||||
"types": "./plugins/*.d.ts",
|
||||
"default": "./plugins/*.js"
|
||||
}
|
||||
},
|
||||
"miniprogram": "./",
|
||||
"keywords": ["chat", "real-time chat", "uni-app", "React Native", "Donut", "push", "messaging", "IM", "trtc"],
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://trtc.io/products/chat"
|
||||
},
|
||||
"dependencies": {},
|
||||
"author": "Tencent Cloud Terminal R&D Center",
|
||||
"license": "ISC"
|
||||
}
|
||||
|
||||
+8
@@ -0,0 +1,8 @@
|
||||
declare const avChatRoomPlugin: {
|
||||
[key: string]: any;
|
||||
};
|
||||
|
||||
export default avChatRoomPlugin;
|
||||
declare module '@tencentcloud/lite-chat/plugins/avchatroom' {
|
||||
export default avChatRoomPlugin;
|
||||
}
|
||||
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+9
@@ -0,0 +1,9 @@
|
||||
declare const cloudSearchPlugin: {
|
||||
[key: string]: any;
|
||||
};
|
||||
|
||||
export default cloudSearchPlugin;
|
||||
declare module '@tencentcloud/lite-chat/plugins/cloud-search' {
|
||||
export default cloudSearchPlugin;
|
||||
}
|
||||
|
||||
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+8
@@ -0,0 +1,8 @@
|
||||
declare const conversationGroupPlugin: {
|
||||
[key: string]: any;
|
||||
};
|
||||
|
||||
export default conversationGroupPlugin;
|
||||
declare module '@tencentcloud/lite-chat/plugins/conversation-group' {
|
||||
export default conversationGroupPlugin;
|
||||
}
|
||||
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+8
@@ -0,0 +1,8 @@
|
||||
declare const conversationPlugin: {
|
||||
[key: string]: any;
|
||||
};
|
||||
|
||||
export default conversationPlugin;
|
||||
declare module '@tencentcloud/lite-chat/plugins/conversation' {
|
||||
export default conversationPlugin;
|
||||
}
|
||||
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+8
@@ -0,0 +1,8 @@
|
||||
declare const followPlugin: {
|
||||
[key: string]: any;
|
||||
};
|
||||
|
||||
export default followPlugin;
|
||||
declare module '@tencentcloud/lite-chat/plugins/follow' {
|
||||
export default followPlugin;
|
||||
}
|
||||
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+8
@@ -0,0 +1,8 @@
|
||||
declare const friendPlugin: {
|
||||
[key: string]: any;
|
||||
};
|
||||
|
||||
export default friendPlugin;
|
||||
declare module '@tencentcloud/lite-chat/plugins/friend' {
|
||||
export default friendPlugin;
|
||||
}
|
||||
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+8
@@ -0,0 +1,8 @@
|
||||
declare const groupPlugin: {
|
||||
[key: string]: any;
|
||||
};
|
||||
|
||||
export default groupPlugin;
|
||||
declare module '@tencentcloud/lite-chat/plugins/group' {
|
||||
export default groupPlugin;
|
||||
}
|
||||
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+8
@@ -0,0 +1,8 @@
|
||||
declare const messageEnhancerPlugin: {
|
||||
[key: string]: any;
|
||||
};
|
||||
|
||||
export default messageEnhancerPlugin;
|
||||
declare module '@tencentcloud/lite-chat/plugins/message-enhancer' {
|
||||
export default messageEnhancerPlugin;
|
||||
}
|
||||
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
Generated
Vendored
+9
@@ -0,0 +1,9 @@
|
||||
declare const offlineMessageSynchronizer: {
|
||||
[key: string]: any;
|
||||
};
|
||||
|
||||
export default offlineMessageSynchronizer;
|
||||
declare module '@tencentcloud/lite-chat/plugins/offline-message-synchronizer' {
|
||||
export default offlineMessageSynchronizer;
|
||||
}
|
||||
|
||||
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+8
@@ -0,0 +1,8 @@
|
||||
declare const richMediaMessagePlugin: {
|
||||
[key: string]: any;
|
||||
};
|
||||
|
||||
export default conversationPlugin;
|
||||
declare module '@tencentcloud/lite-chat/plugins/rich-media-message' {
|
||||
export default richMediaMessagePlugin;
|
||||
}
|
||||
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+8
@@ -0,0 +1,8 @@
|
||||
declare const signalingPlugin: {
|
||||
[key: string]: any;
|
||||
};
|
||||
|
||||
export default signalingPlugin;
|
||||
declare module '@tencentcloud/lite-chat/plugins/signaling' {
|
||||
export default signalingPlugin;
|
||||
}
|
||||
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+8
@@ -0,0 +1,8 @@
|
||||
declare const topicPlugin: {
|
||||
[key: string]: any;
|
||||
};
|
||||
|
||||
export default topicPlugin;
|
||||
declare module '@tencentcloud/lite-chat/plugins/topic' {
|
||||
export default topicPlugin;
|
||||
}
|
||||
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+3144
File diff suppressed because it is too large
Load Diff
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user