API

基础接口

系统

接口	功能说明
ks.getSystemInfo	异步获取平台基础信息
ks.getSystemInfoSync	同步获取平台基础信息
ks.getSystemInfoAsync	异步获取系统信息

生命周期

接口	功能说明
ks.getLaunchOptionsSync	同步获取启动参数
ks.onShow	监听小游戏回到前台事件
ks.onHide	监听小游戏隐藏到后台事件
ks.offShow	取消监听小游戏回到前台事件
ks.offHide	取消监听小游戏隐藏到后台事件
ks.exitMiniProgram	退出当前小游戏

触摸事件

接口	功能说明
ks.onTouchStart	监听开始触摸事件
ks.onTouchMove	监听触点移动事件
ks.onTouchEnd	监听触摸结束事件
ks.onTouchCancel	监听触点失效事件
ks.offTouchStart	取消监听开始触摸事件
ks.offTouchMove	取消监听触点移动事件
ks.offTouchEnd	取消监听触摸结束事件
ks.offTouchCancel	取消监听触点失效事件
Touch	在触控设备上的触摸点

渲染

接口	功能说明
ks.createCanvas	创建一个画布对象
ks.setPreferredFramesPerSecond	修改渲染帧率
ks.loadFont	加载自定义字体文件
ks.createImage	创建一个图片对象
Image	图片对象
Canvas	画布对象
Canvas.getContext	获取画布对象的绘图上下文

激励视频广告

接口	功能说明
ks.createRewardedVideoAd	获取全局激励视频广告组件
RewardedVideoAd	激励视频广告组件
RewardedVideoAd.destroy	销毁激励视频广告实例
RewardedVideoAd.offClose	取消监听激励视频关闭事件
RewardedVideoAd.offError	取消监听激励视频错误事件
RewardedVideoAd.onClose	监听激励视频关闭事件
RewardedVideoAd.onError	监听激励视频错误事件
RewardedVideoAd.show	显示激励视频广告

插屏广告

接口	功能说明
ks.createInterstitialAd	获取插屏广告组件
InterstitialAd	插屏广告组件
InterstitialAd.destroy	销毁插屏广告实例
InterstitialAd.offClose	取消监听插屏关闭事件
InterstitialAd.offError	取消监听插屏错误事件
InterstitialAd.onClose	监听插屏关闭事件
InterstitialAd.onError	监听插屏错误事件
InterstitialAd.show	显示插屏广告

界面

交互

接口	功能说明
ks.showToast	显示消息提示框
ks.showModal	显示模态对话框
ks.showLoading	显示 loading 提示框。需主动调用 ks.hideLoading 才能关闭提示框
ks.showActionSheet	显示操作菜单
ks.hideToast	隐藏消息提示框
ks.hideLoading	隐藏 loading 提示框

网络

发起请求

接口	功能说明
ks.request	发起 HTTPS 网络请求
RequestTask	网络请求任务对象
RequestTask.abort	中断请求任务

下载

接口	功能说明
ks.downloadFile	下载文件资源到本地
DownloadTask	一个可以监听下载进度变化事件，以及取消下载任务的对象
DownloadTask.abort	中断下载任务
DownloadTask.offProgressUpdate	取消监听下载进度变化事件
DownloadTask.onProgressUpdate	监听下载进度变化事件

上传

接口	功能说明
ks.uploadFile	上传本地资源到服务器
UploadTask	一个可以监听上传进度变化事件，以及取消上传任务的对象
UploadTask.abort	中断上传任务
UploadTask.offProgressUpdate	取消监听上传进度变化事件
UploadTask.onProgressUpdate	监听上传进度变化事件

WebSocket

接口	功能说明
ks.connectSocket	创建一个 WebSocket 连接
SocketTask.close	关闭 WebSocket 连接
SocketTask.onClose	监听 WebSocket 连接关闭事件
SocketTask.onError	监听 WebSocket 错误事件
SocketTask.onMessage	监听 WebSocket 接受到服务器的消息事件
SocketTask.onOpen	监听 WebSocket 连接打开事件
SocketTask.send	通过 WebSocket 连接发送数据
SocketTask	WebSocket 任务

转发

