goeasy-snapshot/README.md

www.goeasy.io

# GoEasy.io
### 几行代码，快速打造您的web实时通讯体系，GoEasy API，让[websocket](https://www.goeasy.io)更简单。  

### 支持APP, 各种小程序，H5和服务端推送，访问[GoEasy官网](https://www.goeasy.io)，体验更多炫酷demo，查看更多技术文档。

### 完美支持所有需要实时通信的场景：    
聊天，IM，直播弹幕，用户上下线提醒, 在线用户列表  
扫码登录， 扫码支付， 扫码签到， 扫码打印  
事件提醒，工单，订单实时提醒  
在线拍卖， 在线点餐，在线选座 
实时数据展示，实时监控大屏， 金融实时行情显示，设备监控系统  
实时位置跟踪，外卖实时跟踪，物流实时跟踪    
远程画板，远程医疗，游戏，远程在线授课 

# 优势：
1. 傻瓜式集成    
2. 消息必达，断网自动重连，消息补发 
3. 高速稳定 
4. 安全可靠 

# 使用方法
####1. 获取您的appkey   
先注册一个账号，登录后，创建一个应用，就能得到您的appkey。[点击注册](https://www.goeasy.io/cn/signup.html)
####2. 客户端与GoEasy建立连接   
如果您的客户端需要发送消息，请使用common key。如果您的客户端只需要接收消息，不需要发送消息，使用subscriber key即可。
```js
    //创建GoEasy对象
    var goEasy = new GoEasy({
      host: "hangzhou.goeasy.io",//应用所在的区域地址，杭州：hangzhou.goeasy.io，新加坡：singapore.goeasy.io
      appkey: "my_appkey",//替换为您的应用appkey
      onConnected: function() {
        console.log('连接成功！')
      },
      onDisconnected: function() {
        console.log('连接断开！')
      },
      onConnectFailed: function(error) {
        console.log('连接失败或错误！')
      }
    });
```
####3. 订阅消息（接收） 
在下一步发送消息之前，您需要先完成订阅操作来准备接收消息，channel可以是英文和数字组成的任意字符串，但不能包含空格。
```js
    goEasy.subscribe({
        channel: "my_channel",//替换为您自己的channel
        onMessage: function (message) {
            alert("Channel:" + message.channel + " content:" + message.content);
        }
    });

    //一次订阅多个channel，可以使用数组，注意参数名称为：channels
    goEasy.subscribe({
        channels: ["my_channel","my_channel2"],//替换为您自己的channels
        onMessage: function (message) {
            alert("Channel:" + message.channel + " content:" + message.content);
        }
    });


```
####4. 发送消息 
发送时，您的channel必须和上一步订阅的channel一致，才可以成功的接收消息。
```js
    goEasy.publish({
        channel: "my_channel", //替换为您自己的channel
        message: "Hello, GoEasy!" //替换为您想要发送的消息内容
    });
```

[更多>>](https://www.goeasy.io/cn/get-start.html)