# 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 介紹