alicebot.adapter.dingtalk

DingTalk 协议适配器。

本适配器适配了钉钉企业自建机器人协议。 协议详情请参考：钉钉开放平台。

class DingTalkAdapter

Bases: alicebot.adapter.Adapter

钉钉协议适配器。

• Attributes

  • name (str)

  • app (aiohttp.web_app.Application)

  • runner (aiohttp.web_runner.AppRunner)

  • site (aiohttp.web_runner.TCPSite)

  • session (aiohttp.client.ClientSession)

class Config

Bases: alicebot.config.ConfigModel

DingTalk 配置类，将在适配器被加载时被混入到机器人主配置中。

• Attributes

  • host (str) - 本机域名。

  • port (int) - 监听的端口。

  • url (str) - 路径。

  • api_timeout (int) - 进行 API 调用时等待返回响应的超时时间。

  • app_secret (str) - 机器人的 appSecret。

method get_sign(self, timestamp)

计算签名。

• Arguments

  • timestamp (str) - 时间戳。

• Returns

  Type: str

  签名。

async method handler(self, request)

处理 aiohttp 服务器的接收。

• Arguments

  • request (aiohttp.web_request.Request) - aiohttp 服务器的 Request 对象。

• Returns

  Type: aiohttp.web_response.Response

async method run(self)

适配器运行方法，适配器开发者必须实现该方法。

适配器运行过程中保持保持运行，当此方法结束后， AliceBot 不会自动重新启动适配器。

• Returns

  Type: None

async method send(self, webhook, conversation_type, msg, at = None)

发送消息。

• Arguments

  • webhook (str) - Webhook 网址。

  • conversation_type (Literal['1', '2']) - 聊天类型，"1" 表示单聊，"2" 表示群聊。

  • msg (Union[str, dict[str, Any], alicebot.adapter.dingtalk.message.DingTalkMessage]) - 消息。

  • at (Union[NoneType, dict[str, Any], alicebot.adapter.dingtalk.message.DingTalkMessage]) - At 对象，仅在群聊时生效，默认为空。

• Returns

  Type: dict[str, typing.Any]

  钉钉服务器的响应。

• Raises

  • TypeError - 传入参数类型错误。

  • ValueError - 传入参数值错误。

  • NetworkError - 调用 Webhook 地址时网络错误。

async method shutdown(self)

在适配器结束运行时运行的方法，用于安全地关闭适配器。

AliceBot 在接收到系统的结束信号后先发送 cancel 请求给 run 任务。 在所有适配器都停止运行后，会依次运行并等待所有适配器的 shutdown() 方法。 当强制退出时此方法可能未被执行。

• Returns

  Type: None

async method startup(self)

在适配器开始运行前运行的方法，用于初始化适配器。

AliceBot 依次运行并等待所有适配器的 startup() 方法，待运行完毕后再创建 run() 任务。

• Returns

  Type: None