# 实例属性及方法

注意事项

使用 new DHMiniSDK(options) 进行SDK初始化时,将返回一个实例对象,本文档暂且将该实例命名为 sdkInstance,后续章节内容及示例代码均基于此命名进行说明或演示,谢谢!

# 实例属性

SDK实例属性如下表所示:

属性 类型 说明
version string SDK的版本号,如 2.0.0
system object 系统信息,详情请参考 my.getSystemInfoSync() 接口文档
    system.platform string

客户端设备类型

  • android - Android支付宝
  • ios - iOS支付宝
  • ohos - 鸿蒙支付宝
networkType string 网络类型,详情请参考 my.getNetworkType() 接口文档
deviceId string 设备唯一标识(注意,因SDK无法获取真实的设备唯一标识,故使用一个32位随机字符串作为设备唯一标识,并存储于客户端缓存中;后续进入小游戏,若有缓存则从缓存中获取,无缓存则重新生成并存入缓存;因此无法确保设备唯一标识的准确性)
deviceOS string

设备类型

  • minigame_android
  • minigame_ios
  • minigame_ohos
launchOptions object 游戏的启动参数,详情请参考 my.getLaunchOptionsSync() 接口文档
gameAppId string 游戏在支付宝侧的 AppID
appId string 游戏在SDK开放平台侧的 AppID
appVersion string 游戏的版本号,如 2.0.4.10
packageName string 游戏的应用包名,如 com.dianhun.abc
channel number 游戏渠道包ID,如 3548
mainChannel number 推广主渠道ID,如 101424
secondChannel number 推广次渠道ID,如 101425
userInfo object 用户信息(用户于SDK开放平台侧的登录信息),仅在登录成功后可用
    userInfo.accountId number 账号ID
    userInfo.accountName string 账号名称
    userInfo.accountView string 账号缩略
    userInfo.region number 所属地区,1 表示中国大陆,0 表示港澳台及海外
    userInfo.loginType number 登录类型
    userInfo.loginTimestamp number 登录时间,秒级时间戳
    userInfo.expireTimestamp number 登录态过期时间,秒级时间戳
    userInfo.token string 登录token
    userInfo.sign string 签名(本地验签使用)
    userInfo.userExtraInfo object 用户扩展信息(用户于第三方渠道侧的登录信息)
        userInfo.userExtraInfo.openId string 用户在支付宝侧的唯一标识(openId)

# 实例方法

SDK实例方法如下表所示:

方法 类型 说明
login function 用于执行登录并获取SDK开放平台用户信息,详情请查看本文档后续章节
getAccountId function 用于获取用户的账号ID,未登录状态下返回值为空
getOpenId function 用于获取用户的支付宝openId,未登录状态下返回值为空
getToken function 用于获取用户的登录token,未登录状态下返回值为空
isRegister function 用于获取用户的账号是否为首次注册,未登录状态下返回值为false
getUserInfo function 用于获取支付宝用户信息,详情请查看本文档后续章节
pay function 用于发起支付流程,详情请查看本文档后续章节
createRewardedAd function 用于创建激励广告,详情请查看本文档后续章节
checkHomepage function 用于判断游戏中心是否可被添加到支付宝首页,详情请查看本文档后续章节
addToHomepage function 用于将游戏中心添加到支付宝首页,详情请查看本文档后续章节
checkShortcut function 用于判断有无桌面快捷方式权限,详情请查看本文档后续章节
addShortcut function 用于将小游戏快捷方式添加到手机桌面上,详情请查看本文档后续章节
isLaunchFromShortcut function 用于判断小游戏是否从桌面快捷方式启动,详情请查看本文档后续章节
setShare function 用于启用游戏右上角•••菜单中的分享按钮,详情请查看本文档后续章节
share function 用于主动唤起支付宝分享面板进行分享,详情请查看本文档后续章节
createGameClubButton function 用于创建游戏圈按钮,详情请查看本文档后续章节
getGameClubData function 用于获取游戏圈数据,详情请查看本文档后续章节
getSetting function 用于获取用户的当前设置,返回值中只会出现游戏已经向用户请求过的权限
openSetting function 用于打开用户设置界面,返回用户设置的操作结果,设置界面只会出现游戏已经向用户请求过的权限
showAuthGuide function 用于弹出图文提示对话框,引导用户打开并授予支付宝指定权限
uploadRoleInfo function 用于在用户登录游戏服成功、创角成功、角色升级或充值成功时上报相关角色信息,详情请查看本文档后续章节
bindThirdPlatform function 用于绑定第三方平台,如数数BI,详情请查看本文档后续章节
trackEvent function 用于上报并记录用户在游戏内的行为日志&事件,详情请查看本文档后续章节
Last Updated: 2026/4/27 16:36:20