完善获取公众号关注者接口的文档

michaeljxf · Apr 17, 2019 · 67ae6b8 · 67ae6b8
1 parent 841fe20
commit 67ae6b8
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 16 deletions.
diff --git a/src/Senparc.Weixin.MP/Senparc.Weixin.MP/AdvancedAPIs/User/UserApi.cs b/src/Senparc.Weixin.MP/Senparc.Weixin.MP/AdvancedAPIs/User/UserApi.cs
@@ -20,19 +20,19 @@
 
 /*----------------------------------------------------------------
     Copyright (C) 2019 Senparc
-    
+
     文件名：UserAPI.cs
     文件功能描述：用户接口
-    
-    
+
+
     创建标识：Senparc - 20150211
-    
+
     修改标识：Senparc - 20150303
     修改描述：整理接口
-    
+
     修改标识：jsionr - 20150322
     修改描述：添加修改关注者备注信息接口
-    
+
     修改标识：Senparc - 20150325
     修改描述：修改关注者备注信息开放代理请求超时时间
 
@@ -93,10 +93,11 @@ public static UserInfoJson Info(string accessTokenOrAppId, string openId, Langua
         }
 
         /// <summary>
-        /// 获取关注者OpenId信息
+        /// 获取关注者OpenId信息 .
+        /// 一次拉取调用最多拉取10000个关注者的OpenID，可通过填写next_openid的值，从而多次拉取列表的方式来满足需求。
         /// </summary>
         /// <param name="accessTokenOrAppId">AccessToken或AppId（推荐使用AppId，需要先注册）</param>
-        /// <param name="nextOpenId"></param>
+        /// <param name="nextOpenId">第一个拉取的OPENID，不填默认从头开始拉取</param>
         /// <returns></returns>
         [ApiBind(NeuChar.PlatformType.WeChat_OfficialAccount, "UserApi.Get", true)]
         public static OpenIdResultJson Get(string accessTokenOrAppId, string nextOpenId)

diff --git a/src/Senparc.Weixin.MP/Senparc.Weixin.MP/AdvancedAPIs/User/UserJson/OpenIdResultJson.cs b/src/Senparc.Weixin.MP/Senparc.Weixin.MP/AdvancedAPIs/User/UserJson/OpenIdResultJson.cs
@@ -1,12 +1,12 @@
 /*----------------------------------------------------------------
     Copyright (C) 2019 Senparc
-    
+
     文件名：OpenIdResultJson.cs
     文件功能描述：获取关注者OpenId信息返回结果
-    
-    
+
+
     创建标识：Senparc - 20150211
-    
+
     修改标识：Senparc - 20150303
     修改描述：整理接口
 ----------------------------------------------------------------*/
@@ -16,12 +16,27 @@
 
 namespace Senparc.Weixin.MP.AdvancedAPIs.User
 {
+    /// <summary>
+    /// 获取关注者OpenId信息返回结果
+    /// </summary>
     public class OpenIdResultJson : WxJsonResult
     {
-       public int total { get; set; }
-       public int count { get; set; }
-       public OpenIdResultJson_Data data { get; set; }
-       public string next_openid { get; set; }
+        /// <summary>
+        /// 关注该公众账号的总用户数
+        /// </summary>
+        public int total { get; set; }
+        /// <summary>
+        /// 拉取的OPENID个数，最大值为10000
+        /// </summary>
+        public int count { get; set; }
+        /// <summary>
+        /// 列表数据，OPENID的列表
+        /// </summary>
+        public OpenIdResultJson_Data data { get; set; }
+        /// <summary>
+        /// 拉取列表的最后一个用户的OPENID
+        /// </summary>
+        public string next_openid { get; set; }
     }
 
     public class OpenIdResultJson_Data