Ye Plugins

http://你的IP地址:10010

ws://你的IP地址:10010/im

location /im {
    proxy_pass http://本地IP:10010;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
}

proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";

server
{
    listen 80;
	listen 443 ssl http2;
    server_name 你的域名;
    index index.html index.htm default.htm default.html;
    root /www/wwwroot/yeimServer-1;

    #SSL-START SSL相关配置
    #error_page 404/404.html;
    ssl_certificate    /www/server/panel/vhost/cert/yeimServer-1/fullchain.pem;
    ssl_certificate_key    /www/server/panel/vhost/cert/yeimServer-1/privkey.pem;
    ssl_protocols TLSv1.1 TLSv1.2 TLSv1.3;
    ssl_ciphers EECDH+CHACHA20:EECDH+CHACHA20-draft:EECDH+AES128:RSA+AES128:EECDH+AES256:RSA+AES256:EECDH+3DES:RSA+3DES:!MD5;
    ssl_prefer_server_ciphers on;
    ssl_session_cache shared:SSL:10m;
    ssl_session_timeout 10m;
    add_header Strict-Transport-Security "max-age=31536000";
    error_page 497  https://$host$request_uri;
		#SSL-END

    #ERROR-PAGE-START  错误页相关配置
    #error_page 404 /404.html;
    #error_page 502 /502.html;
    #ERROR-PAGE-END


    #REWRITE-START 伪静态相关配置
    include /www/server/panel/vhost/rewrite/java_yeimServer-1.conf;
    #REWRITE-END

    #禁止访问的文件或目录
    location ~ ^/(\.user.ini|\.htaccess|\.git|\.svn|\.project|LICENSE|README.md|package.json|package-lock.json|\.env) {
        return 404;
    }

    #一键申请SSL证书验证目录相关设置
    location /.well-known/ {
        root /www/wwwroot/java_node_ssl;
    }

    #禁止在证书验证目录放入敏感文件
    if ( $uri ~ "^/\.well-known/.*\.(php|jsp|py|js|css|lua|ts|go|zip|tar\.gz|rar|7z|sql|bak)$" ) {
        return 403;
    }


    # HTTP反向代理相关配置开始 >>>
    location ~ /purge(/.*) {
        proxy_cache_purge cache_one $Host$request_uri$is_args$args;
    }

    location / {
        proxy_pass http://127.0.0.1:10010;
        proxy_set_header Host $Host:$server_port;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header REMOTE-HOST $remote_addr;
        add_header X-Cache $upstream_cache_status;
        proxy_set_header X-Host $host:$server_port;
        proxy_set_header X-Scheme $scheme;
        proxy_connect_timeout 30s;
        proxy_read_timeout 86400s;
        proxy_send_timeout 30s;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }
    
    # HTTP反向代理相关配置结束 <<<

    access_log  /www/wwwlogs/yeimServer-1.log;
    error_log  /www/wwwlogs/yeimServer-1.error.log;
}

http://你的server地址:你的server端口/user/register

Content-Type：application/json

POST /user/register HTTP/1.1
Host: 你的server地址:你的server端口/user/register
Date: GMT Date
Content-Type: application/json
Content-Length: Content Length

{
    "userId":"user_123456789",
    "nickname":"小明",
    "avatarUrl":"https://api.multiavatar.com/Starcrasher.png"
}

{
    "code": 200,
    "message": "success",
    "data": null
}

http://你的server地址:你的server端口/user/token/get

Content-Type： application/json

POST /user/token/get HTTP/1.1
Host: 你的server地址:你的server端口/user/token/get
Date: GMT Date
Content-Type: application/json
Content-Length: Content Length

{
    "userId":"user_123456789",
    "timestamp":1671429749000,
    "sign":"14b978ad88894af7b9c5071d55b5e0cb"
}

{
    "code": 200,
    "message": "success",
    "data": {
        "token": "3896c6e9eb4e5f18601a83fc624455e5"
    }
}

http://你的server地址:你的server端口/user/update

Content-Type： application/json
Token：3896c6e9eb4e5f18601a83fc624455e5

