# 实例属性及方法

注意事项

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

# 实例属性

SDK实例属性如下表所示:

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

客户端设备类型

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

设备类型

  • minigame_android
  • minigame_ios
  • minigame_devtools
launchOptions object 游戏的启动参数,详情请参考 tt.getLaunchOptionsSync() 接口文档
gameAppId string 游戏在抖音侧的 AppID
appId string 游戏在SDK开放平台侧的 AppID
appVersion string 游戏的版本号,如 2.0.4.10
packageName string 游戏的应用包名,如 com.dianhun.abc
channel number 游戏渠道包ID,如 3438
mainChannel number 推广主渠道ID,如 100774
secondChannel number 推广次渠道ID,如 100775
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)
        userInfo.userExtraInfo.userName string 用户在抖音侧的账号名称
        userInfo.userExtraInfo.avatar string 用户在抖音侧的头像
        userInfo.userExtraInfo.nickName string 用户在抖音侧的昵称

# 实例方法

SDK实例方法如下表所示:

方法 类型 说明
login function 用于执行登录并获取SDK开放平台用户信息,详情请查看本文档后续章节
uploadRoleInfo function 用于在用户登录游戏服成功、创角成功、角色升级时上报相关角色信息,详情请查看本文档后续章节
getUserInfo function 用于获取抖音用户信息,详情请查看本文档后续章节
pay function 用于发起支付流程,详情请查看本文档后续章节
createRewardedVideoAd function 用于创建激励视频广告,详情请查看本文档后续章节
openCustomerServiceConversation function 用于打开客服会话,详情请查看该文档后续章节
createContactButton function 用于创建客服会话按钮,详情请查看该文档后续章节
getGameRecorder function 用于创建并返回一个全局单例的游戏对局回放录制器,详情请查看本文档后续章节
shareGameRecorderVideo function 用于分享游戏对局回放,详情请查看本文档后续章节
setShare function 用于启用游戏右上角•••菜单中的分享按钮,详情请查看本文档后续章节
share function 用于主动拉起抖音发布器进行分享,详情请查看本文档后续章节
checkScene function 用于判断当前宿主环境是否支持跳转至侧边栏,详情请查看本文档后续章节
navigateToScene function 用于跳转至侧边栏,详情请查看本文档后续章节
openSetting function 用于打开设置界面,返回用户设置的操作结果
getSetting function 用于获取用户的当前设置
getAccountId function 用于获取用户的账号ID,未登录状态下返回值为空
getOpenId function 用于获取用户的抖音openId,未登录状态下返回值为空
trackEvent function 用于上报并记录用户在游戏内的行为日志&事件,详情请查看本文档后续章节
Last Updated: 2024/12/25 15:04:01