# 收藏

# 启用并设置收藏按钮

用于启用游戏右上角•••菜单中的「收藏」按钮，并同步设置其点击时的收藏参数；建议在SDK初始化完成后立即调用此接口进行设置。

sdkInstance.setFavorite(options);

参数说明如下表所示：

选项	类型	必填	默认值	说明
title	string	否	--	收藏标题，不填时默认使用当前游戏的名称
imageUrl	string	否	--	转发时显示的图片链接，可以是网络图片路径，或本地图片文件路径，亦或相对代码包根目录的图片文件路径，建议长宽比为 `5:4`
query	object	否	--	收藏时携带的额外参数；从收藏进入游戏后，可通过 `sdkInstance.launchOptions.query` 或调用微信原生方法 wx.getLaunchOptionsSync() 获取该信息
disableForward	boolean	否	false	禁止收藏后长按转发，默认为 `false`

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

sdkInstance.setFavorite({
  title: "收藏标题，可填写游戏名称",
  imageUrl: "xxxxxxxxxx",
  query: {
    param1: 1,
    param2: 2
  }
});