POST /user/update HTTP/1.1
Host: 你的server地址:你的server端口/user/update
Date: GMT Date
Token：3896c6e9eb4e5f18601a83fc624455e5
Content-Type: application/json
Content-Length: Content Length

{
    "nickname":"小红",
    "avatarUrl":"https://api.multiavatar.com/Starcrasher.png"
}

{
    "code": 200,
    "message": "success",
    "data": null
}

# 首次安装
npm i yeim-uni-sdk

# 更新
npm update yeim-uni-sdk

// npm方式导入SDK
import {
	YeIMUniSDK, // SDK
	YeIMUniSDKDefines // 预定义常量
} from 'yeim-uni-sdk'

//uni_modules方式导入SDK
import {
    YeIMUniSDK, // SDK
    YeIMUniSDKDefines // 预定义常量
} from './uni_modules/wzJun1-YeIM-Uni-SDK/js_sdk/yeim-uni-sdk.min.js'

// main.js

// npm方式导入SDK
// import {
// 	YeIMUniSDK, // SDK
// 	YeIMUniSDKDefines // 预定义常量
// } from 'yeim-uni-sdk'

//uni_modules方式导入SDK
import {
    YeIMUniSDK,  // SDK
    YeIMUniSDKDefines // 预定义常量
} from './uni_modules/wzJun1-YeIM-Uni-SDK/js_sdk/yeim-uni-sdk.min.js'

YeIMUniSDK.init({
    baseURL: 'http://192.168.110.101:10010', // YeIMServer http url （如无特殊需求，服务端启动后仅需修改ip或者域名即可）
    socketURL: 'ws://192.168.110.101:10010/im', // YeIMServer socket url（如无特殊需求，服务端启动后仅需修改ip或者域名即可）
    logLevel: 0, // SDK日志等级，0 = 打印全部日志， 1 = 打印重要日志，2 = 不打印日志
    reConnectInterval: 3000, // 断线重连时间间隔（遇到网络波动，IM服务端可能会断线，此时需要重新连接到服务端），单位：毫秒
    reConnectTotal: 0, // 最大重连次数，0不限制一直重连 
    heartInterval: 30000, //心跳时间间隔（默认30秒），单位：毫秒
    notification: {
        autoPermission: true //IM登录后是否自动检测通知权限
    }
});

// main.js

// npm方式导入SDK
// import {
// 	YeIMUniSDK, // SDK
// 	YeIMUniSDKDefines // 预定义常量
// } from 'yeim-uni-sdk'

//uni_modules方式导入SDK
import {
    YeIMUniSDK,  // SDK
    YeIMUniSDKDefines // 预定义常量
} from './uni_modules/wzJun1-YeIM-Uni-SDK/js_sdk/yeim-uni-sdk.min.js'

let YeIM = YeIMUniSDK.getInstance();

// main.js

// npm方式导入SDK
// import {
// 	YeIMUniSDK, // SDK
// 	YeIMUniSDKDefines // 预定义常量
// } from 'yeim-uni-sdk'

//uni_modules方式导入SDK
import {
    YeIMUniSDK,  // SDK
    YeIMUniSDKDefines // 预定义常量
} from './uni_modules/wzJun1-YeIM-Uni-SDK/js_sdk/yeim-uni-sdk.min.js'
  
//举例：
let conversationType = YeIMUniSDKDefines.CONVERSATION_TYPE.PRIVATE; //私聊会话类型

YeIMUniSDKDefines.CONVERSATION_TYPE.PRIVATE

YeIMUniSDKDefines.CONVERSATION_TYPE.GROUP

YeIMUniSDKDefines.MESSAGE_TYPE.TEXT

YeIMUniSDKDefines.MESSAGE_TYPE.IMAGE

YeIMUniSDKDefines.MESSAGE_TYPE.AUDIO

YeIMUniSDKDefines.MESSAGE_TYPE.VIDEO

YeIMUniSDKDefines.MESSAGE_TYPE.LOCATION

YeIMUniSDKDefines.MESSAGE_TYPE.CUSTOM

