小红书分享 SDK HarmonyOS 接入指南

SDK 基础信息

前置要求

请通过首页「快速接入」入口登记企业和应用信息，通过平台审核后，将获得对应AppKey信息；

集成 SDK

1. 下载鸿蒙开发的 IDE

   前往鸿蒙官网下载 DevEco Studio NEXT

2. 配置 sdk 依赖

   修改项目中的oh-package.json5文件，在dependencies中加入小红书 opensdk 的依赖项

{
    "name": "demo",
    "version": "1.0.0",
    "description": "Please describe the basic information.",
    "main": "",
    "author": "",
    "license": "",
    "dependencies": {
         "@xiaohongshu/open_sdk": "1.0.4"
    }
}

API

备注：以下示例代码均为 ArkTS 代码。

初始化

进行分享之前，需要先对 sdk 初始化。

/**
 * 初始化 SDK
 */
const context: common.UIAbilityContext = getContext(this) as common.UIAbilityContext
XhsShareSdk.registerApp(context,  appkey)

参数解析

/**
* 注册 app （即初始化）
* @param context  context
* @param appKey   申请的appKey
*/
registerApp(context: common.UIAbilityContext, appKey: string)

开始分享

1. 图文笔记

XhsShareSdk.shareNote(context, {
    title: '这是标题',
    content: '这是内容',
    type: 'note',
    imageInfo: [{
        'url':  '网络图片url',
    }]
})

2. 视频笔记

XhsShareSdk.shareNote(context, {
    title: '这是标题',
    content: '这是内容',
    type: 'video',
    videoInfo: {
        'video': {
             'url':  '网络视频url'
        },
        'cover': {
             'url':  '网络图片url',
        }
    }
})

NOTE:

• XhsImageItem 支持一种构造方式
  • url // 网络图片
• XhsVideoItem 支持一种构造方式
  • url // 网络视频
• 如果同时设置了图片资源（imageInfo 字段）和视频资源（videoInfo 字段）的话，则认为是图文笔记，废弃视频资源

分享回调

设置分享回调

XhsShareSdk.setShareCallback({
    onSuccess: (sessionId: string) => {},
    onError: (sessionId: string, errorCode: number, errorMessage: string) => {}
})

• sessionId 为本次分享的唯一标识，每次分享都会改变

一些工具方法

获取小红书包名

/**
 * 获取小红书包名
 *
 * @return 小红书包名
 */
XhsShareSdk.getXhsPackageName()

判断小红书是否安装

/**
 * 小红书是否已经安装
 *
 * @return 是否已经安装
 */
XhsShareSdk.isXhsInstalled()

错误码定义

以下是分享回调中的错误码定义。

错误码