SDK Introduction

​

Design Philosophy

​

Architecture Overview

// Chat Manager
// Responsible for message-related CRUD operations like sending messages, deleting messages, 
// recalling messages, listening to chat messages, etc.
WKSDK.shared().chatManager;

// Connection Manager
// Responsible for establishing or disconnecting connections with IM, 
// monitoring IM connection status, etc.
WKSDK.shared().connectionManager;

// Channel Manager
// Responsible for channel data retrieval, caching and channel settings 
// like pinning, do not disturb, muting, etc.
WKSDK.shared().channelManager;

// Conversation Manager
// Responsible for maintaining recent conversation data like unread counts, 
// drafts, @mentions, last messages, etc.
WKSDK.shared().conversationManager;

// Reminder Manager
// Responsible for maintaining reminder items in recent conversations
WKSDK.shared().reminderManager;

​

Core Functionality Modules

​

Chat Management (ChatManager)

• Message sending, receiving, deletion
• Message recall and editing functionality
• Chat message listening
• Historical message queries
• Message status management

​

Connection Management (ConnectionManager)

• Establish WebSocket connection with IM server
• Connection disconnection and reconnection mechanism
• Connection status monitoring
• Network status handling
• Heartbeat keep-alive mechanism

​

Channel Management (ChannelManager)

• Channel data retrieval and caching
• Channel settings management (pinning, do not disturb, muting, etc.)
• Channel information synchronization
• Channel member management
• Channel status monitoring

​

Conversation Management (ConversationManager)

• Recent conversation data maintenance
• Unread message count statistics
• Conversation draft management
• @mention reminders
• Last message display
• Conversation sorting and filtering

​

Reminder Management (ReminderManager)

• Recent conversation reminder item maintenance
• Custom reminder types
• Reminder status management
• Reminder message handling

​

Platform Support

​

Browser Environment

• Modern browser WebSocket support
• Local storage (localStorage/indexedDB)
• File upload and download
• Notification API support

​

Node.js Environment

• Server-side WebSocket connections
• File system operations
• Database integration
• Server-side push notifications

​

Framework Integration

• React: Provides React Hooks support
• Vue: Provides Vue Composition API support
• Angular: Provides Angular service support
• Mini Programs: Supports WeChat Mini Programs and other platforms

​

Development Advantages

• Unified Entry Point: Access all functionality through WKSDK.shared()
• Modular Design: Clear separation of functional modules for easy maintenance
• Event-Driven: Asynchronous programming pattern based on event listening
• Cross-Platform: Supports both browser and Node.js environments
• Lightweight: Small core library size with on-demand loading
• TypeScript Support: Complete type definitions
• Modern: Supports ES6+ syntax and Promise/async-await

​

Technical Features

​

WebSocket Connection

• Automatic reconnection mechanism
• Connection status management
• Heartbeat detection
• Disconnection and reconnection

​

Data Storage

• Browser local storage
• Message local caching
• Offline message support
• Data synchronization mechanism

​

Message Processing

• Real-time message push
• Message deduplication
• Message sorting
• Message status synchronization

​

File Handling

• File upload and download
• Image compression
• File type detection
• Upload progress monitoring

​

Use Cases

​

Web Applications

• Online customer service systems
• Social chat applications
• Collaborative office platforms
• Online education platforms

​

Mobile H5

• Mobile web chat
• Hybrid app development
• PWA applications
• WeChat Official Accounts

​

Server Applications

• Message push services
• Chat bots
• Data synchronization services
• API gateway integration

​

Browser Compatibility

​

Installation Methods

​

NPM Installation

npm install wukongim-js-sdk

​

CDN Integration

<script src="https://unpkg.com/wukongim-js-sdk@latest/dist/wukongim.min.js"></script>

​

ES6 Modules

import WKSDK from 'wukongim-js-sdk';

​

CommonJS

const WKSDK = require('wukongim-js-sdk');

​

Quick Start Example

// Initialize SDK
const sdk = WKSDK.shared();

// Configure connection
sdk.config({
  addr: "ws://your-server.com:5200",
  apiURL: "http://your-api-server.com",
  uid: "user123",
  token: "user-token"
});

// Listen for messages
sdk.chatManager.addMessageListener((message) => {
  console.log('New message:', message);
});

// Connect to server
await sdk.connectionManager.connect();

// Send message
await sdk.chatManager.send({
  channel_id: "friend_user_id",
  channel_type: 1,
  content: "Hello from JavaScript SDK!"
});

​

Next Steps

1. SDK Integration - Start integrating WuKongIM JavaScript SDK
2. Basic Features - Learn basic SDK configuration and usage
3. Chat Management - Implement message sending and receiving functionality
4. Channel Management - Manage channels and members
5. Conversation Management - Handle conversation lists and unread messages