抖音开放平台Logo
控制台

tt.enableAlertBeforeUnload
收藏
我的收藏

基础库 2.63.0 开始支持本方法，低版本需做兼容处理，这是一个异步方法。

开启小程序页面返回询问对话框。 当用户在小程序非最底层页面点击左上角返回按钮、左上角首页按钮或 Android 系统 back 键时,弹起询问弹窗

前提条件无
业务背景无
使用限制无
注意事项
  • Tip：返回询问对话框只会对调用的当前页面生效；
  • Tip：通过手势滑动返回时不会弹起询问对话框。
支持沙盒
否
相关教程无

语法

tt.enableAlertBeforeUnload(options)

参数说明

options 为 object 类型，属性如下：

属性名类型默认值必填说明最低支持版本
messagestring确认返回上一级吗否
询问对话框内容，最多 50 个中文字符
2.63.0
confirmTextstring确定否
确定按钮的文案，最多 4 个中文字符
2.63.0
cancelTextstring取消否
取消按钮的文案，最多 4 个中文字符
2.63.0
successfunction否
接口调用成功的回调函数
2.63.0
failfunction否
接口调用失败的回调函数
2.63.0
completefunction否
接口调用结束的回调函数（调用成功、失败都会执行）
2.63.0

回调成功

object 类型，属性如下：

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

回调失败

object 类型，属性如下：

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

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.enableAlertBeforeUnload({
  message: "是否确认返回",
  success(res) {
    console.log("开启页面返回询问对话框成功", res);
  },
  fail(err) {
    console.log("开启页面返回询问对话框失败", err);
  },
});