# 实例属性及方法
注意事项
使用 new DHMiniSDK(options) 进行SDK初始化时,将返回一个实例对象,本文档暂且将该实例命名为 sdkInstance,后续章节内容及示例代码均基于此命名进行说明或演示,谢谢!
# 实例属性
SDK实例属性如下表所示:
| 属性 | 类型 | 说明 |
|---|---|---|
| version | string | SDK的版本号,如 2.0.0 |
| system | object | 系统信息,详情请参考 wx.getSystemInfoSync() 接口文档 |
| system.platform | string | 客户端设备类型
|
| networkType | string | 网络类型,详情请参考 wx.getNetworkType() 接口文档 |
| deviceId | string | 设备唯一标识(注意,因SDK无法获取真实的设备唯一标识,故使用一个32位随机字符串作为设备唯一标识,并存储于客户端缓存中;后续进入小游戏,若有缓存则从缓存中获取,无缓存则重新生成并存入缓存;因此无法确保设备唯一标识的准确性) |
| deviceOS | string | 设备类型
|
| launchOptions | object | 游戏的启动参数,详情请参考 wx.getLaunchOptionsSync() 接口文档 |
| gameAppId | string | 游戏在微信侧的 AppID |
| appId | string | 游戏在SDK开放平台侧的 AppID |
| appVersion | string | 游戏的版本号,如 2.0.4.10 |
| packageName | string | 游戏的应用包名,如 com.dianhun.abc |
| channel | number | 游戏渠道包ID,如 1398 |
| mainChannel | number | 推广主渠道ID,如 100708 |
| secondChannel | number | 推广次渠道ID,如 100709 |
| userInfo | object | 用户信息(用户于SDK开放平台侧的登录信息),仅在登录成功后可用 |
| userInfo.accountId | number | 账号ID |
| userInfo.accountName | string | 账号名称 |
| userInfo.accountView | string | 账号缩略 |
| userInfo.expireTimestamp | number | 登录态过期时间,秒级时间戳 |
| userInfo.loginTimestamp | number | 登录时间,秒级时间戳 |
| userInfo.loginType | number | 登录类型 |
| userInfo.region | number | 所属地区,1 表示中国大陆,0 表示港澳台及海外 |
| userInfo.sign | string | 签名(本地验签使用) |
| userInfo.token | string | 登录token |
| userInfo.userExtraInfo | object | 用户扩展信息(用户于第三方渠道侧的登录信息) |
| userInfo.userExtraInfo.openId | string | 用户在微信侧的唯一标识(openId) |
# 实例方法
SDK实例方法如下表所示:
| 方法 | 类型 | 说明 |
|---|---|---|
| login | function | 用于执行登录并获取SDK开放平台用户信息,详情请查看本文档后续章节 |
| uploadRoleInfo | function | 用于在用户登录游戏服成功、创角成功、角色升级时上报相关角色信息,详情请查看本文档后续章节 |
| createUserInfoButton | function | 用于创建微信用户信息获取按钮,详情请查看本文档后续章节 |
| getUserInfo | function | 用于获取微信用户信息,详情请查看本文档后续章节 |
| getUserData | function | 用于获取玩家基础信息,详情请查看本文档后续章节 |
| pay | function | 用于发起支付流程,详情请查看本文档后续章节 |
| createRewardedVideoAd | function | 用于创建激励视频广告,详情请查看本文档后续章节 |
| checkMsgSecurity | function | 用于文本内容安全识别,详情请查看本文档后续章节 |
| checkImgSecurity | function | 用于图片内容安全识别,详情请查看本文档后续章节 |
| checkMediaSecurity | function | 用于音频内容安全识别,详情请查看本文档后续章节 |
| openSurvey | function | 用于跳转至问卷调查,详情请查看本文档后续章节 |
| openCustomerService | function | 用于跳转至H5客服,详情请查看本文档后续章节 |
| createFeedbackButton | function | 用于创建意见反馈按钮,详情请查看本文档后续章节 |
| openChannelsUserProfile | function | 用于打开视频号主页,详情请查看本文档后续章节 |
| openChannelsEvent | function | 用于打开视频号活动页,详情请查看本文档后续章节 |
| openChannelsActivity | function | 用于打开视频号视频,详情请查看本文档后续章节 |
| openChannelsLive | function | 用于打开视频号直播,详情请查看本文档后续章节 |
| reserveChannelsLive | function | 用于预约视频号直播,详情请查看本文档后续章节 |
| getChannelsLiveNoticeInfo | function | 用于获取视频号直播预告信息,详情请查看本文档后续章节 |
| getChannelsLiveInfo | function | 用于获取视频号直播信息,详情请查看本文档后续章节 |
| createGameClubButton | function | 用于创建游戏圈按钮,详情请查看本文档后续章节 |
| shareImageToGameClub | function | 用于分享网络图片到游戏圈,详情请查看本文档后续章节 |
| shareCanvasToGameClub | function | 用于分享Canvas截图到游戏圈,详情请查看本文档后续章节 |
| getGameClubData | function | 用于获取游戏圈数据,详情请查看本文档后续章节 |
| getGameRecorder | function | 用于创建并返回一个全局单例的游戏对局回放录制器,详情请查看本文档后续章节 |
| shareGameRecorderVideo | function | 用于分享游戏对局回放,详情请查看本文档后续章节 |
| createGameRecorderShareButton | function | 用于创建分享游戏对局回放按钮,详情请查看本文档后续章节 |
| setShare | function | 用于启用游戏右上角•••菜单中的「转发给朋友」及「分享到朋友圈」按钮,详情请查看本文档后续章节 |
| share | function | 用于主动唤起微信通讯录列表选择好友进行分享,详情请查看本文档后续章节 |
| showShareImageMenu | function | 用于打开分享图片弹窗,将自定义图片转发给朋友、收藏或保存到相册,详情请查看本文档后续章节 |
| subscribeMessage | function | 用于打开订阅消息界面,返回用户订阅消息的操作结果,详情请查看本文档后续章节 |
| subscribeSystemMessage | function | 用于打开系统订阅消息界面,返回用户订阅消息的操作结果,详情请查看本文档后续章节 |
| openSetting | function | 用于打开设置界面,返回用户设置的操作结果 |
| getSetting | function | 用于获取用户的当前设置 |
| getAccountId | function | 用于获取用户的账号ID,未登录状态下返回值为空 |
| getOpenId | function | 用于获取用户的微信openId,未登录状态下返回值为空 |
| trackEvent | function | 用于上报并记录用户在游戏内的行为日志&事件,详情请查看本文档后续章节 |