Skip to content

Commit

Permalink
🔖 Release 2.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Aug 3, 2023
1 parent 2b3d348 commit 245a1c0
Show file tree
Hide file tree
Showing 15 changed files with 1,703 additions and 2 deletions.
2 changes: 1 addition & 1 deletion website/src/pages/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ toc_max_heading_level: 2

# 更新日志

## 最近更新
## v2.0.1

### 🐛 Bug 修复

Expand Down
Empty file.
97 changes: 97 additions & 0 deletions website/versioned_docs/version-2.0.1/api/adapter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# nonebot.adapters.feishu.adapter

## _class_ `Adapter(driver, **kwargs)` {#Adapter}

- **参数**

- `driver` (Driver)

- `**kwargs` (Any)

### _class-var_ `event_models` {#Adapter-event-models}

- **类型:** StringTrie

- **说明:** 所有事件模型索引

### _classmethod_ `get_name()` {#Adapter-get-name}

- **说明:** 适配器名称: `Feishu`

- **参数**

empty

- **返回**

- str

### _method_ `setup()` {#Adapter-setup}

- **参数**

empty

- **返回**

- None

### _async method_ `get_tenant_access_token(bot_config)` {#Adapter-get-tenant-access-token}

- **参数**

- `bot_config` ([BotConfig](config.md#BotConfig))

- **返回**

- str

### _classmethod_ `json_to_event(json_data)` {#Adapter-json-to-event}

- **说明:** 将 json 数据转换为 Event 对象。

- **参数**

- `json_data` (Any): json 数据

- `self_id`: 当前 Event 对应的 Bot

- **返回**

- [Event](event.md#Event) | None: Event 对象,如果解析失败则返回 None

### _classmethod_ `add_custom_model(model)` {#Adapter-add-custom-model}

- **说明:** 插入或覆盖一个自定义的 Event 类型。 需提供 `__event__` 属性,进行事件模型索引, 格式为 `{post_type}[.{sub_type}]`,如: `message.private`

- **参数**

- `model` (type[[Event](event.md#Event)]): 自定义的 Event 类型

- **返回**

- None

### _classmethod_ `get_event_model(event_name)` {#Adapter-get-event-model}

- **说明:** 根据事件名获取对应 `Event Model``FallBack Event Model` 列表, 不包括基类 `Event`

- **参数**

- `event_name` (str)

- **返回**

- list[type[[Event](event.md#Event)]]

### _classmethod_ `custom_send(send_func)` {#Adapter-custom-send}

- **说明:** 自定义 Bot 的回复函数。

- **参数**

- `send_func` (([Bot](bot.md#Bot), [Event](event.md#Event), str | [Message](message.md#Message) | [MessageSegment](message.md#MessageSegment)) -> Any)

- **返回**

- untyped
109 changes: 109 additions & 0 deletions website/versioned_docs/version-2.0.1/api/bot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# nonebot.adapters.feishu.bot

## _async def_ `send(bot, event, message, at_sender=False, **kwargs)` {#send}

- **说明:** 默认回复消息处理函数。

- **参数**

- `bot` (Bot)

- `event` ([Event](event.md#Event))

- `message` (str | [Message](message.md#Message) | [MessageSegment](message.md#MessageSegment))

- `at_sender` (bool)

- `**kwargs` (Any)

- **返回**

- Any

## _class_ `BotInfo(<auto>)` {#BotInfo}

- **参数**

auto

## _class_ `Bot(adapter, self_id, *, bot_config, bot_info)` {#Bot}

- **说明:** 飞书 协议 Bot 适配。继承属性参考 `BaseBot <./#class-basebot>`\_

- **参数**

- `adapter` ([Adapter](adapter.md#Adapter))

- `self_id` (str)

- `bot_config` ([BotConfig](config.md#BotConfig))

- `bot_info` (BotInfo)

### _async method_ `send_handler(event, message, at_sender=False, **kwargs)` {#Bot-send-handler}

- **说明:** 默认回复消息处理函数。

- **参数**

- `event` ([Event](event.md#Event))

- `message` (str | [Message](message.md#Message) | [MessageSegment](message.md#MessageSegment))

- `at_sender` (bool)

- `**kwargs` (Any)

- **返回**

- Any

### _async method_ `send(event, message, **kwargs)` {#Bot-send}

- **说明:** 根据 `event` 向触发事件的主体回复消息。

- **参数**

- `event` ([Event](event.md#Event)): Event 对象

- `message` (str | [Message](message.md#Message) | [MessageSegment](message.md#MessageSegment)): 要发送的消息

- `at_sender` (bool): 是否 @ 事件主体

- `**kwargs` (Any): 其他参数,可以与 [Adapter.custom_send](adapter.md#Adapter-custom-send) 配合使用

- **返回**

- Any: API 调用返回数据

- **异常**

- ValueError: 缺少 `user_id`, `group_id`

- NetworkError: 网络错误

- ActionFailed: API 调用失败

### _async method_ `call_api(api, **data)` {#Bot-call-api}

- **说明:** :说明: 调用 OneBot 协议 API :参数: _ `api: str`: API 名称 _ `**data: Any`: API 参数 :返回: - `Any`: API 调用返回数据 :异常: - `NetworkError`: 网络错误 - `ActionFailed`: API 调用失败

- **参数**

- `api` (str)

- `**data`

- **返回**

- Any

### _async method_ `handle_event(event)` {#Bot-handle-event}

- **参数**

- `event` ([Event](event.md#Event))

- **返回**

- None
35 changes: 35 additions & 0 deletions website/versioned_docs/version-2.0.1/api/config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# nonebot.adapters.feishu.config

## _class_ `BotConfig(<auto>)` {#BotConfig}

- **说明**

飞书适配器机器人配置类

:配置项:

- `app_id`: 飞书开放平台后台“凭证与基础信息”处给出的 App ID
- `app_secret`: 飞书开放平台后台“凭证与基础信息”处给出的 App Secret
- `encrypt_key`: 飞书开放平台后台“事件订阅”处设置的 Encrypt Key
- `verification_token`: 飞书开放平台后台“事件订阅”处设置的 Verification Token
- `is_lark`: 是否使用 Lark(飞书海外版),默认为 false

- **参数**

auto

## _class_ `Config(<auto>)` {#Config}

- **说明**

飞书适配器全局配置类

:配置项:

- `feishu_api_base`: 飞书国内版开放平台 API Endpoint
- `feishu_lark_api_base`: 飞书海外版(lark)开放平台 API Endpoint
- `feishu_bots`: 飞书适配器 Bot 配置列表,具体配置项参阅 BotConfig 类

- **参数**

auto
Loading

0 comments on commit 245a1c0

Please sign in to comment.