接口	功能说明
ks.shareAppMessage	主动拉起转发，进入选择通讯录界面。

虚拟支付

接口	功能说明
ks.requestGamePayment	支付接口

数据缓存

接口	功能说明
ks.setStorage	将数据存储在本地缓存中指定的 key 中
ks.setStorageSync	ks.setStorage 的同步版本
ks.removeStorage	从本地缓存中移除指定 key。
ks.removeStorageSync	ks.removeStorage 的同步版本
ks.getStorageInfo	异步获取当前storage的相关信息
ks.getStorageSync	ks.getStorage的同步版本
ks.getStorageInfoSync	ks.getStorageInfo的同步版本
ks.getStorage	从本地缓存中异步获取指定 key 的内容
ks.clearStorage	清理本地数据缓存
ks.clearStorageSync	ks.clearStorage的同步版本

媒体

音频

接口	功能说明
ks.createInnerAudioContext	创建内部 audio 上下文 InnerAudioContext 对象
InnerAudioContext	InnerAudioContext 实例
InnerAudioContext.destroy	销毁当前实例
InnerAudioContext.offCanplay	取消监听音频进入可以播放状态的事件
InnerAudioContext.offEnded	取消监听音频自然播放至结束的事件
InnerAudioContext.offError	取消监听音频播放错误事件
InnerAudioContext.offPause	取消监听音频暂停事件
InnerAudioContext.offPlay	取消监听音频播放事件
InnerAudioContext.offStop	取消监听音频停止事件
InnerAudioContext.onCanplay	监听音频进入可以播放状态的事件。但不保证后面可以流畅播放
InnerAudioContext.onEnded	监听音频自然播放至结束的事件
InnerAudioContext.onError	监听音频播放错误事件
InnerAudioContext.onPause	监听音频暂停事件
InnerAudioContext.onPlay	监听音频播放事件
InnerAudioContext.onStop	监听音频停止事件
InnerAudioContext.pause	暂停。暂停后的音频再播放会从暂停处开始播放
InnerAudioContext.play	播放
InnerAudioContext.seek	跳转到指定位置
InnerAudioContext.stop	停止。停止后的音频再播放会从头开始播放。

图片

接口	功能说明
ks.chooseImage	从本地相册选择图片或使用相机拍照
ks.saveImageToPhotosAlbum	保存图片到系统相册

文件

接口	功能说明
ks.getFileSystemManager	获取全局唯一的文件管理器
Stats	描述文件状态的对象
Stats.isDirectory	判断当前文件是否一个目录
Stats.isFile	判断当前文件是否一个普通文件
FileSystemManager	文件管理器
FileSystemManager.access	判断文件/目录是否存在
FileSystemManager.accessSync	FileSystemManager.access 的同步版本
FileSystemManager.appendFile	在文件结尾追加内容
FileSystemManager.appendFileSync	FileSystemManager.appendFile的同步版本
FileSystemManager.copyFile	复制文件
FileSystemManager.copyFileSync	FileSystemManager.copyFile 的同步版本
FileSystemManager.getFileInfo	获取该小游戏下的本地文件信息
FileSystemManager.mkdir	创建目录
FileSystemManager.mkdirSync	FileSystemManager.mkdir的同步版本
FileSystemManager.readdir	读取目录内文件列表
FileSystemManager.readdirSync	FileSystemManager.readdir的同步版本
FileSystemManager.readFile	读取本地文件内容
FileSystemManager.readFileSync	FileSystemManager.readFile的同步版本
FileSystemManager.rename	重命名文件。可以把文件从 oldPath 移动到 newPath
FileSystemManager.renameSync	FileSystemManager.rename的同步版本
FileSystemManager.rmdir	删除目录
FileSystemManager.rmdirSync	FileSystemManager.rmdir的同步版本
FileSystemManager.saveFile	保存临时文件到本地。此接口会移动临时文件，因此调用成功后，tempFilePath 将不可用。
FileSystemManager.saveFileSync	FileSystemManager.saveFile 的同步版本
FileSystemManager.stat	获取文件 Stats 对象
FileSystemManager.statSync	FileSystemManager.stat的同步版本
FileSystemManager.unlink	删除文件
FileSystemManager.unlinkSync	FileSystemManager.unlink的同步版本
FileSystemManager.unzip	解压文件
FileSystemManager.writeFile	写文件
FileSystemManager.writeFileSync	FileSystemManager.writeFile的同步版本

