lsm/DotNetCore.SKIT.FlurlHttpClient.Wechat
1
0
Fork 0
mirror of https://gitee.com/fudiwei/DotNetCore.SKIT.FlurlHttpClient.Wechat.git synced 2025-04-05 17:37:54 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: 调整部分文档注释

Browse Source
This commit is contained in:
Fu Diwei 2023-02-28 16:22:49 +08:00
parent 66a6e25287
commit 6d47aa5450
3 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/SKIT.FlurlHttpClient.Wechat.Api/Extensions/WechatApiClientEventExtensions.cs
View File

@ -33,7 +33,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
where TEvent : WechatApiEvent
{
if (client == null) throw new ArgumentNullException(nameof(client));
if (string.IsNullOrEmpty(callbackJson)) throw new ArgumentNullException(callbackJson);
if (callbackJson == null) throw new ArgumentNullException(callbackJson);
try
{
@ -62,7 +62,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
where TEvent : WechatApiEvent
{
if (client == null) throw new ArgumentNullException(nameof(client));
if (string.IsNullOrEmpty(callbackXml)) throw new ArgumentNullException(callbackXml);
if (callbackXml == null) throw new ArgumentNullException(callbackXml);
try
{
@ -249,9 +249,9 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
/// <para>REF: https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Access_Overview.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="callbackTimestamp">微信回调通知中的 timestamp 字段。</param>
/// <param name="callbackNonce">微信回调通知中的 nonce 字段。</param>
/// <param name="callbackSignature">微信回调通知中的 signature 字段。</param>
/// <param name="callbackTimestamp">微信回调通知中的 "timestamp" 查询参数。</param>
/// <param name="callbackNonce">微信回调通知中的 "nonce" 查询参数。</param>
/// <param name="callbackSignature">微信回调通知中的 "signature" 查询参数。</param>
/// <returns></returns>
public static bool VerifyEventSignatureForEcho(this WechatApiClient client, string callbackTimestamp, string callbackNonce, string callbackSignature)
{
@ -266,14 +266,14 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
}
/// <summary>
/// <para>验证回调通知事件签名。</para>
/// <para>验证回调通知事件签名（仅安全模式）。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Message_encryption_and_decryption_instructions.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="callbackTimestamp">微信回调通知中的 timestamp 字段。</param>
/// <param name="callbackNonce">微信回调通知中的 nonce 字段。</param>
/// <param name="callbackTimestamp">微信回调通知中的 "timestamp" 查询参数。</param>
/// <param name="callbackNonce">微信回调通知中的 "nonce" 查询参数。</param>
/// <param name="callbackJson">微信回调通知中请求正文（JSON 格式）。</param>
/// <param name="callbackSignature">微信回调通知中的 msg_signature 字段。</param>
/// <param name="callbackSignature">微信回调通知中的 "msg_signature" 查询参数。</param>
/// <returns></returns>
public static bool VerifyEventSignatureFromJson(this WechatApiClient client, string callbackTimestamp, string callbackNonce, string callbackJson, string callbackSignature)
{
@ -298,14 +298,14 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
}
/// <summary>
/// <para>验证回调通知事件签名。</para>
/// <para>验证回调通知事件签名（仅安全模式）。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Message_encryption_and_decryption_instructions.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="callbackTimestamp">微信回调通知中的 timestamp 字段。</param>
/// <param name="callbackNonce">微信回调通知中的 nonce 字段。</param>
/// <param name="callbackTimestamp">微信回调通知中的 "timestamp" 查询参数。</param>
/// <param name="callbackNonce">微信回调通知中的 "nonce" 查询参数。</param>
/// <param name="callbackXml">微信回调通知中请求正文（XML 格式）。</param>
/// <param name="callbackSignature">微信回调通知中的 msg_signature 字段。</param>
/// <param name="callbackSignature">微信回调通知中的 "msg_signature" 查询参数。</param>
/// <returns></returns>
public static bool VerifyEventSignatureFromXml(this WechatApiClient client, string callbackTimestamp, string callbackNonce, string callbackXml, string callbackSignature)
{

36
src/SKIT.FlurlHttpClient.Wechat.TenpayV3/Extensions/WechatTenpayClientEventVerificationExtensions.cs
View File

@ -13,11 +13,11 @@ namespace SKIT.FlurlHttpClient.Wechat.TenpayV3
/// <para>REF: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/wechatpay/wechatpay4_1.shtml </para>
/// </summary>
/// <param name="client"></param>
/// <param name="callbackTimestamp">微信回调通知中的 Wechatpay-Timestamp 字段。</param>
/// <param name="callbackNonce">微信回调通知中的 Wechatpay-Nonce 字段。</param>
/// <param name="callbackTimestamp">微信回调通知中的 "Wechatpay-Timestamp" 请求标头。</param>
/// <param name="callbackNonce">微信回调通知中的 "Wechatpay-Nonce" 请求标头。</param>
/// <param name="callbackBody">微信回调通知中请求正文。</param>
/// <param name="callbackSignature">微信回调通知中的 Wechatpay-Signature 字段。</param>
/// <param name="callbackSerialNumber">微信回调通知中的 Wechatpay-Serial 字段。</param>
/// <param name="callbackSignature">微信回调通知中的 "Wechatpay-Signature" 请求标头。</param>
/// <param name="callbackSerialNumber">微信回调通知中的 "Wechatpay-Serial" 请求标头。</param>
/// <returns></returns>
public static bool VerifyEventSignature(this WechatTenpayClient client, string callbackTimestamp, string callbackNonce, string callbackBody, string callbackSignature, string callbackSerialNumber)
{
@ -38,12 +38,12 @@ namespace SKIT.FlurlHttpClient.Wechat.TenpayV3
/// <para>REF: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/wechatpay/wechatpay4_1.shtml </para>
/// </summary>
/// <param name="client"></param>
/// <param name="callbackTimestamp">微信回调通知中的 Wechatpay-Timestamp 字段。</param>
/// <param name="callbackNonce">微信回调通知中的 Wechatpay-Nonce 字段。</param>
/// <param name="callbackTimestamp">微信回调通知中的 "Wechatpay-Timestamp" 请求标头。</param>
/// <param name="callbackNonce">微信回调通知中的 "Wechatpay-Nonce" 请求标头。</param>
/// <param name="callbackBody">微信回调通知中请求正文。</param>
/// <param name="callbackSignature">微信回调通知中的 Wechatpay-Signature 字段。</param>
/// <param name="callbackSignatureType">微信回调通知中的 Wechatpay-Signature-Type 字段。</param>
/// <param name="callbackSerialNumber">微信回调通知中的 Wechatpay-Serial 字段。</param>
/// <param name="callbackSignature">微信回调通知中的 "Wechatpay-Signature" 请求标头。</param>
/// <param name="callbackSignatureType">微信回调通知中的 "Wechatpay-Signature-Type" 请求标头。</param>
/// <param name="callbackSerialNumber">微信回调通知中的 "Wechatpay-Serial" 请求标头。</param>
/// <returns></returns>
public static bool VerifyEventSignature(this WechatTenpayClient client, string callbackTimestamp, string callbackNonce, string callbackBody, string callbackSignature, string callbackSignatureType, string callbackSerialNumber)
{
@ -65,11 +65,11 @@ namespace SKIT.FlurlHttpClient.Wechat.TenpayV3
/// <para>REF: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/wechatpay/wechatpay4_1.shtml </para>
/// </summary>
/// <param name="client"></param>
/// <param name="callbackTimestamp">微信回调通知中的 Wechatpay-Timestamp 字段。</param>
/// <param name="callbackNonce">微信回调通知中的 Wechatpay-Nonce 字段。</param>
/// <param name="callbackTimestamp">微信回调通知中的 "Wechatpay-Timestamp" 请求标头。</param>
/// <param name="callbackNonce">微信回调通知中的 "Wechatpay-Nonce" 请求标头。</param>
/// <param name="callbackBody">微信回调通知中请求正文。</param>
/// <param name="callbackSignature">微信回调通知中的 Wechatpay-Signature 字段。</param>
/// <param name="callbackSerialNumber">微信回调通知中的 Wechatpay-Serial 字段。</param>
/// <param name="callbackSignature">微信回调通知中的 "Wechatpay-Signature" 请求标头。</param>
/// <param name="callbackSerialNumber">微信回调通知中的 "Wechatpay-Serial" 请求标头。</param>
/// <param name="error"></param>
/// <returns></returns>
public static bool VerifyEventSignature(this WechatTenpayClient client, string callbackTimestamp, string callbackNonce, string callbackBody, string callbackSignature, string callbackSerialNumber, out Exception? error)
@ -92,12 +92,12 @@ namespace SKIT.FlurlHttpClient.Wechat.TenpayV3
/// <para>REF: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/wechatpay/wechatpay4_1.shtml </para>
/// </summary>
/// <param name="client"></param>
/// <param name="callbackTimestamp">微信回调通知中的 Wechatpay-Timestamp 字段。</param>
/// <param name="callbackNonce">微信回调通知中的 Wechatpay-Nonce 字段。</param>
/// <param name="callbackTimestamp">微信回调通知中的 "Wechatpay-Timestamp" 请求标头。</param>
/// <param name="callbackNonce">微信回调通知中的 "Wechatpay-Nonce" 请求标头。</param>
/// <param name="callbackBody">微信回调通知中请求正文。</param>
/// <param name="callbackSignature">微信回调通知中的 Wechatpay-Signature 字段。</param>
/// <param name="callbackSignatureType">微信回调通知中的 Wechatpay-Signature-Type 字段。</param>
/// <param name="callbackSerialNumber">微信回调通知中的 Wechatpay-Serial 字段。</param>
/// <param name="callbackSignature">微信回调通知中的 "Wechatpay-Signature" 请求标头。</param>
/// <param name="callbackSignatureType">微信回调通知中的 "Wechatpay-Signature-Type" 请求标头。</param>
/// <param name="callbackSerialNumber">微信回调通知中的 "Wechatpay-Serial" 请求标头。</param>
/// <param name="error"></param>
/// <returns></returns>
public static bool VerifyEventSignature(this WechatTenpayClient client, string callbackTimestamp, string callbackNonce, string callbackBody, string callbackSignature, string callbackSignatureType, string callbackSerialNumber, out Exception? error)

20
src/SKIT.FlurlHttpClient.Wechat.Work/Extensions/WechatWorkClientEventExtensions.cs
View File

@ -235,10 +235,10 @@ namespace SKIT.FlurlHttpClient.Wechat.Work
/// <para>REF: https://developer.work.weixin.qq.com/document/path/91148 </para>
/// </summary>
/// <param name="client"></param>
/// <param name="callbackTimestamp">微信回调通知中的 timestamp 字段。</param>
/// <param name="callbackNonce">微信回调通知中的 nonce 字段。</param>
/// <param name="callbackEcho">微信回调通知中的 echostr 字段。</param>
/// <param name="callbackSignature">微信回调通知中的 msg_signature 字段。</param>
/// <param name="callbackTimestamp">微信回调通知中的 "timestamp" 查询参数。</param>
/// <param name="callbackNonce">微信回调通知中的 "nonce" 查询参数。</param>
/// <param name="callbackEcho">微信回调通知中的 "echostr" 查询参数。</param>
/// <param name="callbackSignature">微信回调通知中的 "msg_signature" 查询参数。</param>
/// <param name="replyEcho"></param>
/// <returns></returns>
public static bool VerifyEventSignatureForEcho(this WechatWorkClient client, string callbackTimestamp, string callbackNonce, string callbackEcho, string callbackSignature, out string? replyEcho)
@ -278,10 +278,10 @@ namespace SKIT.FlurlHttpClient.Wechat.Work
/// <para>REF: https://developer.work.weixin.qq.com/document/path/91148 </para>
/// </summary>
/// <param name="client"></param>
/// <param name="callbackTimestamp">微信回调通知中的 timestamp 字段。</param>
/// <param name="callbackNonce">微信回调通知中的 nonce 字段。</param>
/// <param name="callbackTimestamp">微信回调通知中的 "timestamp" 查询参数。</param>
/// <param name="callbackNonce">微信回调通知中的 "nonce" 查询参数。</param>
/// <param name="callbackJson">微信回调通知中请求正文（JSON 格式）。</param>
/// <param name="callbackSignature">微信回调通知中的 msg_signature 字段。</param>
/// <param name="callbackSignature">微信回调通知中的 "msg_signature" 查询参数。</param>
/// <returns></returns>
public static bool VerifyEventSignatureFromJson(this WechatWorkClient client, string callbackTimestamp, string callbackNonce, string callbackJson, string callbackSignature)
{
@ -312,10 +312,10 @@ namespace SKIT.FlurlHttpClient.Wechat.Work
/// <para>REF: https://developer.work.weixin.qq.com/document/path/91148 </para>
/// </summary>
/// <param name="client"></param>
/// <param name="callbackTimestamp">微信回调通知中的 timestamp 字段。</param>
/// <param name="callbackNonce">微信回调通知中的 nonce 字段。</param>
/// <param name="callbackTimestamp">微信回调通知中的 "timestamp" 查询参数。</param>
/// <param name="callbackNonce">微信回调通知中的 "nonce" 查询参数。</param>
/// <param name="callbackXml">微信回调通知中请求正文（XML 格式）。</param>
/// <param name="callbackSignature">微信回调通知中的 msg_signature 字段。</param>
/// <param name="callbackSignature">微信回调通知中的 "msg_signature" 查询参数。</param>
/// <returns></returns>
public static bool VerifyEventSignatureFromXml(this WechatWorkClient client, string callbackTimestamp, string callbackNonce, string callbackXml, string callbackSignature)
{