文档中心 > 店铺动态卡片-开发指引

onShareAppMessage

更新时间:2023/01/18 访问次数:15958

手机淘宝8.8.0及以上版本支持该API

 

在 Page 中定义 onShareAppMessage 函数,设置该页面的分享信息。

  • 每个 Page 页面的右上角菜单中默认有 分享 按钮;onShareAppMessage 函数只自定义分享的内容,不影响分享功能。
  • 用户点击分享按钮的时候会调用。
  • 此事件需要返回一个对象(Object)类型,用于自定义分享内容。
  • 分享图片中的二维码的有效期为60天,若需要长期有效的二维码,请到“开发者后台-码管理”中生成。

 

入参

Object 类型/,属性如下:

属性

类型

说明

from

String

触发来源:

button:页面页分享按钮触发;

menu:右上角分享按钮触发。

code:执行my.showSharePanel 触发

target

Object

如果 from 值为 button,则 target 为触发这次分享的 button,否则为 undefined

webViewUrl

String

页面中包含web-view组件时,返回当前web-viewURL

onShareAppMessage执行完后必须返回一个分享对象,用于自定义分享内容。

 

返回值

属性

类型

必填

描述

title

String

自定义分享标题

desc

String

自定义分享描述:由于分享到微博只支持最大长度 140 个字,因此建议长度不要超过该限制。

path

String

自定义分享页面的路径,path中的自定义参数可在小程序生命周期的 onLoad方法中获取(参数传递遵循 http get 的传参规则)

path和url两者至少需要填一个

url

String

分享完整的url,调用分享后将会使用该url作为回流地址。

path和url两者至少需要填一个。

注意:该参数,通过容器菜单内的分享时,不生效。

imageUrl

String

自定义分享卡片背景图片,支持:网络图片路径;

注意:图片url需要上传到阿里特定可信域名下。

extraParams

JSONObject

分享扩展参数

success

Function

分享成功后回调

fail

Function

分享失败后回调

 

示例代码

Page({
onShareAppMessage() {
return {
title: '小程序示例',
desc: '小程序官方示例 Demo,展示已支持的接口能力及组件。',
path: 'page/component/component-pages/view/view?param=123'
};

},
});

 

 

Page({
onShareAppMessage() {
return {
title: '小程序示例',
desc: '小程序官方示例 Demo,展示已支持的接口能力及组件。',
url: 'https://m.duanqu.com?_ariver_appid=3000000002032702&page=page%2fcomponent%2fcomponent-pages%2fview%2fview%3fparam%3d123'
};
},
});

Page.onShareAppMessage

 

通过给 button 组件设置属性 open-type="share",可以在用户点击按钮后触发 Page.onShareAppMessage() 页面内发起分享事件,并唤起分享面板,如果当前页面没有定义此事件,则点击后无效果。相关组件:button 。

App.onShareAppMessage

可以在App(Object)构造函数中设置全局的分享onShareAppMessage配置,当调用分享时,如果未配置页面级的分享设置则会使用全局的分享设置。

 

 

 

 

 

 

FAQ

关于此文档暂时还没有FAQ
返回
顶部