开放接口

用户信息

接口	功能说明
ks.getUserInfo	获取用户信息

登录

接口	功能说明
ks.login	调用接口获取登录凭证

授权

接口	功能说明
ks.authorize	向用户发起授权请求
ks.getSetting	异步获取当前用户的权限设置

设备

设备方向

接口	功能说明
ks.stopDeviceMotionListening	停止监听设备方向的变化
ks.startDeviceMotionListening	开始监听设备方向的变化
ks.onDeviceMotionChange	监听设备方向变化事件
ks.offDeviceMotionChange	取消监听设备方向变化事件，参数为空，则取消所有的事件监听

键盘

接口	功能说明
ks.updateKeyboard	更新键盘输入框内容。只有当键盘处于拉起状态时才会产生效果
ks.showKeyboard	显示键盘
ks.onKeyboardInput	监听键盘输入事件
ks.onKeyboardConfirm	监听用户点击键盘 Confirm 按钮时的事件
ks.onKeyboardComplete	监听监听键盘收起的事件
ks.offKeyboardInput	取消监听键盘输入事件
ks.offKeyboardConfirm	取消监听用户点击键盘 Confirm 按钮时的事件
ks.offKeyboardComplete	取消监听监听键盘收起的事件
ks.hideKeyboard	隐藏键盘

加速计

接口	功能说明
ks.stopAccelerometer	停止监听加速度数据
ks.startAccelerometer	开始监听加速度数据
ks.onAccelerometerChange	监听加速度数据事件
ks.offAccelerometerChange	取消监听加速度数据事件，参数为空，则取消所有的事件监听

罗盘

接口	功能说明
ks.stopCompass	停止监听罗盘数据
ks.startCompass	开始监听罗盘数据
ks.onCompassChange	监听罗盘数据事件
ks.offCompassChange	取消监听罗盘数据事件，参数为空，则取消所有的事件监听

网络

接口	功能说明
ks.getNetworkType	获取设备当前所处的网络类型
ks.onNetworkStatusChange	监听网络状态变化事件
ks.offNetworkStatusChange	移除网络状态变化事件的监听函数

陀螺仪

接口	功能说明
ks.stopGyroscope	停止监听陀螺仪数据
ks.startGyroscope	开始监听陀螺仪数据
ks.onGyroscopeChange	监听陀螺仪数据事件
ks.offGyroscopeChange	取消监听陀螺仪数据事件，参数为空，则取消所有的事件监听

性能

接口	功能说明
ks.onMemoryWarning	监听内存不足告警事件
ks.offMemoryWarning	取消监听内存不足告警事件

振动

接口	功能说明
ks.vibrateShort	使手机发生较短时间的振动
ks.vibrateLong	使手机发生较长时间的振动

游戏对局回放

接口	功能说明
ks.getGameRecorder	获取全局唯一的游戏画面录制对象
GameRecorder	游戏画面录制对象
GameRecorder.abort	放弃录制游戏画面，此时已经录制的内容会被丢弃
GameRecorder.off	取消监听录制事件。当对应事件触发时，该回调函数不再执行
GameRecorder.on	注册监听录制事件的回调函数。当对应事件触发时，回调函数会被执行
GameRecorder.pause	暂停录制游戏画面
GameRecorder.resume	恢复录制游戏画面
GameRecorder.start	开始录制游戏画面
GameRecorder.stop	结束录制游戏画面。结束录制后可以发起分享
GameRecorder.publishVideo	发布录屏到快手

添加到桌面接口

接口	功能说明
ks.addShortcut	添加小游戏快捷方式到手机桌面
ks.checkShortcut	检查小游戏快捷方式是否已添加到手机桌面上
ks.isLaunchFromShortcut	查询游戏是否从桌面快捷方式启动

侧边栏复访接口

接口	功能说明
ks.checkSliderBarIsAvailable	小游戏侧边栏是否可用

官方号、CP服务号相关API

接口	功能说明
ks.checkFollowState	查看关注官方帐号状态
ks.openUserProfile	打开官方帐号profile