YeIMUniSDKDefines.MESSAGE_TYPE.GROUP_SYS_NOTICE

YeIMUniSDKDefines.MESSAGE_TYPE.TEXT

YeIMUniSDKDefines.MESSAGE_TYPE.SYS_NOTICE

YeIMUniSDKDefines.GROUP.JOINMODE.FREE

YeIMUniSDKDefines.GROUP.JOINMODE.CHECK

YeIMUniSDKDefines.GROUP.JOINMODE.FORBIDDEN

YeIMUniSDKDefines.GROUP.JOINMODE.PENDING

YeIMUniSDKDefines.GROUP.JOINMODE.AGREE

YeIMUniSDKDefines.GROUP.JOINMODE.REFUSE

YeIMUniSDKDefines.USER.ADDFRIEND.ALLOW

YeIMUniSDKDefines.USER.ADDFRIEND.CONFIRM

YeIMUniSDKDefines.USER.ADDFRIEND.DENY

// npm方式导入SDK
// import {
// 	YeIMUniSDK, // SDK
// 	YeIMUniSDKDefines // 预定义常量
// } from 'yeim-uni-sdk'

//uni_modules方式导入SDK
import {
    YeIMUniSDK,  // SDK
    YeIMUniSDKDefines // 预定义常量
} from '@/uni_modules/wzJun1-YeIM-Uni-SDK/js_sdk/yeim-uni-sdk.min.js'
 
//设置监听，建议使用具名函数

//监听会话列表更新
YeIMUniSDK.getInstance().addEventListener(YeIMUniSDKDefines.EVENT.CONVERSATION_LIST_CHANGED, (list) => {
    console.log("监听会话列表更新:")
    console.log(list) 
});

//监听新消息接收
YeIMUniSDK.getInstance().addEventListener(YeIMUniSDKDefines.EVENT.MESSAGE_RECEIVED, (list) => {
    console.log("收到新消息:")
    console.log(list) 
});

//监听私聊会话已读回执，对端调用 clearConversationUnread 接口时触发
YeIMUniSDK.getInstance().addEventListener(YeIMUniSDKDefines.EVENT.PRIVATE_READ_RECEIPT, (res) => {
    console.log("收到私聊会话已读回执:")
    console.log(res) 
});

//监听消息撤回事件
YeIMUniSDK.getInstance().addEventListener(YeIMUniSDKDefines.EVENT.MESSAGE_REVOKED, (res) => {
    console.log("收到消息撤回事件:")
    console.log(res) 
});

//好友列表变化
YeIMUniSDK.getInstance().addEventListener(YeIMUniSDKDefines.EVENT.FRIEND_LIST_CHANGED, (res) => {
    console.log("收到好友列表变化事件:")
    console.log(res) 
});

//好友申请列表变化
YeIMUniSDK.getInstance().addEventListener(YeIMUniSDKDefines.EVENT.FRIEND_APPLY_LIST_CHANGED, (res) => {
    console.log("收到好友申请列表变化事件:")
    console.log(res) 
});

//好友申请被拒
YeIMUniSDK.getInstance().addEventListener(YeIMUniSDKDefines.EVENT.FRIEND_APPLY_REFUSE, (res) => {
    console.log("收到好友申请被拒事件:")
    console.log(res) 
});

//监听SDK网络连接状态
YeIMUniSDK.getInstance().addEventListener(YeIMUniSDKDefines.EVENT.NET_CHANGED, (res) => {
    console.log("网络状态变化:" + res)
});

//监听登陆互踢，当同一用户重复登录时触发
YeIMUniSDK.getInstance().addEventListener(YeIMUniSDKDefines.EVENT.KICKED_OUT, () => {
    console.log("用户被踢下线")
});

//添加一个网络状态变化的监听器
YeIMUniSDK.getInstance().addEventListener(YeIMUniSDKDefines.EVENT.NET_CHANGED, this.netChanged);
//移除了这个网络状态变化的监听器
YeIMUniSDK.getInstance().removeEventListener(YeIMUniSDKDefines.EVENT.NET_CHANGED, this.netChanged);

