Chat App
Status: {connected ? 'Connected' : 'Disconnected'}
);
}
```
--------------------------------
### Quick Start: Initialize, Configure, and Send Message with WuKongIM SDK
Source: https://docs.githubim.com/en/sdk/wukongim/javascript/intro
This example demonstrates the basic usage of the WuKongIM JavaScript SDK. It covers initializing the SDK, configuring connection parameters, setting up a message listener, connecting to the server, and sending a chat message.
```javascript
// 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!"
});
```
--------------------------------
### Create New Plugin Project (Bash & Go)
Source: https://docs.githubim.com/en/getting-started/learning/plugin-development
These commands set up a new directory for your WuKongIM plugin, initialize a Go module, and fetch the necessary WuKongIM plugin development library (go-pdk). Ensure you are in the desired parent directory before running.
```bash
mkdir my-plugin
cd my-plugin
go mod init my-plugin
go get github.com/WuKongIM/go-pdk
```
--------------------------------
### Configure and Start Prometheus Service
Source: https://docs.githubim.com/en/installation/linux/monitoring
This section details how to create a systemd service file for Prometheus, enabling it to run as a background service. It specifies the user, group, and executable path, along with configuration and storage directories. After creating the service file, it guides through enabling and starting the Prometheus service, followed by a status check.
```bash
sudo nano /etc/systemd/system/prometheus.service
```
```ini
[Unit]
Description=Prometheus
Wants=network-online.target
After=network-online.target
[Service]
User=prometheus
Group=prometheus
Type=simple
ExecStart=/usr/local/bin/prometheus \
--config.file /etc/prometheus/prometheus.yml \
--storage.tsdb.path /var/lib/prometheus/ \
--web.console.templates=/etc/prometheus/consoles \
--web.console.libraries=/etc/prometheus/console_libraries \
--web.listen-address=0.0.0.0:9090 \
--web.external-url=
[Install]
WantedBy=multi-user.target
```
```bash
sudo systemctl daemon-reload
sudo systemctl enable prometheus
sudo systemctl start prometheus
sudo systemctl status prometheus
```
--------------------------------
### Install WuKongIM Web EasySDK using npm, yarn, or CDN
Source: https://docs.githubim.com/en/sdk/easy/javascript/getting-started
Provides commands and script tags for installing the WuKongIM Web EasySDK. Choose the method that best suits your project's package management system. Ensure you are using a supported modern browser.
```bash
npm install easyjssdk
```
```bash
yarn add easyjssdk
```
```html
```
--------------------------------
### Get IM Address using Python
Source: https://docs.githubim.com/en/api/route/get-address
Example of how to retrieve the IM connection address using the Python requests library. This demonstrates making a GET request and handling the JSON response.
```python
import requests
response = requests.get('http://localhost:5001/route', params={'intranet': 0})
data = response.json()
print(data)
```
--------------------------------
### Get Channel Whitelist using Go HTTP Client
Source: https://docs.githubim.com/en/api/channel/get-whitelist
Illustrates how to get the channel whitelist using Go's built-in `net/http` package. This example constructs the full URL with query parameters and makes a GET request, then decodes the JSON response into a string slice.
```go
package main
import (
"encoding/json"
"fmt"
"net/http"
"net/url"
)
func main() {
baseURL := "http://localhost:5001/channel/whitelist"
params := url.Values{}
params.Add("channel_id", "group123")
params.Add("channel_type", "2")
fullURL := baseURL + "?" + params.Encode()
resp, err := http.Get(fullURL)
if err != nil {
panic(err)
}
defer resp.Body.Close()
var result []string
json.NewDecoder(resp.Body).Decode(&result)
fmt.Printf("%+v\n", result)
}
```
--------------------------------
### Initialize WuKongIM iOS EasySDK
Source: https://docs.githubim.com/en/sdk/easy/ios/getting-started
Demonstrates the initialization of the WuKongEasySDK with configuration details including the server URL, user ID, and authentication token. This is a prerequisite for establishing a connection and using SDK functionalities.
```swift
// 1. Initialize SDK
let config = WuKongConfig(
serverUrl: "ws://your-wukongim-server.com:5200",
uid: "your_user_id", // Your user ID
token: "your_auth_token" // Your authentication token
// deviceId: "optional_device_id", // Optional: Device ID
// deviceFlag: .APP // Optional: Device flag, default is .APP
)
let easySDK = WuKongEasySDK(config: config)
```
--------------------------------
### Initialize, Connect, and Send Message (Web/JavaScript)
Source: https://docs.githubim.com/en/sdk/easy/overview
Demonstrates the basic integration steps for WuKongEasySDK in a Web/JavaScript environment. This includes initializing the SDK with server details and authentication, setting up an event listener for incoming messages, connecting to the server, and sending a message to another user. Dependencies include the 'easyjssdk' library.
```javascript
import { WKIM, WKIMChannelType, WKIMEvent } from 'easyjssdk';
// 1. Initialize SDK
const im = WKIM.init("ws://your-server.com:5200", {
uid: "your_user_id",
token: "your_auth_token"
});
// 2. Listen for messages
im.on(WKIMEvent.Message, (message) => {
console.log("New message received:", message);
});
// 3. Connect to server
await im.connect();
// 4. Send message
const result = await im.send("friend_user_id", WKIMChannelType.Person, {
type: 1,
content: "Hello from Web!"
});
```
--------------------------------
### Start WuKongIM Service
Source: https://docs.githubim.com/en/installation/linux/multi-node
This command starts the WuKongIM service in detached mode. It requires a configuration file specified by the --config flag.
```bash
./wukongim --config wk.yaml -d
```
--------------------------------
### Get Migration Result Status (Go)
Source: https://docs.githubim.com/en/api/system/migrate
This Go example shows how to retrieve the migration result status using the `net/http` package. It performs a GET request, decodes the JSON response into a map, and prints the migration details.
```go
package main
import (
"encoding/json"
"fmt"
"net/http"
)
func main() {
resp, err := http.Get("http://localhost:5001/migrate/result")
if err != nil {
panic(err)
}
defer resp.Body.Close()
var result map[string]interface{}
json.NewDecoder(resp.Body).Decode(&result)
fmt.Printf("%+v\n", result)
}
```
--------------------------------
### Get Migration Result Status (JavaScript)
Source: https://docs.githubim.com/en/api/system/migrate
This JavaScript example demonstrates fetching the migration result status using the `fetch` API. It makes a GET request to the endpoint and parses the JSON response to log the migration data.
```javascript
const response = await fetch('http://localhost:5001/migrate/result');
const data = await response.json();
console.log(data);
```
--------------------------------
### Initialize WuKongIM Android EasySDK
Source: https://docs.githubim.com/en/sdk/easy/android/getting-started
Initialize the WuKongIM Android EasySDK with a configuration object. This involves setting the server URL, user ID, and authentication token. The SDK instance is obtained using a singleton pattern.
```kotlin
// 1. Initialize SDK
val config = WuKongConfig.Builder()
.serverUrl("ws://your-wukongim-server.com:5200")
.uid("your_user_id") // Your user ID
.token("your_auth_token") // Your authentication token
// .deviceId("optional_device_id") // Optional: Device ID
// .deviceFlag(WuKongDeviceFlag.APP) // Optional: Device flag, default is APP
.build()
val easySDK = WuKongEasySDK.getInstance()
easySDK.init(this, config) // this is Application or Activity context
```
--------------------------------
### Install WuKongIM JavaScript SDK via NPM
Source: https://docs.githubim.com/en/sdk/wukongim/javascript/intro
This command installs the WuKongIM JavaScript SDK using the Node Package Manager (NPM). Ensure you have Node.js and NPM installed on your system before running this command. This is the primary method for integrating the SDK into your project.
```bash
npm install wukongim-js-sdk
```
--------------------------------
### Get Channel Whitelist using cURL
Source: https://docs.githubim.com/en/api/channel/get-whitelist
Example of how to fetch the channel whitelist using cURL. This command-line tool is useful for testing API endpoints directly from the terminal. It sends a GET request to the specified URL with the required query parameters.
```bash
curl -X GET "http://localhost:5001/channel/whitelist?channel_id=group123&channel_type=2"
```
--------------------------------
### Starting WuKongIM Cluster Nodes
Source: https://docs.githubim.com/en/server/configuration/cluster
Command-line instructions to initiate each WuKongIM cluster node using its respective configuration file. This process involves running the `wukongim` executable with the `--config` flag pointing to the node's YAML configuration.
```bash
# Start on node 1
./wukongim --config wk-node1.yaml
# Start on node 2
./wukongim --config wk-node2.yaml
# Start on node 3
./wukongim --config wk-node3.yaml
```
--------------------------------
### Get IM Address using cURL
Source: https://docs.githubim.com/en/api/route/get-address
Example of how to retrieve the IM connection address using cURL. This command fetches the external network address by default.
```bash
curl -X GET "http://localhost:5001/route?intranet=0"
```
--------------------------------
### Start WuKongIM Service
Source: https://docs.githubim.com/en/installation/linux/scaling
This command starts the WuKongIM service in detached mode using the specified configuration file. The `-d` flag ensures the process runs in the background.
```bash
./wukongim --config wk.yaml -d
```
--------------------------------
### Get Channel Whitelist using Python Requests
Source: https://docs.githubim.com/en/api/channel/get-whitelist
Provides a Python example for retrieving the channel whitelist using the `requests` library. This library simplifies making HTTP requests in Python. The code sets up parameters and sends a GET request, then parses the JSON response.
```python
import requests
params = {
'channel_id': 'group123',
'channel_type': 2
}
response = requests.get('http://localhost:5001/channel/whitelist', params=params)
data = response.json()
print(data)
```
--------------------------------
### EasySDK Initialization Across Platforms
Source: https://docs.githubim.com/en/getting-started/concepts/device
Code examples for initializing the EasySDK for WuKongIM across different platforms: Web (JavaScript), iOS (Swift), Android (Kotlin), and Flutter (Dart). These examples demonstrate setting up the SDK with server details, user credentials, and optionally a custom device ID, with automatic device type detection.
```javascript
import { WKIM } from 'easyjssdk';
// Device type is automatically set to Web (1) during initialization
const im = WKIM.init("ws://your-server.com:5200", {
uid: "user123",
token: "your_token",
deviceId: "web_device_001" // Optional: custom device ID
});
// EasySDK automatically handles device type, Web platform defaults to device type 1
console.log('Current platform: Web');
console.log('Device type: 1 (Web)');
```
```swift
import WuKongEasySDK
// Device type is automatically set to APP (0) during initialization
let config = WuKongConfig(
serverUrl: "ws://your-server.com:5200",
uid: "user123",
token: "your_token",
deviceId: "ios_device_001" // Optional: custom device ID
)
let easySDK = WuKongEasySDK(config: config)
// EasySDK automatically handles device type, iOS platform defaults to device type 0 (APP)
print("Current platform: APP")
print("Device type: 0 (APP)")
```
```kotlin
import com.githubim.easysdk.WuKongEasySDK
import com.githubim.easysdk.WuKongConfig
// Device type is automatically set to APP (0) during initialization
val config = WuKongConfig.Builder()
.serverUrl("ws://your-server.com:5200")
.uid("user123")
.token("your_token")
.deviceId("android_device_001") // Optional: custom device ID
.build()
val easySDK = WuKongEasySDK.getInstance()
easySDK.init(this, config)
// EasySDK automatically handles device type, Android platform defaults to device type 0
Log.d("WuKong", "Current platform: APP")
Log.d("WuKong", "Device type: 0 (APP)")
```
```dart
import 'package:wukong_easy_sdk/wukong_easy_sdk.dart';
// Device type is automatically set during initialization
final config = WuKongConfig(
serverUrl: "ws://your-server.com:5200",
uid: "user123",
token: "your_token",
deviceId: "flutter_device_001", // Optional: custom device ID
);
final easySDK = WuKongEasySDK.getInstance();
await easySDK.init(config);
// EasySDK automatically handles device type
print('Current platform: Flutter');
print('Device type: Auto-detected');
```
--------------------------------
### Get Connection Info with JavaScript
Source: https://docs.githubim.com/en/api/monitoring/connections
This example shows how to retrieve server connection statistics using JavaScript's fetch API. It makes a GET request to the /connz endpoint with specified query parameters and parses the JSON response. Ensure the environment supports async/await.
```javascript
const response = await fetch('http://localhost:5001/connz?offset=0&limit=50&subs=1');
const data = await response.json();
console.log(data);
```
--------------------------------
### Install Grafana
Source: https://docs.githubim.com/en/installation/linux/monitoring
These bash commands outline the process for installing Grafana on a Debian-based system (like Ubuntu). It involves adding the Grafana package repository, importing the GPG key for verification, updating the package list, and finally installing the Grafana package itself.
```bash
# Add Grafana repository
sudo apt-get install -y software-properties-common
sudo add-apt-repository "deb https://packages.grafana.com/oss/deb stable main"
wget -q -O - https://packages.grafana.com/gpg.key | sudo apt-key add -
# Install Grafana
sudo apt-get update
sudo apt-get install grafana
```
--------------------------------
### Initialize WuKongIM Web EasySDK with Server and Auth Details
Source: https://docs.githubim.com/en/sdk/easy/javascript/getting-started
Initializes the WuKongIM SDK by providing the server WebSocket address and authentication credentials (user ID and token). Optional parameters like device ID and device flag can also be configured.
```javascript
// 1. Initialize SDK
const im = WKIM.init("ws://your-wukongim-server.com:5200", {
uid: "your_user_id", // Your user ID
token: "your_auth_token" // Your authentication token
// deviceId: "optional_device_id", // Optional: Device ID
// deviceFlag: 2 // Optional: Device flag (1:APP, 2:WEB, default is 2)
});
```
--------------------------------
### Initialize WuKongIM iOS SDK (With Options)
Source: https://docs.githubim.com/en/sdk/wukongim/ios/integration
Configure and initialize the WuKongIM SDK with custom options such as connection address, API URL, and upload URL.
```swift
// Swift
let options = WKOptions()
options.connectAddr = "ws://your-server.com:5200"
options.apiURL = "http://your-api-server.com"
options.uploadURL = "http://your-upload-server.com"
WKSDK.shared.setup(options: options)
```
```objc
// Objective-C
WKOptions *options = [[WKOptions alloc] init];
options.connectAddr = @"ws://your-server.com:5200";
options.apiURL = @"http://your-api-server.com";
options.uploadURL = @"http://your-upload-server.com";
[WKSDK.shared setupWithOptions:options];
```
--------------------------------
### Logging in WuKongIM Plugin SDK
Source: https://docs.githubim.com/en/getting-started/learning/plugin-development
Demonstrates how to use the `pdk.Log` object for logging messages at different levels (Info, Warn, Error) within a WuKongIM plugin. It shows how to include key-value pairs for structured logging.
```go
pdk.Log.Info("Info message", pdk.String("key", "value"))
pdk.Log.Warn("Warning message", pdk.Int("count", 10))
pdk.Log.Error("Error message", pdk.Any("data", obj))
```
--------------------------------
### Connect to Server using WKIM SDK (JavaScript)
Source: https://docs.githubim.com/en/sdk/easy/javascript/getting-started
This snippet shows the asynchronous process of connecting to the server using the 'connect' method provided by the WKIM SDK. It includes basic error handling using a try-catch block to log success or failure messages to the console. This is a fundamental step after initializing the SDK.
```javascript
// 4. Connect to server
try {
await im.connect();
console.log("Connection successful!");
} catch (error) {
console.error("Connection failed:", error);
}
```
--------------------------------
### Get Channel Max Message Sequence - Bash cURL
Source: https://docs.githubim.com/en/api/message/max-message-seq
Example of fetching the maximum message sequence for a channel using cURL. It requires channel ID and channel type as query parameters.
```bash
curl -X GET "http://localhost:5001/channel/max_message_seq?channel_id=group123&channel_type=2"
```
--------------------------------
### Install TypeScript Definitions for WuKongIM SDK
Source: https://docs.githubim.com/en/sdk/wukongim/javascript/integration
If using TypeScript, install the corresponding type definitions package to enable type checking and autocompletion for the SDK. This improves developer experience and code safety.
```bash
npm install --save-dev @types/wukongimjssdk
```
--------------------------------
### Initialize and Connect WuKongIM in HarmonyOS App
Source: https://docs.githubim.com/en/sdk/wukongim/harmonyos/integration
This TypeScript code demonstrates the initialization of the WuKongIM SDK, including setting up user options, configuring the server address, and establishing a connection. It also includes listeners for connection status and new messages.
```typescript
import { WKIM, WKOptions, WKConnectStatus, WKMsg } from '@wukong/wkim';
@Entry
@Component
struct WuKongIMApp {
@State private isInitialized: boolean = false;
@State private connectionStatus: string = 'Initializing...';
@State private messages: WKMsg[] = [];
aboutToAppear(): void {
this.initializeApp();
}
aboutToDisappear(): void {
this.cleanup();
}
private async initializeApp(): Promise