搜索
开发文档
应用开发
快应用开发
小游戏开发
开发文档/小游戏开发/开发指南/接口/基础
基础更新时间: 2024-09-19 00:16:00

一、触摸事件

window.removeEventListener("touchcancel", Function callback)

取消监听触点失效事件
示例代码

window.addEventListener("touchcancel", (event)=>{
console.log("touchcancel",event)
})

window.addEventListener("touchcancel", Function callback, false)

监听触点失效事件

window.removeEventListener("touchend",Function callback)

取消监听触摸结束事件

window.addEventListener("touchend", Function callback, false)

监听触摸结束事件

window.removeEventListener("touchmove", Function callback)

取消监听触点移动事件

window.addEventListener("touchmove", Function callback, false)

监听触点移动事件

window.removeEventListener("touchstart", Function callback)

取消监听开始触摸事件

window.addEventListener("touchstart", Function callback, false)

监听开始触摸事件

二、定时器

Number setTimeout(Function callback, Number delay, Any rest)

设定一个定时器,在定时到期以后执行注册的回调函数,返回一个定时器的编号。这个值可以传递给 clearTimeout 来取消该定时。
callback
回调函数
delay
延迟的时间,函数的调用会在该延迟之后发生,单位 ms。
rest
param1, param2, ..., paramN 等附加参数,它们会作为参数传递给回调函数。

clearTimeout(Number timeoutID)

可取消由setTimeout() 方法设置的定时器。
timeoutID
要取消的定时器的 ID

Number setInterval(Function callback, Number delay, Any rest)

设定一个定时器,按照指定的周期(以毫秒计)来执行注册的回调函数, 返回一个定时器的编号。这个值可以传递给 clearInterval 来取消该定时。
callback
回调函数
delay
执行回调函数之间的时间间隔,单位 ms。
rest
param1, param2, ..., paramN 等附加参数,它们会作为参数传递给回调函数。

clearInterval(Number intervalID)

可取消由 setInterval() 方法设置的定时器。
intervalID
要取消的定时器的 ID

三、更新

UpdateManager qg.getUpdateManager() (1060+)

获取全局唯一的版本更新管理器,用于管理快游戏更新。

UpdateManager.applyUpdate() (1060+)

强制快游戏重启并使用新版本。在快游戏新版本下载完成后(即收到 onUpdateReady 回调)调用。

UpdateManager.onCheckForUpdate(function callback) (1060+)

监听请求检查更新结果事件。在快游戏冷启动时自动检查更新,不需由开发者主动触发。

示例代码

let updateManager = qg.getUpdateManager()
updateManager.onCheckForUpdate((res) => {
console.log('onCheckForUpdate', res)
})

参数 function callback
请求检查更新结果事件的回调函数

属性类型说明最低版本
hasUpdateboolean是否有新版本1060

UpdateManager.onUpdateReady(function callback) (1060+)

监听快游戏有版本更新事件。客户端主动触发下载(无需开发者触发),下载成功后回调
参数 function callback
快游戏有版本更新事件的回调函数

UpdateManager.onUpdateFailed(function callback) (1060+)

监听快游戏更新失败事件。快游戏有新版本,客户端主动触发下载(无需开发者触发),下载失败(可能是网络原因等)后回调
参数 function callback
快游戏更新失败事件的回调函数

四、生命周期

qg.exitApplication(Object object)

退出当前小游戏

调用exitApplication后还会再触发onHide
参数 Object object

属性类型默认值必填说明
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

qg.onShow(Function callback)

监听游戏切入前台事件
callback
非必须,接收前台事件回调

  • callback回调函数的参数 Object res
属性类型说明
queryObject快游戏启动时的query
referrerInfoObject快游戏启动来源,可能为{}

  • referrerInfo
属性类型说明
packageString来源快应用或快游戏或App的包名
extraDataObject来源快应用或快游戏或App的数据

qg.offShow(Function callback)

取消监听游戏切入前台
callback
非必须,需要取消的监听回调,为空时取消所有监听

qg.onHide(Function callback)

监听游戏切入后台事件
callback
必须,接收后台事件回调

qg.offHide(Function callback)

