tt.showFavoriteGuide
收藏我的收藏
收藏基础库 1.41.0 开始支持本方法，这是一个异步方法。该API对iOS宿主有版本限制：抖音（16.1 ～ 25.7.0）、抖音Lite（16.8 ～ 26.8.0 ）可用，其他版本不可用。
在小程序内调起关注小程序的引导组件，用于引导用户关注小程序。
语法
tt.showFavoriteGuide(options)
参数说明
options 为 object 类型，属性如下：
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
type | string | bar | 否 | 引导组件类型，可以是 bar（底部弹窗）、tip（顶部气泡） | 1.41.0 |
content | string | 一键添加到我的小程序 | 否 | 弹窗文案，最多显示 12 个字符 | 1.41.0 |
position | string | bottom | 否 | 弹窗类型为 bar 时的位置参数，可以是 bottom（贴近底部）、overtab（悬于页面 tab 区域上方） | 1.41.0 |
success | function | | 否 | 接口调用成功后的回调函数 | 1.41.0 |
fail | function | | 否 | 接口调用失败后的回调函数 | 1.41.0 |
complete | function | | 否 | 接口调用结束后的回调函数（调用成功、失败都会执行） | 1.41.0 |
回调成功
object 类型，属性如下：
属性名 | 类型 | 说明 | 最低支持版本 |
errMsg | string | "showFavoriteGuide:ok" | 1.41.0 |
回调失败
object 类型，属性如下：
属性名 | 类型 | 说明 | 最低支持版本 |
errMsg | string | "showFavoriteGuide:fail " + 详细错误信息 | 1.41.0 |
扫码体验
代码示例
目前小程序收藏引导组件支持以下两种类型，开发者可根据自身业务进行选择：
/** * 当 type = 'tip' 时，弹出的引导是气泡引导，这是是一种轻量引导组件。 * 它的调用既不会阻塞用户后续行为，也不要求用户一定去响应操作，在一定时间内向用户展现信息，便自动消失。 * * 展现策略： * - 3s 后自动消失，组件箭头指向小程序菜单。 * - 每位用户最多触达【2 次】，最短间隔【3 天】才能第二次展现。 */ tt.showFavoriteGuide({ type: "tip", content: "文字上限总共十二个字符", position: "overtab", success(res) { console.log("引导组件展示成功") }, fail(res) { console.log("引导组件展示失败") }, })
效果如下图：
/** * 当 type = 'bar' 时，弹出的引导是浮窗引导，浮窗引导的展现力度比气泡引导更强，用户在组件上能进行“添加”操作。 * * 展现策略： * - 10s 后自动消失。 * - 每位用户最多触达【2 次】，最短间隔【一周】才能第二次展现。 */ tt.showFavoriteGuide({ type: "bar", content: "一键添加到「我的小程序」", position: "bottom", success(res) { console.log("引导组件展示成功", res) }, fail(err) { console.log("引导组件展示失败", err) }, })
效果如下图：
Bug & Tip
- •Tip：展现策略仅在线上版、审核版有效，测试版、预览版不受限制；
- •Tip：若检测到用户已收藏该小程序，则不展示任何引导组件。
