ichat-web sdk 使用说明

起步（方式一）

npm install ichat-web

导入

//导入核心依赖
import ichatSdk from 'ichat-web'
//导入动画样式
import 'ichat-web/main.css'

起步(方式二)

// 直接通过cdn链接引入 使用方式同下
<script src="https://yywdd.oss-cn-chengdu.aliyuncs.com/ichat-web.js"></script>
// 引入动画样式
<link
    rel="stylesheet"
    href="https://cdnjs.cloudflare.com/ajax/libs/animate.css/4.1.1/animate.min.css"
/>

使用

const ichat = new ichatSdk() //请注意内部使用单例模式创建 
// 实例化时可传入 指定域名进行链接（用于私有化部署）

初始化

// 请注意，所以功能必须在初始化之后才能使用
ichat.initSdk({
    agentId:'xxxxxxxx',
    uuid:'testUuid123',
})

初始化完整参数说明

let option = {
        agentId:'xxxxxxxx',//代理Id sdkId 必传参数 否则无法使用
        uuid:'testUuid123',//客户Id （不传入则使用匿名链条，聊天记录不被保存）建议必传
        name:'testUser',//其它链接参数参数
        otherPara:'123',//其它链接参数参数
        showPopText:true,//是否开启招呼提示
        text:'你好请问有什么可以帮到你？',//提示语
        autoShow:true,//是否自动显示提示
        showTime:3000,//提示显示时间 默认为5000
        tervalTime:5000,//提示间隔时间 默认为10000
        textStyle:'color:red',//气泡文字样式 或直接使用ichat_pop_content类名进行修改 同理也可使用 ichat_pop 类名直接修改气泡本身样式注意覆盖即可
        lang:'zh',//备选en 支持中午和英文切换 默认为英文
        logoUrl:'https://example.com/xxx-oss.jpg'//自定义logo图片 
}

气泡示意图

监听器

// 内置了消息监听器 当时到消息时将通过监听器执行回调 可用于消息处理
// 为防止时间重复触发 请在监听时传入具名函数作为回调 避免重读监听
ichat.$on('onMessage',chatData=>{
  console.log(chatData,'收到了消息')
})

撤销监听

// 为防止时间重复触发 请在监听时传入具名函数作为回调 避免重读监听
// 方式一 单独撤销
ichat.$ff('onMessage',callBack)
//方式二 批量撤销
ichat.$off(['onMessage'])

消息发送

// @params strin|number 目前仅支持 文字信息发送
ichat.sendMessage('this is a test Message!!')

语言切换

// @params String en/zh
ichat.changeLang('en')

主动控制弹窗显隐

// 显示弹窗
ichat.showChatModel()
//关闭隐藏弹窗
ichat.hideChatModel()
//另外提供函数控制 显示隐藏 作用和用户直接点击icon相同
ichat.changeShow()