add PhoneNumberApi doc

This commit is contained in:
niko
2021-12-21 09:28:52 +08:00
parent b63b533b58
commit 572048be6c
@@ -8,8 +8,9 @@ import com.foxinmy.weixin4j.wxa.WXBizDataCrypt;
import com.foxinmy.weixin4j.wxa.model.phone.PhoneInfo; import com.foxinmy.weixin4j.wxa.model.phone.PhoneInfo;
import java.util.Properties; import java.util.Properties;
/** /**
* 微信绑定号码。 * 获取微信绑定号码。
* *
* @since 1.10.0 * @since 1.10.0
*/ */
@@ -21,7 +22,10 @@ public class PhoneNumberApi extends TokenManagerApi {
/** /**
* 获取微信绑定手机号码 * 获取微信绑定手机号码
* code换取用户手机号。 每个code只能使用一次,code的有效期为5min
* *
* @param code 微信小程序 open-type="getPhoneNumber"
* @throws WeixinException code无效或过期
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/phonenumber/phonenumber.getPhoneNumber.html"><a/> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/phonenumber/phonenumber.getPhoneNumber.html"><a/>
*/ */
public PhoneInfo getPhoneNumber(String code) throws WeixinException { public PhoneInfo getPhoneNumber(String code) throws WeixinException {
@@ -38,6 +42,12 @@ public class PhoneNumberApi extends TokenManagerApi {
/** /**
* 从 encryptedData 中解析 PhoneInfo * 从 encryptedData 中解析 PhoneInfo
*
* @param appId 小程序 appId
* @param sessionKey wx.login 获取
* @param encryptedData 密文
* @param iv 加密方式
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/deprecatedGetPhoneNumber.html"></a>
*/ */
public PhoneInfo parsePhoneNumber( public PhoneInfo parsePhoneNumber(
String appId, String appId,