var netChanged = function(res){
    console.log("网络状态变化:" + res);
}

// npm方式导入SDK
// import {
// 	YeIMUniSDK, // SDK
// 	YeIMUniSDKDefines // 预定义常量
// } from 'yeim-uni-sdk'

//uni_modules方式导入SDK
import {
    YeIMUniSDK,  // SDK
    YeIMUniSDKDefines // 预定义常量
} from '@/uni_modules/wzJun1-YeIM-Uni-SDK/js_sdk/yeim-uni-sdk.min.js'
  
YeIMUniSDK.getInstance().connect({
    userId: "已注册的用户ID字符串",
    token: "上述说明中通过http接口换取到的登陆token",
    success: (response) => {
        if (response.code === 200) {
            uni.showToast({
                title: "登录成功"
            })
            //TODO 根据项目实际情况 用户信息存到状态、缓存
        } else {
            uni.showToast({
                icon: "error",
                title: "登录失败：" + response.code
            })
        }
    },
    fail: (err) => {
        console.log(err);
    }
});

YeIMUniSDK.getInstance().disConnect();

let code = YeIMUniSDK.getInstance().readyState();

YeIMUniSDK.getInstance().updateUserInfo({
    nickname: "修改后的用户昵称",
    avatarUrl: "修改后的用户头像网络地址",
    success: (response) => {
        console.log(response);
    },
    fail: (err) => {
        console.log(err);
    }
});

YeIMUniSDK.getInstance().getUserInfo({
    userId: e.value,
    success: (res) => {
        console.log(res) 
    },
    fail: (err) => {
        console.log(err) 
    }
});

YeIMUniSDK.getInstance().getBlackUserList({ 
    success: (res) => {
        console.log(res) 
    },
    fail: (err) => {
        console.log(err) 
    }
});

YeIMUniSDK.getInstance().addToBlackUserList({ 
    members: ["user1", "user2"],
    success: (res) => {
        console.log(res)
    },
    fail: (err) => {
        console.log(err)
    }
});

YeIMUniSDK.getInstance().removeFromBlacklist({ 
    members: ["user1", "user2"],
    success: (res) => {
        console.log(res)
    },
    fail: (err) => {
        console.log(err)
    }
});

//创建文字消息
let message = YeIMUniSDK.getInstance().createTextMessage({
    toId: '接收者用户ID', //接收者用户ID字符串
    conversationType: YeIMUniSDKDefines.CONVERSATION_TYPE.PRIVATE, //会话类型：私聊
    body: {
        text: "你好" //文本消息内容字符串
    },
    extra: "这是拓展的自定义的内容"
}); 

//发送消息
YeIMUniSDK.getInstance().sendMessage({
    message: message,
    success: (res) => {
        console.log(res)
    },
    fail: (err) => {
        console.log(err)
    }
});

//创建群聊文字@消息
let message = YeIMUniSDK.getInstance().createTextAtMessage({
    toId: '群ID',
    conversationType: YeIMUniSDKDefines.CONVERSATION_TYPE
        .GROUP, //会话类型：群聊
    body: {
        text: "@user1 @user2 各位，下班开会",
        atUserIdList: ["user1", "user2"]
    },
    extra: "这是拓展的自定义的内容"
});

//发送消息
YeIMUniSDK.getInstance().sendMessage({
    message: message,
    success: (res) => {
        console.log(res)
    },
    fail: (err) => {
        console.log(err)
    }
});

uni.chooseImage({
    count: 1, 
    sizeType: ['original', 'compressed'], 
    sourceType: ['album'],
    success: async (res) => {

        //获取图片信息
        let imageInfo = await uni.getImageInfo({
            src: res.tempFilePaths[0]
        })

        //创建图片消息
        let message = YeIMUniSDK.getInstance().createImageMessage({
            toId: '接收者用户ID', //接收者用户ID字符串
            conversationType: YeIMUniSDKDefines.CONVERSATION_TYPE.PRIVATE, //会话类型：私聊
            body: {
                file: {
                    tempFilePath: res.tempFilePaths[0], //本地图片临时路径
                    width: imageInfo[1].width, //图片宽度
                    height: imageInfo[1].height //图片高度
                }
            },
            extra: "这是拓展的自定义的内容",
            onProgress: (progress) => {
                console.log('上传进度' + progress.progress);
                console.log('已经上传的数据长度' + progress.totalBytesSent);
                console.log('预期需要上传的数据总长度' + progress.totalBytesExpectedToSend);
            }
        });

        //发送消息
        YeIMUniSDK.getInstance().sendMessage({
            message: message,
            success: (res) => {
                console.log(res);
            },
            fail: (err) => {
                console.log(err)
            }
        });
    }
});

//创建图片直发消息
let message = YeIMUniSDK.getInstance().createImageMessageFromUrl({
    toId: '接收者用户ID', //接收者用户ID字符串
    conversationType: YeIMUniSDKDefines.CONVERSATION_TYPE.PRIVATE, //会话类型：私聊
    body: {
        originalUrl: "http://xxx.com/xxx.jpg", //原图网络Url
        originalWidth: 500, //原图宽度
        originalHeight: 500, //原图高度
        thumbnailUrl: "http://xxx.com/xxx.jpg", //缩略图网络Url
        thumbnailWidth: 200, //缩略图宽度
        thumbnailHeight: 200, //缩略图高度
    },
    extra: "这是拓展的自定义的内容"
});

//发送消息
YeIMUniSDK.getInstance().sendMessage({
    message: message,
    success: (res) => {
        console.log(res);
    },
    fail: (err) => {
        console.log(err)
    }
});

//创建语音消息
let message = YeIMUniSDK.getInstance().createAudioMessage({
    toId: '接收者用户ID', //接收者用户ID字符串
    conversationType: YeIMUniSDKDefines.CONVERSATION_TYPE.PRIVATE, //会话类型：私聊
    body: {
        file: {
            tempFilePath: '', //本地录音临时文件，仅支持AAC
            duration: 0, // 录音时长，单位：秒
        }
    },
    extra: "这是拓展的自定义的内容",
    onProgress: (progress) => {
        console.log('上传进度' + progress.progress);
        console.log('已经上传的数据长度' + progress.totalBytesSent);
        console.log('预期需要上传的数据总长度' + progress.totalBytesExpectedToSend);
    }
});

//发送消息
YeIMUniSDK.getInstance().sendMessage({
    message: message,
    success: (res) => {
        console.log(res);
    },
    fail: (err) => {
        console.log(err)
    }
});

//创建语音直发消息
let message = YeIMUniSDK.getInstance().createAudioMessageFromUrl({
    toId: '接收者用户ID', //接收者用户ID字符串
    conversationType: YeIMUniSDKDefines.CONVERSATION_TYPE.PRIVATE, //会话类型：私聊
    body: {
        audioUrl: "http://xxx.com/xxx.aac", //音频网络Url
        duration: 5, //音频时长，单位：秒 
    },
    extra: "这是拓展的自定义的内容"
});

//发送消息
YeIMUniSDK.getInstance().sendMessage({
    message: message,
    success: (res) => {
        console.log(res);
    },
    fail: (err) => {
        console.log(err)
    }
});

//创建小视频消息
let message = YeIMUniSDK.getInstance().createVideoMessage({
    toId: '接收者用户ID', //接收者用户ID字符串
    conversationType: YeIMUniSDKDefines.CONVERSATION_TYPE.PRIVATE, //会话类型：私聊
    body: {
        file: {
            tempFilePath: '', //本地小视频文件临时路径
            width: 0, //视频宽度
            height: 0, //视频高度
            duration: 1 // 视频时长，单位：秒
        }
    },
    extra: "这是拓展的自定义的内容",
    //文件上传进度
    onProgress: (progress) => { 
        console.log('上传进度' + progress.progress);
        console.log('已经上传的数据长度' + progress.totalBytesSent);
        console.log('预期需要上传的数据总长度' + progress.totalBytesExpectedToSend);
    }
});

