NoneBot

# NoneBot.adapters.feishu 模块

# NoneBot.adapters.feishu.config 模块

# class Config

飞书配置类

  • 配置项

    • app_id / feishu_app_id: 飞书开放平台后台“凭证与基础信息”处给出的 App ID

    • app_secret / feishu_app_secret: 飞书开放平台后台“凭证与基础信息”处给出的 App Secret

    • encrypt_key / feishu_encrypt_key: 飞书开放平台后台“事件订阅”处设置的 Encrypt Key

    • verification_token / feishu_verification_token: 飞书开放平台后台“事件订阅”处设置的 Verification Token

    • tenant_access_token / feishu_tenant_access_token: 请求飞书 API 后返回的租户密钥

    • is_lark / feishu_is_lark: 是否使用Lark（飞书海外版），默认为 false

# NoneBot.adapters.feishu.exception 模块

# exception ActionFailed

基类：nonebot.exception.ActionFailed, nonebot.adapters.feishu.exception.FeishuAdapterException

  • 说明

    API 请求返回错误信息。

  • 参数

    • retcode: Optional[int]: 错误码

# exception NetworkError

基类：nonebot.exception.NetworkError, nonebot.adapters.feishu.exception.FeishuAdapterException

  • 说明

    网络错误。

  • 参数

    • retcode: Optional[int]: 错误码

# NoneBot.adapters.feishu.bot 模块

# _check_at_me(bot, event)

  • 说明

    检查消息开头或结尾是否存在 @机器人，去除并赋值 event.reply, event.to_me

  • 参数

    • bot: Bot: Bot 对象

    • event: Event: Event 对象

# _check_nickname(bot, event)

  • 说明

    检查消息开头是否存在昵称，去除并赋值 event.to_me

  • 参数

    • bot: Bot: Bot 对象

    • event: Event: Event 对象

# _handle_api_result(result)

  • 说明

    处理 API 请求返回值。

  • 参数

    • result: Optional[Dict[str, Any]]: API 返回数据

  • 返回

    • Any: API 调用返回数据

  • 异常

    • ActionFailed: API 调用失败

# class Bot

基类：nonebot.adapters._bot.Bot

飞书 协议 Bot 适配。继承属性参考 BaseBot 。

# async handle_message(message)

  • 说明

    处理事件并转换为 Event

# async call_api(api, **data)

  • 说明

    调用 飞书 协议 API

  • 参数

    • api: str: API 名称

    • **data: Any: API 参数

  • 返回

    • Any: API 调用返回数据

  • 异常

    • NetworkError: 网络错误

    • ActionFailed: API 调用失败

# NoneBot.adapters.feishu.message 模块

# class MessageSegment

基类：nonebot.adapters._message.MessageSegment[Message]

飞书 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。

# class Message

基类：nonebot.adapters._message.Message[nonebot.adapters.feishu.message.MessageSegment]

飞书 协议 Message 适配。

# class MessageSerializer

基类：object

飞书 协议 Message 序列化器。

# class MessageDeserializer

基类：object

飞书 协议 Message 反序列化器。

# NoneBot.adapters.feishu.event 模块

# class Event

基类：nonebot.adapters._event.Event

飞书协议事件。各事件字段参考 飞书文档 (opens new window)

# get_event_model(event_name)

  • 说明

    根据事件名获取对应 Event Model 及 FallBack Event Model 列表

  • 返回

    • List[Type[Event]]

←

Contents