更新记录

1.0.1（2026-07-03）

更新文档说明

1.0.0（2026-07-03）

新版发布

平台兼容性

uni-app(4.64)

uni-app x(4.87)

OpenIM UTS插件接口文档

1. UTS插件对象

<script>

    //UTS插件对象
    import * as OpenIM from "@/uni_modules/Lizii-OpenIM";

    export default {
    }

</script>

2. 订阅OpenIM事件回调

//订阅OpenIM事件回调
OpenIM.subscribe({
    onEventCallback: (type, data) => {
        console.log(type);//回调事件名称
        console.log(data);//回调参数
        if (type == "onConnectSuccess") {

        } else if (type == "onConnectFailed") {

        }//更多参考https://docs.openim.io/zh-Hans/sdks/callback/onConnectSuccess
    }
});

3. OpenIM函数调用

OpenIM.asyncApi({
    type:"initSDK",//接口名称(必须), 参考 https://docs.openim.io/zh-Hans/sdks/api/initialization/initSDK
    data:{
        apiAddr:"http://192.168.1.100:100",
        wsAddr:"ws://192.168.1.100:101"
    },//接口参数
    onSuccess: (data) => {
        console.log(data);
    },//成功回调
    onError: (code, error) => {
        console.log(code);
        console.log(error);
    },//失败回调
    onReturn: (data) => {
        console.log(data);
    }//返回值
});

//初始化
OpenIM.asyncApi({
    type:"initSDK",
    data:{
        apiAddr:"http://192.168.1.100:100",
        wsAddr:"ws://192.168.1.100:101"
    },
    onReturn: (data) => {
        console.log(data);
    }
});

//登录
OpenIM.asyncApi({
    type:"login",
    data:{
        userID:"xxxxxx",
        token:"xxxxxx"
    },
    onSuccess: (data) => {
        console.log(data);
    },
    onError: (code, error) => {
        console.log(code);
        console.log(error);
    }
});

//退出登录
OpenIM.asyncApi({
    type:"logout",
    onSuccess: (data) => {
        console.log(data);
    },
    onError: (code, error) => {
        console.log(code);
        console.log(error);
    }
});