//发送消息
YeIMUniSDK.getInstance().sendMessage({
    message: message,
    success: (res) => {
        console.log(res);
    },
    fail: (err) => {
        console.log(err)
    }
});

//创建小视频直发消息
let message = YeIMUniSDK.getInstance().createVideoMessageFromUrl({
    toId: '接收者用户ID', //接收者用户ID字符串
    conversationType: YeIMUniSDKDefines.CONVERSATION_TYPE.PRIVATE, //会话类型：私聊
    body: {
        videoUrl: "http://xxx.com/xxx.aac", //小视频网络Url
        thumbnailUrl: "http://xxx.com/xxx.aac", //小视频缩略图网络Url
        duration: 5, //视频时长，单位：秒 
        width: 5, //视频宽度
        height: 5, //视频高度
    },
    extra: "这是拓展的自定义的内容"
});

//发送消息
YeIMUniSDK.getInstance().sendMessage({
    message: message,
    success: (res) => {
        console.log(res);
    },
    fail: (err) => {
        console.log(err)
    }
});

//创建位置消息
let message = YeIMUniSDK.getInstance().createLocationMessage({
    toId: '接收者用户ID', //接收者用户ID字符串
    conversationType: YeIMUniSDKDefines.CONVERSATION_TYPE.PRIVATE, //会话类型：私聊
    body: {
        address: '', //地址名称
        description: '', //地址详细描述
        longitude: 0.00000, //经度
        latitude: 0.00000 //纬度
    },
    extra: "这是拓展的自定义的内容",
});

//发送消息
YeIMUniSDK.getInstance().sendMessage({
    message: message,
    success: (res) => {
        console.log(res);
    },
    fail: (err) => {
        console.log(err)
    }
});

//创建自定义消息
let message = YeIMUniSDK.getInstance().createCustomMessage({
    toId: '接收者用户ID', //接收者用户ID字符串
    conversationType: YeIMUniSDKDefines.CONVERSATION_TYPE.PRIVATE, //会话类型：私聊
    body: { //消息容器
    		custom: "这是自定义消息体" //自定义消息内容，可传入String或JSON Object
    },  
    extra: "这是拓展的自定义的内容",
});

//发送消息
YeIMUniSDK.getInstance().sendMessage({
    message: message,
    success: (res) => {
        console.log(res);
    },
    fail: (err) => {
        console.log(err)
    }
});

//创建合并消息
let message = YeIMUniSDK.getInstance().createMergerMessage({
    toId: '接收者用户ID',
    conversationType: YeIMUniSDKDefines.CONVERSATION_TYPE
        .PRIVATE, //会话类型：私聊
    body: {
        title: "与老婆的聊天记录",
        messageList:[message1, message2],
        summaryList: ["我：[图片]", "老婆：你早饭吃了吗？"]
    },
    extra: "这是拓展的自定义的内容"
});

//发送消息
YeIMUniSDK.getInstance().sendMessage({
    message: message,
    success: (res) => {
        console.log(res)
    },
    fail: (err) => {
        console.log(err)
    }
});

//创建合并消息
let message = YeIMUniSDK.getInstance().createForwardMessage({
    toId: '接收者用户ID',
    conversationType: YeIMUniSDKDefines.CONVERSATION_TYPE
        .PRIVATE, //会话类型：私聊
    body: {
        message: message,
    },
    extra: "这是拓展的自定义的内容"
});

//发送消息
YeIMUniSDK.getInstance().sendMessage({
    message: message,
    success: (res) => {
        console.log(res)
    },
    fail: (err) => {
        console.log(err)
    }
});

//发送消息
YeIMUniSDK.getInstance().sendMessage({
    message: message,
    success: (res) => {
        console.log(res);
    },
    fail: (err) => {
        console.log(err)
    }
});

let result = YeIMUniSDK.getInstance().getConversation("会话ID");
let conversation = result.data;

YeIMUniSDK.getInstance().getConversationList({
    page: 1, //页码
    limit: 20, //每页数量
    success: (res) => {
        console.log(res)  
    },
    fail: (err) => {
        console.log(err)
    }
});