主题
LimeXhsshare 小红书功能集成
lime-xhsshare UTS插件集成小红书核心功能(分享图片、分享视频等)的接口使用方法,适用于Android/iOS,未测试。
安装
导入,在页面引入,修改各平台的文件后,自定义基座
请在试用后,确定需要后才购买。
Android
在 uni_modules/lime-xhsshare/utssdk/app-android/AndroidManifest.xml
文档中将所有填写真实包名
换成你的应用包名
iOS
在 uni_modules/lime-xhsshare/utssdk/app-ios/Info.plist
文档将填写小红书AppKey
换成你的小红书AppKey
代码演示
初始化小红书配置
js
import {useXhsShare, type LimeXhsShareConfig} from '@/uni_modules/lime-xhsshare';
const xhsUtils = useXhsShare({
appKey: "小红书开放平台AppKey", // 小红书开放平台AppKey
universalLink: "https://yourdomain.com/universal-link/", // iOS Universal Link
success: (res) => console.log("初始化成功", res),
fail: (err) => console.error("初始化失败", err)
} as LimeXhsShareConfig);
LimeXhsShareConfig
参数名 | 类型 | 必填 | 说明 | 平台差异 | 默认值 |
---|---|---|---|---|---|
appKey | string | 是 | 小红书开放平台注册的AppKey | Android/iOS 均需 | 无 |
universalLink | string | iOS必填 | iOS Universal Link(用于小红书分享等功能) | 仅iOS生效 | 无 |
success | (res: LimeXhsSuccessCallbackResult) => void | 否 | 初始化成功的回调(返回状态码及消息) | 无 | 无 |
fail | (res: LimeXhsFail) => void | 否 | 初始化失败的回调(包含错误码及错误信息) | 无 | 无 |
complete | (res: any) => void | 否 | 接口调用完成的回调(无论成功/失败均触发) | 无 | 无 |
小红书客户端检查
js
// 是否存在小红书客户端
xhsUtils.isInstalled()
打开小红书活动页
js
xhsUtils.openUrl("https://www.xiaohongshu.com/activity-page")
分享图片
js
import { type LimeXhsShareOptions} from '@/uni_modules/lime-xhsshare';
xhsUtils.share({
type: 'image',
imageUrl: 'https://example.com/share-image.jpg',
thumb: 'https://example.com/thumbnail.jpg', // 建议提供缩略图
title: '分享标题',
summary: '分享描述'
} as LimeXhsShareOptions);
分享视频
js
import { type LimeXhsShareOptions} from '@/uni_modules/lime-xhsshare';
// 分享示例
xhsUtils.share({
type: 'video',
title: '精彩视频',
summary: '这是一段精彩的视频',
videoUrl: 'https://example.com/movie-trailer.mp4',
thumb: 'https://example.com/video-thumb.jpg' // 建议提供缩略图
} as LimeXhsShareOptions);
LimeXhsShareOptions 参数说明表
参数名 | 类型 | 必填条件 | 说明 | 适用分享类型 | 示例值 |
---|---|---|---|---|---|
type | string | 必填 | 分享类型:image (图片) 或 video (视频) | 所有类型 | "image" |
title | string | 否 | 分享标题 | image/video | "限时特惠" |
summary | string | 否 | 分享描述 | image/video | "点击领取新人礼包" |
thumb | string | 建议提供 | 缩略图URL(建议<32KB) | image/video | "https://example.com/thumb.jpg" |
imageUrl | string | image类型必填 | 图片资源地址(支持本地路径) | image | "/static/share.jpg" |
videoUrl | string | video类型必填 | 视频URL | video | "https://example.com/video.mp4" |
success | (res: LimeXhsSuccessCallbackResult) => void | 否 | 分享成功的回调 | 无 | 无 |
fail | (res: LimeXhsFail) => void | 否 | 分享失败的回调(包含错误码及错误信息) | 无 | 无 |
complete | (res: any) => void | 否 | 接口调用完成的回调(无论成功/失败均触发) | 无 | 无 |
分享相关错误码表
错误码 | 说明 | 常见原因 | 处理建议 |
---|---|---|---|
9010001 | 小红书未安装 | 用户设备未安装小红书App | 提示用户安装小红书App |
9010002 | 小红书版本号太低 | 用户设备小红书版本过低 | 提示用户升级小红书App |
9010003 | 资源缺失 | 图片或视频资源未提供 | 检查imageUrl或videoUrl参数 |
9010004 | 图片或者视频文件不存在 | 提供的文件路径无效 | 检查文件路径是否正确 |
9010005 | 文件处理失败 | 文件格式不支持或损坏 | 检查文件格式是否正确 |
9010008 | 鉴权失败 | AppKey无效或未正确配置 | 检查AppKey和universalLink配置 |
9010009 | 打开分享页面失败 | 小红书App响应异常 | 检查小红书App是否正常运行 |
9010010 | 传递数据有误 | 参数格式错误 | 检查分享参数格式 |
9010022 | 用户取消发布 | 用户主动取消分享操作 | 属于正常用户行为,可以引导用户重新分享 |