抖音开放平台Logo
控制台

tt.exitMiniProgram
收藏
我的收藏

基础库 1.12.0 开始支持本方法,这是一个异步方法。

退出当前小游戏到后台。

前提条件
业务背景
使用限制
注意事项
  • 调用该方法的预期表现会将小游戏切后台,并不会完全退出小游戏(在 IDE 预览版本表现可能会不一致)。
  • 正常调用 exitMiniProgram 退出小游戏时,小游戏实际行为和切后台一致,并不会完全关闭小游戏,再次打开小游戏将立即返回之前的状态。在传入 isFullExit 时,将完全关闭小游戏,下次打开会重新加载打开小游戏。
  • isFullExit 为 true 会导致下次打开小游戏的时间变长。
相关教程

语法

tt.exitMiniProgram(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
isFullExitbooleanfalse

是否完全关闭小游戏,当该值为 true 时,会完全关闭小游戏,下次打开将重新进入

1.12.0
successfunction
接口调用成功的回调函数
1.12.0
failfunction
接口调用失败的回调函数
1.12.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
1.12.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"exitMiniProgram:ok"
1.12.0

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"exitMiniProgram:fail" + 详细错误信息
1.12.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.exitMiniProgram({
  success(res) {
    console.log("调用成功", res.data);
  },
  fail(res) {
    console.log("调用失败", res.errMsg);
  },
});