HarmonyOS SDK 接口说明

• MLinkSDK，包含 SDK 所有公开接口

设置 Debug 模式

支持的版本

开始支持的版本 1.0.0

接口定义

• MLinkSDK.setDebug(enable: boolean)
  • 接口说明：
    • 设置是否开启 debug 模式。true 则会打印更多日志信息。建议在 init 接口之前调用。
  • 参数说明：
    • enable：debug 开关
  • 调用示例：

          MLinkSDK.setDebug(true);

        

SDK 初始化

支持的版本

开始支持的版本 1.0.0

接口定义

• MLinkSDK.init(context: common.UIAbilityContext, config: MLinkConfig)
  • 接口说明：
    • 初始化接口。
  • 参数说明：
    • context：UIAbilityContext
    • config：初始化配置
  • 回调说明：
    • config.completion(error)：初始化完成回调，error == null 代表初始化流程已完成
  • 调用示例：

          const config = new MLinkConfig();
config.appKey = "你的 AppKey";
config.completion = (error) => {
  if (error) {
    console.error(`init failed: ${error.message}`);
  }
};

MLinkSDK.init(this.context, config);

        

初始化参数 MLinkConfig

          export class MLinkConfig {
  appKey: string = ''
  channel?: string
  completion?: (error?: Error | null) => void
}

        

参数说明：

• appKey：应用标识，必填
• channel：渠道信息，可选
• completion：初始化完成回调，可选

注册统一回调

支持的版本

开始支持的版本 1.0.0

接口定义

• MLinkSDK.registerHandler(handler: MLinkHandler)
  • 接口说明：
    • 注册统一回调入口，SDK 在解析到有效 mlink 后通过该回调返回结果。
  • 参数说明：
    • handler：回调函数
  • 调用示例：

          MLinkSDK.registerHandler((response) => {
  if (!response) {
    return;
  }
  console.info(`url=${response.url ?? ''}`);
});

        

回调模型 MLinkResponse

          export class MLinkResponse {
  url?: string
  params?: Record<string, Object>
  source: number = 0
  eventType: number = 0
}

        

字段说明：

• url：唤起后的目标链接
• params：业务参数
• source：数据来源
  • 0：未知
  • 1：Scheme 拉起
  • 2：App Linking 拉起
  • 3：场景还原
• eventType：事件类型
  • 0：未知
  • 1：安装事件
  • 2：拉起事件

获取 mlink 参数

支持的版本

开始支持的版本 1.0.0

接口定义

• MLinkSDK.getMLinkParam(paramKey?: string, handler?: (params: Map<string, Object> | null) => void)
  • 接口说明：
    • 获取 mlink 参数；paramKey 不传时返回全部参数，传入时返回对应 key 的参数字典。
  • 参数说明：
    • paramKey：可选，参数 key
    • handler：参数回调
  • 回调说明：
    • 返回 Map<string, Object> | null
  • 调用示例：

          MLinkSDK.getMLinkParam(undefined, (params) => {
  if (!params) {
    return;
  }
  params.forEach((value, key) => {
    console.info(`${key}=${value}`);
  });
});

MLinkSDK.getMLinkParam('scene', (params) => {
  if (!params) {
    return;
  }
  console.info(params.get('scene'));
});

        

路由链接

支持的版本

开始支持的版本 1.0.0

接口定义

• MLinkSDK.routeLink(url: string): boolean
  • 接口说明：
    • 统一路由入口，承接 Scheme、App Linking 与场景还原返回链接。
  • 参数说明：
    • url：待处理链接
  • 返回结果：
    • true：SDK 接收并进入处理链路
    • false：SDK 忽略该链接
  • 调用示例：

          const handled = MLinkSDK.routeLink("mlinkdemo://open/home?scene=demo");
console.info(`handled=${handled}`);