cyan.bot module

class cyan.bot.Bot(api_base_url: str, ticket: cyan.bot.Ticket)

基类：object

机器人。

async aclose() → None

异步关闭当前机器人。

async delete(path: str, params: Optional[Dict[str, Any]] = None, content: Optional[Any] = None) → httpx.Response

异步向服务器请求 DELETE 操作。

参数：

• path: 请求路径（不包含 API 地址）

• params: 请求参数

• content: 请求内容（将序列化为 JSON）

返回：

以 Response 类型表示的服务器响应。

property event_source: EventSource

事件源。

async get(path: str, params: Optional[Dict[str, Any]] = None) → httpx.Response

异步向服务器请求 GET 操作。

参数：

• path: 请求路径（不包含 API 地址）

• params: 请求参数

返回：

以 Response 类型表示的服务器响应。

async get_channel(identifier: str) → Channel

异步获取指定 ID 子频道。

参数：

• identifier: 子频道 ID

返回：

以 Channel 类型表示的子频道。

async get_channel_group(identifier: str) → ChannelGroup

异步获取指定 ID 子频道。

参数：

• identifier: 频道组 ID

返回：

以 Channel 类型表示的子频道。

async get_current_user() → User

异步获取当前机器人用户。

返回：

以 User 类型表示的当前用户。

async get_guild(identifier: str) → Guild

异步获取指定 ID 频道。

参数：

• identifier: 频道 ID

返回：

以 Guild 类型表示的频道。

async get_guilds() → List[Guild]

异步获取当前机器人的所有频道。

返回：

以 Guild 类型表示频道的 list 集合。

async patch(path: str, params: Optional[Dict[str, Any]] = None, content: Optional[Any] = None) → httpx.Response

异步向服务器请求 PATCH 操作。

参数：

• path: 请求路径（不包含 API 地址）

• params: 请求参数

• content: 请求内容（将序列化为 JSON）

返回：

以 Response 类型表示的服务器响应。

async post(path: str, params: Optional[Dict[str, Any]] = None, content: Optional[Any] = None) → httpx.Response

异步向服务器请求 POST 操作。

参数：

• path: 请求路径（不包含 API 地址）

• params: 请求参数

• content: 请求内容（将序列化为 JSON）

返回：

以 Response 类型表示的服务器响应。

async put(path: str, params: Optional[Dict[str, Any]] = None, content: Optional[Any] = None) → httpx.Response

异步向服务器请求 PUT 操作。

参数：

• path: 请求路径（不包含 API 地址）

• params: 请求参数

• content: 请求内容（将序列化为 JSON）

返回：

以 Response 类型表示的服务器响应。

class cyan.bot.Ticket(app_id: str, token: str)

基类：object

票据。

app_id: str

用于指示机器人的 ID。

token: str

机器人 Token。