Share

<!-- ## uni.share(options) @share -->

::: sourceCode

uni.share(options) @share

GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-share

GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-share

:::

分享

share 兼容性

Web	微信小程序	Android	iOS	HarmonyOS	HarmonyOS(Vapor)
<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>	-	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>	4.81	5.0

参数

名称	类型	必填	默认值	兼容性	描述
options	ShareOptions	是	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -

options 的属性描述

名称	类型	必备	默认值	兼容性	描述
provider	string	否	weixin	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	分享服务提供商，通过uni.getProvider获取，如果不设置则默认 weixin
type	number	否	0	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	分享类型。默认图文0
title	string	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	标题
scene	string	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	场景
summary	string	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	摘要
href	string	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	跳转链接
imageUrl	string	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	图片地址
mediaUrl	string	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	音视频地址
miniProgram	ShareMiniProgramShareOptions	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	分享小程序
openCustomerServiceChat	boolean	否	false	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: 5.0	是否启用拉起客服功能，为 true 时除 corpid、customerUrl 外其他参数无效
corpid	string	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: 5.0	客服ID，openCustomerServiceChat 为 true 时必填
customerUrl	string	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: 5.0	客服的页面路径，openCustomerServiceChat 为 true 时必填
success	(result: ShareSuccess) => void	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	接口调用成功的回调函数
fail	(result: ShareFail) => void	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	接口调用失败的回调函数
complete	(result: any) => void	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	接口调用结束的回调函数（调用成功、失败都会执行）

type 的属性描述

合法值	兼容性	描述
0	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	图文
1	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	纯文字
2	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	纯图片
3	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	音乐（HarmonyOS 暂不支持）
4	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	视频
5	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	小程序

scene 的属性描述

合法值	兼容性	描述
WXSceneSession	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	分享到聊天界面
WXSceneTimeline	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	分享到朋友圈
WXSceneFavorite	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	分享微信收藏（HarmonyOS 暂不支持）

miniProgram 的属性描述

名称	类型	必备	默认值	兼容性	描述
id	string	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	微信小程序原始id
path	string	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	点击链接进入的页面
type	number	否	0	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	微信小程序版本类型，默认为0。
webUrl	string	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	兼容低版本的网页链接

type 的属性描述

合法值	兼容性	描述
0	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	正式版
1	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	测试版
2	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	体验版

ShareFail 的属性值 @sharefail-values

名称	类型	必备	默认值	兼容性	描述
errCode	number	是	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	错误码
errSubject	string	是	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	统一错误主题（模块）名称
data	any	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	错误信息中包含的数据
cause	Error	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	源错误信息，可以包含多个错误，详见SourceError
errMsg	string	是	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -

errCode 的属性描述

合法值	兼容性	描述
4000500	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: 4.81; HarmonyOS(Vapor): 5.0	未找到微信APPID,请确认 manifest.json 中配置信息是否正确
4000501	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: 4.81; HarmonyOS(Vapor): 5.0	该场景字段当前不支持
4000502	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: 4.81; HarmonyOS(Vapor): 5.0	该场景字段未匹配到
4000503	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: 4.81; HarmonyOS(Vapor): 5.0	分享类型不匹配，请确认类型是否正确
4000504	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: 4.81; HarmonyOS(Vapor): 5.0	参数填写错误
4000505	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: 4.81; HarmonyOS(Vapor): 5.0	请求微信接口失败
4000506	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: 4.81; HarmonyOS(Vapor): 5.0	暂不支持该类型的分享
4000507	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: 4.81; HarmonyOS(Vapor): 5.0	图片下载失败
4000508	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: 4.81; HarmonyOS(Vapor): 5.0	加载本地文件失败
4000509	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: 4.81; HarmonyOS(Vapor): 5.0	获取缩略图失败
4000510	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: 4.87; HarmonyOS(Vapor): 5.0	微信可能未安装

<!-- UTSAPIJSON.share.example -->

参见

• 相关 Bug
• 参见uni-app相关文档
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

通用类型

GeneralCallbackResult

名称	类型	必备	默认值	兼容性	描述
errMsg	string	是	-	Web: -; 微信小程序: 4.41; Android: -; iOS: -; HarmonyOS: -	错误信息

Bug&Tips @bug_tips

• HarmonyOS 平台分享图片时仅支持 jpeg/png 类型的图片
  • 分享视频，大小不能超过 64KB
  • 分享图片，大小不支持超过 100KB
• HarmonyOS 平台分享携带文本时
  • title 不支持超过 512 个字节
  • summary 不支持超过 1024 个字节
• 鸿蒙平台，HBuilderX 4.87 及以下版本，分享时有图片大于 20 KB 会出现分享失败的问题
  • 下载 har包并改名为 uni_modules__uni_share_weixin.har，放到 项目根目录/harmony-configs/libs/ 目录下重新编译运行到手机