跳到主要内容
版本:2.0.0

Sessions 会话管理

sessions 命名空间提供了管理与 EasyBot 连接的服务器会话(Session)的功能。你可以使用它来检查服务器状态、获取 Bridge 对象或断开连接。

命名空间

declare namespace sessions { ... }

方法

IsAlive

判断某服务器是否在线。

/**
* 某服务器是否在线
* @param session 服务器连接
*/
function IsAlive(session: Session): boolean;

ServerExists

通过服务器的身份令牌判断服务器是否在线。

/**
* 通过服务器的身份令牌判断服务器是否在线
* @param token 服务器的token(身份令牌)
*/
function ServerExists(token: string): boolean;

Remove

让一个已经连接到 EasyBot 的服务器断开连接 (主动踢出)。

/**
* 让一个已经连接到EasyBot的服务器断开连接(主动)
* @param session
*/
function Remove(session: Session): void;

GetBridge

获取一个服务器的桥接对象 (Bridge)。Bridge 对象用于与特定服务器进行交互。

重载 1: 通过 Session 对象获取

/**
* 获取一个服务器的桥接对象
* @param session 桥接对象
*/
function GetBridge(session: Session): Bridge;

重载 2: 通过 Token 获取

/**
* 获取一个服务器的桥接对象(通过服务器身份令牌)
* @param token 服务器的token
*/
function GetBridge(token: string): Bridge;

GetSessions

获取所有已连接的服务器 Session。

/**
* 获取所有已连接的服务器
*/
function GetSessions(): ArrayLike<Session>;

GetBridges

获取所有已连接的服务器的 Bridge 对象。

/**
* 获取所有已连接的服务器的桥接对象
*/
function GetBridges(): ArrayLike<Bridge>;

示例

遍历所有在线服务器并发送消息

const bridges = sessions.GetBridges();
for (let i = 0; i < bridges.length; i++) {
const bridge = bridges[i];
// 假设 Bridge 有一个用于发送广播的方法 (具体取决于 Bridge 的定义)
// bridge.SendBroadcast("Hello from plugin!");
}

检查特定服务器是否在线

const token = "some-server-token";
if (sessions.ServerExists(token)) {
const bridge = sessions.GetBridge(token);
// 操作 bridge...
}

遇到麻烦了?

我们提供有偿代安装服务,解决您的环境配置烦恼。

了解详情