Skip to content

Commit

Permalink
Merge pull request #16 from liuwilliamBUPT/main
Browse files Browse the repository at this point in the history
[Docs] Replace all "登陆" to "登录".
  • Loading branch information
pk5ls20 authored Sep 3, 2024
2 parents 89e8d0a + 6cfcd71 commit 3304b28
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 20 deletions.
10 changes: 5 additions & 5 deletions docs/Lagrange.Core/CreateBot/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ BotContext 是 Lagrange.Core 的核心实例, Event, Logger, Send 等操作都
| 字段 | 类型 | 描述 |
| :-------: | :----------: | :----------------------------------: |
| `Invoker` | EventInvoker | 所有 Event 的集合,用于订阅并处理消息 |
| `BotUin` | uint | 登陆的账号 |
| `BotName` | string | 登陆账号的昵称 |
| `BotUin` | uint | 登录的账号 |
| `BotName` | string | 登录账号的昵称 |

BotContext 的构造需要由 BotFactory 工厂类创建, 其本身的构造函数私有化

Expand All @@ -26,7 +26,7 @@ var bot = BotFactory.Create(new BotConfig(), _deviceInfo, _keyStore);
| `AutoReconnect` | bool | 自动重连,默认为 `true` |
| `UseIPv6Network` | bool | 是否使用 IPv6, 默认为 `false` |
| `GetOptimumServer` | bool | 自动使用链接状态最优的服务器, 默认为 `true` |
| `CustomSignProvider` | SignProvider? | 自定义签名服务器, 需要与 Protocol 和版本匹配, 不匹配或无签名可能导致无法登陆 |
| `CustomSignProvider` | SignProvider? | 自定义签名服务器, 需要与 Protocol 和版本匹配, 不匹配或无签名可能导致无法登录 |

## BotDeviceInfo 设备信息类

Expand Down Expand Up @@ -54,10 +54,10 @@ private BotDeviceInfo _deviceInfo = new()

## BotKeyStore 密钥存储类

由序列化现有 KeyStore 创建, 或由初始构造方法自动创建, 登陆成功后可使用
由序列化现有 KeyStore 创建, 或由初始构造方法自动创建, 登录成功后可使用

```csharp
_keyStore = bot.UpdateKeystore();
```

更新获取 KeyStore 序列化至本地存储,方便下次快速登陆
更新获取 KeyStore 序列化至本地存储,方便下次快速登录
4 changes: 2 additions & 2 deletions docs/Lagrange.Core/Login/Extern.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# 扩展

你可以通过在登陆前订阅 `BotOnlineEvent` 来获取是否登陆成功, 该 Event 将在下文介绍
你可以通过在登录前订阅 `BotOnlineEvent` 来获取是否登录成功, 该 Event 将在下文介绍

此外, 在登陆完毕后你还可以使用 `UpdateKeystore()` 方法获取新的 KeyStore 文件并保存以方便下次快速登陆
此外, 在登录完毕后你还可以使用 `UpdateKeystore()` 方法获取新的 KeyStore 文件并保存以方便下次快速登录

```csharp
_keyStore = bot.UpdateKeystore();
Expand Down
8 changes: 4 additions & 4 deletions docs/Lagrange.Core/Login/LoginByPassword.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# 密码登陆
# 密码登录

密码登陆需要之前**已经使用扫码登陆过**, 并**保存了 BotDeviceInfo, BotKeyStore**, 且**在创建 BotContext 的时候已将上述配置给到构造方法内**
密码登录需要之前**已经使用扫码登录过**, 并**保存了 BotDeviceInfo, BotKeyStore**, 且**在创建 BotContext 的时候已将上述配置给到构造方法内**

使用空的 BotDeviceInfo, BotKeyStore 会导致登陆失败, 且如果 BotDeviceInfo 与 BotKeyStore 不匹配也会导致登陆失败!
使用空的 BotDeviceInfo, BotKeyStore 会导致登录失败, 且如果 BotDeviceInfo 与 BotKeyStore 不匹配也会导致登录失败!

使用 `LoginByPassword()` 异步方法等待密码登陆完成
使用 `LoginByPassword()` 异步方法等待密码登录完成

```csharp
await bot.LoginByPassword();
Expand Down
10 changes: 5 additions & 5 deletions docs/Lagrange.Core/Login/LoginByScanQrCode.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# 扫码登陆
# 扫码登录

本节将介绍如何扫码登陆
本节将介绍如何扫码登录

扫码登陆是目前初次登陆所必须的登陆方式, 初次登陆使用密码登陆有较大概率无法登陆!
扫码登录是目前初次登录所必须的登录方式, 初次登录使用密码登录有较大概率无法登录!

## QrCode 二维码

Expand All @@ -25,7 +25,7 @@ var qrCode = await bot.FetchQrCode();
二维码内容链接需要被转换为二维码图片后通过手机 App 扫码登录, 不要直接访问链接
:::

## 等待登陆
## 等待登录

在获取完二维码后,等待异步方法 `LoginByQrCode()`, 该方法会等待用户扫码并在扫码完毕后返回

Expand All @@ -34,5 +34,5 @@ await bot.LoginByQrCode();
```

::: tip 提示
如果你正在进行概念验证, 运行完登陆后程序不会自行退出, 这是因为 BotContext 需要被你 Dispose
如果你正在进行概念验证, 运行完登录后程序不会自行退出, 这是因为 BotContext 需要被你 Dispose
:::
8 changes: 4 additions & 4 deletions docs/Lagrange.Core/Login/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# 登陆
# 登录

本章介绍了如何进行登陆
本章介绍了如何进行登录

## 导航

1. [扫码登陆](/Lagrange.Core/Login/LoginByScanQrCode)
2. [密码登陆](/Lagrange.Core/Login/LoginByPassword)
1. [扫码登录](/Lagrange.Core/Login/LoginByScanQrCode)
2. [密码登录](/Lagrange.Core/Login/LoginByPassword)
3. [扩展](/Lagrange.Core/Login/Extern)

0 comments on commit 3304b28

Please sign in to comment.