# Gateway::joinGroup
## 说明:
~~~
void Gateway::joinGroup(string $client_id, mixed $group);
~~~
将client_id加入某个组,以便通过Gateway::sendToGroup发送数据。
可以通过Gateway::getClientSessionsByGroup($group)获得该组所有在线成员数据。
可以通过Gateway::getClientCountByGroup($group)获得该组所有在线连接数(人数)。
该方法对于分组发送数据例如房间广播非常有用。
## 注意:
1、同一个client_id可以加入多个分组,以便接收不同组发来的数据。
2、当client_id下线(连接断开)后,该client_id会自动从该分组中删除,开发者无需调用Gateway::leaveGroup。
3、如果对应分组的所有client_id都下线,则对应分组会被自动删除。
4、目前没有提供获得所有分组id接口,所有分组名称可以自行存入数据库中。
## 参数
* $client_id
客户端的client_id
* $group
只能是数字或者字符串。
注意:group不能为空值。例如0,0.0,'0',"0",false,null是非法的group值。
## 返回值
无返回值
## 范例
~~~
use \GatewayWorker\Lib\Gateway;
class Events
{
...
public static function onMessage($client_id, $message)
{
// $message = '{"type":"join","group":"xxxxx"}'
$req_data = json_decode($message, true);
Gateway::joinGroup($client_id, $req_data['group']);
}
...
}
~~~
- 快速入门
- 魔际客服系统V1.0简介
- 新手上路
- 注册并创建应用
- 通信过程及聊天记录保存
- 实时消息回调
- Lib/Geteway类提供的接口
- sendToAll
- sendToClient
- closeClient
- isOnline
- bindUid
- unbindUid
- isUidOnline
- getClientIdByUid
- getUidByClientId
- sendToUid
- joinGroup
- leaveGroup
- sendToGroup
- getClientCountByGroup
- getClientSessionsByGroup
- getAllClientCount
- getAllClientSessions
- setSession
- updateSession
- getSession
- 服务端集成
- 入门
- 用户体系集成
- 聊天记录
- 文件上传下载
- 发送消息
- 群组管理
- 聊天室管理
- 应用管理
- Web IM集成
- Web IM 介绍
- 集成方式
- Web SDK基础功能
- 消息
- 好友管理
- 群组管理
- 聊天室管理
- 微信小程序 Demo
- Web SDK API Doc
- Web IM SDK 更新日志
- React Native集成
- React Native Demo 介绍