HarmonyOS SDK 集成指南

使用提示

本文是 JMLink HarmonyOS SDK 标准的集成指南文档。

匹配的 SDK 版本为：v1.0.0 及以后版本。

• 如果您想要快速地测试、请参考本文在几分钟内跑通 Demo。
• 极光魔链文档网站上，有相关的所有指南、API、教程等全部的文档。包括本文档的更新版本，都会及时地发布到该网站上。

产品说明

极光魔链为开发者提供链接拉起、参数透传、场景还原能力，便于在 App 内完成活动承接、邀请分享、内容跳转等业务场景。

主要场景

• Scheme 拉起
• App Linking 拉起
• 链接参数透传
• 场景还原

获取应用信息

在控制台上创建应用后，可以进入魔链相关配置页面获取用以标识应用的 AppKey。

集成方式

ohpm 自动集成方式

          "dependencies": {
    "@jg/mlink": "^1.0.0" //设置极光魔链自动集成
}

        

手动集成方式

jmlink-hmos-x.x.x-release.zip 集成压缩包内容

• jmlink-hmos-x.x.x-release.har

  • 极光魔链 HarmonyOS SDK 核心包。

• doc

  • 文档

• entry

  • 是一个 hmos demo 项目代码，通过这个演示了 JMLink SDK 的基本用法，可以用来做参考。

har 文件集成

• 解压缩 jmlink-hmos-x.x.x-release.zip 集成压缩包。
• 复制 jmlink-hmos-x.x.x-release.har 到你的工程的 entry/hars/ 目录下。(hars 这个目录可以自定义)

说明：关联 jmlink-hmos-x.x.x-release.har，如，你复制 har 到 entry/hars/ 目录下，那么在 entry 模块下的 oh-package.json5 文件添加

          "dependencies": {
    "@jg/mlink": "./hars/jmlink-hmos-x.x.x-release.har" //这里的路径是你存放 jmlink-hmos-x.x.x-release.har 的位置
}

        

配置权限

在 module.json5 中配置魔链需要使用的权限

          "requestPermissions": [
  {
    "name": "ohos.permission.INTERNET"
  },
  {
    "name": "ohos.permission.GET_NETWORK_INFO"
  }
],

        

配置极光平台信息

主要步骤为：

• 在极光平台创建 App，获取包名和 AppKey

  说明1：

  在本地工程配置包名，方式， 在 AppScope 工程下的 app.json5 文件添加

          {
  "app": {
    "bundleName": "你的包名",
  }
}

        

配置 Scheme 拉起

如果需要通过 Scheme 拉起应用，请在 entry/src/main/module.json5 的目标 Ability 中配置 viewData skill。

          "skills": [
  {
    "entities": [
      "entity.system.browsable"
    ],
    "actions": [
      "ohos.want.action.viewData"
    ],
    "uris": [
      {
        "scheme": "mlinkdemo",
        "host": "open",
        "pathStartWith": "/home"
      }
    ]
  }
]

        

示例链接：

          mlinkdemo://open/home?from=test

        

配置 App Linking 拉起

如果需要通过 https 链接拉起应用，请在 entry/src/main/module.json5 的目标 Ability 中配置 https 类型的 viewData skill，并开启 domainVerify。

          "skills": [
  {
    "entities": [
      "entity.system.browsable"
    ],
    "actions": [
      "ohos.want.action.viewData"
    ],
    "uris": [
      {
        "scheme": "https",
        "host": "applink.example.com",
        "pathStartWith": "/mlink"
      }
    ],
    "domainVerify": true
  }
]

        

示例链接：

          https://applink.example.com/mlink?from=test

        

服务端和控制台需要同时完成以下配置。AppGallery Connect 配置要求请参考官方文档：

https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/app-linking-kit-guide

• 控制台开启 App Linking 能力。
• 控制台配置用于拉起应用的 https 域名或 URL 前缀。
• 域名侧按 HarmonyOS App Linking 要求配置域名验证文件。
• 域名、包名与当前应用配置保持一致。

其他功能

请参考：HarmonyOS SDK 接口说明

运行 Demo

压缩包附带的 demo 是一个 API 演示例子。你可以将它导入到你的工程，并将你的 AppKey、包名、Scheme 和 App Linking 域名配置完成后直接运行起来测试。

技术支持

邮件联系：support@jiguang.cn