取消监听游戏切入后台事件
callback
需要取消的监听回调,参数为空,将取消所有监听

Object qg.getLaunchOptionsSync()

获取快游戏启动时的参数,该函数没有参数,返回值可能是Object、Undefined类型的
返回值

属性类型说明
queryObject快游戏启动时的query
referrerInfoObject快游戏启动来源,可能为{}

  • 返回值属性referrerInfo
参数名类型说明
packageString来源快应用或快游戏或App的包名
extraDataObject来源快应用或快游戏或App的数据

五、性能

Performance qg.getPerformance()

获取性能管理器

Number Performance.now()

可以获取当前时间以微秒为单位的时间戳

qg.triggerGC()

加快触发 JavaScript VM 进行(垃圾回收),GC 时机是由 JavaScript VM 来控制的,并不能保证调用后马上触发 GC。

六、系统

qg.getSystemInfo(Object object)

获取系统信息
参数 Object object

属性类型必填说明
successFunction(Object res)成功回调
failFunction失败回调
completeFunction执行结束后的回调

  • success回调函数的参数 Object res
属性类型说明最低版本
brandString设备品牌
modelString设备型号
systemString操作系统名称,如"Android 8.1.0"
platformVersionNameString运行平台版本名称
platformVersionCodeNumber运行平台标准版本号,如"1040"
languageString系统语言
screenWidthNumber屏幕宽
screenHeightNumber屏幕高
pixelRatioNumber设备像素比
windowHeightNumber可使用窗口高度
windowWidthNumber可使用窗口宽度
statusBarHeightNumber状态栏/异形缺口高度
safeAreaObject在竖屏正方向下的安全区域1051

  • res.safeArea 的结构
属性类型说明
leftnumber安全区域左上角横坐标
rightnumber安全区域右下角横坐标
topnumber安全区域左上角纵坐标
bottomnumber安全区域右下角纵坐标
widthnumber安全区域的宽度,单位逻辑像素
heightnumber安全区域的高度,单位逻辑像素

示例代码

qg.getSystemInfo({
success: function (data) {
console.info('getSystemInfo success', data)
},
fail: function (err) {
console.info('getSystemInfo fail', err)
},
complete: function () {
console.info('getSystemInfo complete', )
},
})

Object qg.getSystemInfoSync()

获取系统信息的同步版本
返回值

属性类型说明最低版本
brandString设备品牌
modelString设备型号
systemString操作系统名称,如"Android 8.1.0"
platformVersionNameString运行平台版本名称
platformVersionCodeNumber运行平台标准版本号,如"1040"
languageString系统语言
screenWidthNumber屏幕宽
screenHeightNumber屏幕高
pixelRatioNumber设备像素比
windowHeightNumber可使用窗口高度
windowWidthNumber可使用窗口宽度
statusBarHeightNumber状态栏/异形缺口高度
safeAreaObject在竖屏正方向下的安全区域1051

  • res.safeArea 的结构
属性类型说明
leftnumber安全区域左上角横坐标
rightnumber安全区域右下角横坐标
topnumber安全区域左上角纵坐标
bottomnumber安全区域右下角纵坐标
widthnumber安全区域的宽度,单位逻辑像素
heightnumber安全区域的高度,单位逻辑像素

七、桌面图标

Shortcut qg.getShortcut()

获取Shortcut对象
Shortcut

属性类型必填说明
hasInstalledString键盘输入框显示的默认值
installNumber键盘中文本的最大长度

Shortcut.hasInstalled(Object object)

桌面图标是否创建
参数 Object object

属性类型必填说明
successFunction (Boolean)接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

Shortcut.install(Object object)

创建桌面图标
参数 Object object

属性类型必填说明
messageString弹窗内的描述文本信息
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

示例代码

  const shortcut = qg.getShortcut()
shortcut.install({
message: '创建桌面图标',
success () {
shortcut.hasInstalled({
success (hasInstalled) {
if (!hasInstalled) {
console.error('桌面图标未创建成功')
}
},
fail () {
console.error('桌面图标建失败')
},
complete () {
console.log('桌面图标建完成')
}
})
}
})

上一篇:
下一篇: