cn.binarywang.wx.miniapp.api

接口 WxMaUserService

所有已知实现类:

WxMaUserServiceImpl

public interface WxMaUserService

用户信息相关操作接口.

作者:

Binary Wang

方法概要

限定符和类型	方法和说明
boolean	checkUserInfo(String sessionKey, String rawData, String signature) 验证用户信息完整性.
WxMaCode2VerifyInfoResult	getCode2VerifyInfo(String code, String checkcode) 多端登录验证接口.
WxMaPhoneNumberInfo	getPhoneNoInfo(String code) 已过时。
WxMaPhoneNumberInfo	getPhoneNoInfo(String sessionKey, String encryptedData, String ivStr) 已过时。 当前（基础库2.21.2以下使用）旧版本，以上请使用替代方法 getPhoneNoInfo(String)
WxMaPhoneNumberInfo	getPhoneNumber(String code) 获取手机号信息,基础库:2.21.2及以上或2023年8月28日起
WxMaJscode2SessionResult	getSessionInfo(String jsCode) 获取登录后的session信息.
WxMaUserInfo	getUserInfo(String sessionKey, String encryptedData, String ivStr) 解密用户敏感数据.
void	setUserStorage(Map<String,String> kvMap, String sessionKey, String openid) 上报用户数据后台接口.

方法详细资料

getSessionInfo

WxMaJscode2SessionResult getSessionInfo(String jsCode)
                                 throws WxErrorException

获取登录后的session信息.

参数:

jsCode - 登录时获取的 code

返回:

.

抛出:

WxErrorException - .

getUserInfo

WxMaUserInfo getUserInfo(String sessionKey,
                         String encryptedData,
                         String ivStr)

解密用户敏感数据.

参数:

sessionKey - 会话密钥

encryptedData - 消息密文

ivStr - 加密算法的初始向量

setUserStorage

void setUserStorage(Map<String,String> kvMap,
                    String sessionKey,
                    String openid)
             throws WxErrorException

上报用户数据后台接口.

小游戏可以通过本接口上报key-value数据到用户的CloudStorage。

文档参考https://developers.weixin.qq.com/minigame/dev/document/open-api/data/setUserStorage.html

参数:

kvMap - 要上报的数据

sessionKey - 通过wx.login 获得的登录态

openid - .

抛出:

WxErrorException - .

getPhoneNoInfo

@Deprecated
WxMaPhoneNumberInfo getPhoneNoInfo(String sessionKey,
                                               String encryptedData,
                                               String ivStr)

已过时。 当前（基础库2.21.2以下使用）旧版本，以上请使用替代方法 getPhoneNoInfo(String)

解密用户手机号信息.

参数:

sessionKey - 会话密钥

encryptedData - 消息密文

ivStr - 加密算法的初始向量

返回:

.

getPhoneNumber

WxMaPhoneNumberInfo getPhoneNumber(String code)
                            throws WxErrorException

获取手机号信息,基础库:2.21.2及以上或2023年8月28日起

参数:

code - 每个code只能使用一次，code的有效期为5min。code获取方式参考手机号快速验证组件

返回:

用户手机号信息

抛出:

WxErrorException - .

getPhoneNoInfo

@Deprecated
WxMaPhoneNumberInfo getPhoneNoInfo(String code)
                                        throws WxErrorException

已过时。

获取手机号信息,基础库:2.21.2及以上或2023年8月28日起

参数:

code - 每个code只能使用一次，code的有效期为5min。code获取方式参考手机号快速验证组件

返回:

用户手机号信息

抛出:

WxErrorException - .

checkUserInfo

boolean checkUserInfo(String sessionKey,
                      String rawData,
                      String signature)

验证用户信息完整性.

参数:

sessionKey - 会话密钥

rawData - 微信用户基本信息

signature - 数据签名

返回:

.

getCode2VerifyInfo

WxMaCode2VerifyInfoResult getCode2VerifyInfo(String code,
                                             String checkcode)
                                      throws WxErrorException

多端登录验证接口.

通过 code 换取用户登录态信息，用于多端登录场景（如手表端）。

文档地址：多端登录

参数:

code - 登录时获取的 code

checkcode - 手表授权页面返回的 checkcode

返回:

登录验证结果，包含 session_key、openid、unionid 和 is_limit 字段

抛出:

WxErrorException - 调用微信接口失败时抛出