@arkui-x.bridge.d.ts (平臺橋接)

本模塊提供ArkUI端和Android或iOS平臺端消息通信的功能，包括數據傳輸、方法調用和事件調用。需配套平臺端API使用，Android側請參考[BridgePlugin]，iOS側參考[BridgePlugin]。

說明：
開發前請熟悉鴻蒙開發指導文檔：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]點擊或者復制轉到。
本模塊首批接口從API version 10開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。

導入模塊

import bridge from '@arkui-x.bridge';

createBridge

createBridge(bridgeName: string): BridgeObject

定義BridgeObject類。

系統能力： SystemCapability.ArkUI.ArkUI.Full

參數：

返回值：

示例：

const bridgeObj: BridgeObject = bridge.createBridge('Bridge');

BridgeObject

橋接的接口類。

callMethod

callMethod(methodName: string, parameters?: Record): Promise;

callMethod(methodName: string, ...parameters: Array): Promise;

調用平臺方法。

系統能力： SystemCapability.ArkUI.ArkUI.Full

參數：

返回值：

錯誤碼：

示例：

const bridgeObj = bridge.createBridge('Bridge');

bridgeObj.callMethod('nativeMethod').then((data)= >{
    console.log('data = ' + data);
}).catch((err) = > {
    console.error('error = ' + JSON.stringify(err));
});

registerMethod

registerMethod(method: MethodData, callback: AsyncCallback): void

registerMethod(method: MethodData): Promise

注冊ArkUI端方法，供Android或iOS平臺端調用。

系統能力： SystemCapability.ArkUI.ArkUI.Full

參數：

錯誤碼：

示例：

function jsMethod() {
  return 'ts return：jsMethod';
}

const bridgeObj = bridge.createBridge('Bridge');
bridgeObj.registerMethod({ name: 'jsMethod', method: jsMethod });

unRegisterMethod

unRegisterMethod(methodName: string, callback: AsyncCallback): void

unRegisterMethod(methodName: string): Promise

移除已注冊的ArkUI端的方法。

參數：

系統能力： SystemCapability.ArkUI.ArkUI.Full

示例：

const bridgeObj = bridge.createBridge('Bridge');

bridgeObj.unRegisterMethod('jsMethod');

sendMessage

sendMessage(message: Message, callback: AsyncCallback): void

sendMessage(message: Message): Promise

向Platform平臺側發送數據。

參數：

返回值：

系統能力： SystemCapability.ArkUI.ArkUI.Full

示例：

const bridgeObj = bridge.createBridge('Bridge');

bridgeObj.sendMessage('jsMessage').then((data)= >{
    console.log('data =' + data);
}).catch((err) = > {
    console.error('error =' + JSON.stringify(err));
});

setMessageListener

setMessageListener(callback: (message: Message) => Response)

設置用于接收Platform平臺側發送數據的回調。

參數：

系統能力： SystemCapability.ArkUI.ArkUI.Full

示例：

const bridgeObj = bridge.createBridge('Bridge');

bridgeObj.setMessageListener((data) = > {
    console.log('receive data =' + data);
});

S

type S = number | boolean | string | null

說明： 定義橋接使用的基礎數據類型。

T

type T = S | Array | Array | Array

說明： 定義橋接使用的基礎數據類型的數組類型。

Message

type Message = T | Record

說明： 定義橋接使用結構數據類型。

Parameter

type Parameter = Message

說明： 定義方法參數類型。

Response

type Response = Message

說明： 定義應答的數據類型。

ResultValue

type ResultValue = T | Map

說明： 定義方法返回值的類型。