docs: 完善文档

This commit is contained in:
Fu Diwei
2024-02-18 08:45:13 +08:00
parent ac9e28ae2a
commit 17b7805256
3 changed files with 24 additions and 6 deletions

View File

@@ -101,7 +101,7 @@ EncodedString estr = new EncodedString("U0tJVC5GbHVybEh0dHBDbGllbnQgaXMgQVdFU09N
string str = (string)estr;
```
涉及变化的包括 `AESUtility``SHA1Utility``HMACUtility` 等工具类。
涉及变化的包括 `AESUtility``SHA1Utility``HMACUtility` 等工具类。
### 基础类型:`SKIT.FlurlHttpClient.Primitives.ErroredResult`
@@ -123,4 +123,10 @@ ErroredResult eret = new ErroredResult(true);
bool ret = (bool)eret;
```
涉及变化的包括 `VerifyEventSignatureFromJson()``VerifyEventSignatureFromXml()` 等扩展方法。
涉及变化的包括 `VerifyEventSignatureFromJson()``VerifyEventSignatureFromXml()` 等扩展方法。
### 方法命名参数的变化
为了统一并规范化各个模块,我们调整了部分方法的命名参数。如果你在调用该方法时使用了命名实参,请注意修改。
涉及此变化的包括 `DeserializeEventFromJson()``DeserializeEventFromXml()``SerializeEventToJson``SerializeEventToXml``VerifyEventSignatureForEcho``VerifyEventSignatureFromJson``VerifyEventSignatureFromXml` 等扩展方法,及 `AESUtility``SHA1Utility``HMACUtility` 等工具类。

View File

@@ -130,10 +130,16 @@ bool ret = (bool)eret;
涉及到变化的包括 `VerifyResponseSignature()``VerifyEventSignature()` 等扩展方法。
### 平台证书管理器
### 平台证书管理器的变化
原有的平台证书管理器由抽象类型 `CertificateManager` 调整为接口 `ICertificateManager`
同时,我们提供了新的 `ICertificateManagerAsync` 接口,开发者可以基于此自定义异步的密钥管理器实现。然后,你就可以调用 `VerifyResponseSignatureAsync()``VerifyEventSignatureAsync()``EncryptRequestSensitivePropertyAsync()` 等新的扩展方法,来异步地执行原本的业务流程了。
此外,我们废弃了原本的 `CertificateEntry` 的一个构造函数 `CertificateEntry(QueryCertificatesResponse.Types.Certificate model)` 重载。取而代之的是新的静态方法 `CertificateEntry.Parse(QueryCertificatesResponse.Types.Certificate model)`
### 方法命名参数的变化
为了统一并规范化各个模块,我们调整了部分方法的命名参数。如果你在调用该方法时使用了命名实参,请注意修改。
涉及此变化的包括 `DeserializeEvent()``DecryptEventResource()``VerifyEventSignature``VerifyResponseSignature` 等扩展方法,及 `AESUtility``RSAUtility``SHA256Utility``SM2Utility``SM3Utility``SM4Utility` 等工具类。

View File

@@ -101,7 +101,7 @@ EncodedString estr = new EncodedString("U0tJVC5GbHVybEh0dHBDbGllbnQgaXMgQVdFU09N
string str = (string)estr;
```
涉及变化的包括 `AESUtility``RSAUtility``SHA1Utility` 等工具类。
涉及变化的包括 `AESUtility``RSAUtility``SHA1Utility` 等工具类。
### 基础类型:`SKIT.FlurlHttpClient.Primitives.ErroredResult`
@@ -123,10 +123,16 @@ ErroredResult eret = new ErroredResult(true);
bool ret = (bool)eret;
```
涉及变化的包括 `VerifyEventSignatureForEcho()``VerifyEventSignatureFromJson()``VerifyEventSignatureFromXml()` 等扩展方法。
涉及变化的包括 `VerifyEventSignatureForEcho()``VerifyEventSignatureFromJson()``VerifyEventSignatureFromXml()` 等扩展方法。
### 企业会话存档 SDK
### 企业会话存档 SDK 的变化
原企业会话存档 SDK 客户端的命名空间发生了变化,由 `SKIT.FlurlHttpClient.Wechat.Work.SDK.Finance` 移动至 `SKIT.FlurlHttpClient.Wechat.Work.ExtendedSDK.Finance`
同时,我们提供了新的 `IEncryptionKeyManagerAsync` 接口,开发者可以基于此自定义异步的密钥管理器实现。
### 方法命名参数的变化
为了统一并规范化各个模块,我们调整了部分方法的命名参数。如果你在调用该方法时使用了命名实参,请注意修改。
涉及此变化的包括 `DeserializeEventFromJson()``DeserializeEventFromXml()``SerializeEventToJson``SerializeEventToXml``VerifyEventSignatureForEcho``VerifyEventSignatureFromJson``VerifyEventSignatureFromXml` 等扩展方法,及 `AESUtility``RSAUtility``SHA1Utility` 等工具类。