Tenlion/wiki-files
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update wg-basic/websocket

Browse Source
This commit is contained in:
Administrator 2021-10-09 08:45:09 +00:00 committed by John Smith
parent 4670238302
commit a6806dcccd
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
wg-basic/websocket.md
View File

@ -2,7 +2,7 @@
title: 7.即时消息
description: 即时消息模块的使用
published: true
date: 2021-10-09T08:24:01.361Z
date: 2021-10-09T08:45:08.414Z
tags: wg-basic
editor: markdown
dateCreated: 2021-09-14T06:25:26.887Z
@ -113,8 +113,21 @@ websocket:
# 自定义处理消息业务
## 1. 实现接口
1. 实现 `ink.wgink.module.instantmessage.service.IWebSocketTextCustomService` 接口
2. 在 **handle** 方法中完成业务逻辑：handle方法接收两个参数，第一个参数时当前会话通道，第二个参数时消息体
3. 发送消息：调用WebSocketChannelManager.getInstance().sendText(channel, message) 方法发送消息
实现 `ink.wgink.module.instantmessage.service.IWebSocketTextCustomService` 接口
# WebSocketChannelManager
## 2.
该类不能 **new**，通过 **getInstance()** 方法得到单例对象，提供了如下功能：
| 方法 | 参数 | 说明 |
| :-: | :-: | :-: |
| listOnlineUser | userId: 用户ID | 获取在线用户客户端列表 |
| getOnlineUser | userId: 用户ID, clientName：客户端名称 | 获取在线用户 |
| listOnlineUser | userIds: 用户ID列表 | 获取在线用户客户端列表 |
| listOnlineUser | userIds: 用户ID列表, clientName: 客户端名称 | 获取在线用户客户端列表 |
| getOnlineUserBySessionId | sessionId: 会话ID | 通过会话获取用户 |
| getOnlineUserByChannelId | channelId: 通道ID | 通过通道获取用户 |
| sendText | channel: 接收人通道, webSocketClientMessage: 发送内容 | 单发文本消息 |
| sendGroupText | channels: 接收人通道列表, webSocketClientMessage: 发送内容 | 群发文本消息 |