share(params: Object)

版本要求:
BizKit≥3.0.0@ray-js/ray≥0.3.23
支持平台:
iOS
import { share } from '@ray-js/ray';

// Promise 调用
try {
  const res = await share({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

描述

按指定分享渠道分享文本、图片、文件、网页或小程序内容

参数

属性类型必填默认值说明
type"WeChat" | "Message" | "Email" | "More"否'WeChat'分享渠道，未传时默认 WeChat；可选值：WeChat、Message、Email、More
titlestring是-title 标题
messagestring是-message 文本内容
contentType"text" | "image" | "file" | "web" | "miniProgram"否'text'contentType 内容类型
recipientsstring[]否-recipients 邮件收件人/短信接收人
imagePathstring否-imagePath 图片路径
filePathstring否-文件分享路径，contentType == file 时使用，未传会导致文件分享失败
webPageUrlstring否-web 当 contentType == file 时候使用
否-miniProgramInfo 当 contentType == miniProgram 时候使用，且分享渠道必须是微信。
complete() => void否-接口调用结束的回调函数（调用成功、失败都会执行）
success() => void否-接口调用成功的回调函数
fail(params: Object) => void否-接口调用失败的回调函数
fail 回调参数
属性类型说明
errorMsgstring错误信息
errorCodestring | number错误码
错误扩展

返回值

无

合法值

type
值说明BizKit 最低版本
WeChat微信v4.14.8
Message短信v4.14.8
Email邮件v4.14.8
More系统更多分享渠道（调用系统分享）v4.14.8
contentType
值说明BizKit 最低版本
text文本v4.14.8
image图片v4.14.8
file文件v4.14.8
web网页地址v4.14.8
miniProgram微信小程序分享内容v4.14.8

示例代码

import { share } from '@ray-js/ray'

share({
  type: "WeChat",
  title: "xx",
  message: "xx",
  contentType: "text",
  recipients: [],
  imagePath: "xx",
  filePath: "xx",
  webPageUrl: "xx",
  miniProgramInfo: {},
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});