cyan.event package¶
Submodules¶
Module contents¶
- class cyan.event.Event(bot: Bot)[源代码]¶
基类：
object事件。
- bind(*handler: Union[Callable[[Any], Union[Awaitable[None], Awaitable[NoReturn]]], Callable[[Any, Any], Union[Awaitable[None], Awaitable[NoReturn]]]]) None[源代码]¶
绑定事件处理器。
- 参数：
handler: 将要绑定的事件处理器
- abstract static get_event_info() cyan.event.EventInfo[源代码]¶
获取当前事件信息。
- 返回：
以 EventInfo 类型表示的事件信息。
- cyan.event.EventHandler¶
事件处理器。
alias of
Union[Callable[[Any],Union[Awaitable[None],Awaitable[NoReturn]]],Callable[[Any,Any],Union[Awaitable[None],Awaitable[NoReturn]]]]
- class cyan.event.EventInfo(name: str, intent: cyan.event.Intent)[源代码]¶
基类：
object事件信息。
- property intent: cyan.event.Intent¶
事件所需注册的 Intent。
- property name: str¶
事件名称。
- class cyan.event.EventSource(bot: Bot, authorization: str)[源代码]¶
基类：
object事件源。
- property connected: bool¶
WebSocket 是否已连接。
- get_event(_type: Type[cyan.event.Event]) cyan.event.Event[源代码]¶
获取指定类型的事件。
- 参数：
_type: 所需获取事件的类型
- 返回：
指定类型事件的实例。
- listen(_type: Type[cyan.event.Event]) Callable[[Union[Callable[[Any], Union[Awaitable[None], Awaitable[NoReturn]]], Callable[[Any, Any], Union[Awaitable[None], Awaitable[NoReturn]]]]], None][源代码]¶
装饰事件处理器以监听指定事件。
- 参数：
_type: 所需监听事件的类型
- async send(operation: cyan.event.Operation, payload: Optional[Any] = None) None[源代码]¶
异步发送数据至服务器。
- 参数：
operation: 操作
payload: Payload