Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

提交 07fd169d 编写于 作者: L l30043718
浏览文件
操作

Description:provides example usage on the stage model 

Feature or Bugfix:provides example usage on the stage model
Binary Source: No
Signed-off-by: NLixiaoying25 <lixiaoying25@huawei.com>
上级 83ef6011
显示空白变更内容
内联 并排
Showing with 574 addition and 439 deletion
zh-cn/application-dev/reference/apis/js-apis-rpc.md
浏览文件 @ 07fd169d
......@@ -97,7 +97,7 @@ writeRemoteObject(object: [IRemoteObject](#iremoteobject)): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| -------- | ------- |
| -------- | -------- |
| 1900008 | proxy or remote object is invalid |
| 1900009 | write data to message sequence failed |
......@@ -138,7 +138,7 @@ readRemoteObject(): IRemoteObject
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900008 | proxy or remote object is invalid |
| 1900010 | read data from message sequence failed |
......@@ -180,7 +180,7 @@ writeInterfaceToken(token: string): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -214,7 +214,7 @@ readInterfaceToken(): string
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | ----- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -324,7 +324,7 @@ setCapacity(size: number): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| -------- | ------ |
| -------- | -------- |
| 1900011 | parcel memory alloc failed |
**示例：**
......@@ -510,7 +510,7 @@ writeByte(val: number): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| ------ | ------ | ---- | ----- |
| val | number | 是 | 要写入的字节值。 |
**错误码：**
......@@ -593,7 +593,7 @@ writeShort(val: number): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | ------ |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -627,7 +627,7 @@ readShort(): number
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -668,7 +668,7 @@ writeInt(val: number): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| -------- | ------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -702,7 +702,7 @@ readInt(): number
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | ------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -743,7 +743,7 @@ writeLong(val: number): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | ------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -777,7 +777,7 @@ readLong(): number
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -810,7 +810,7 @@ writeFloat(val: number): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ---- | ---- | ----- |
| ------ | ------ | ---- | ----- |
| val | number | 是 | 要写入的浮点值。 |
**错误码：**
......@@ -818,7 +818,7 @@ writeFloat(val: number): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | ------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -852,7 +852,7 @@ readFloat(): number
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -893,7 +893,7 @@ writeDouble(val: number): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -927,7 +927,7 @@ readDouble(): number
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -968,7 +968,7 @@ writeBoolean(val: boolean): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | ------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -1002,7 +1002,7 @@ readBoolean(): boolean
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| -------- | ------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -1043,7 +1043,7 @@ writeChar(val: number): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -1077,7 +1077,7 @@ readChar(): number
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------ | --------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -1118,7 +1118,7 @@ writeString(val: string): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -1152,7 +1152,7 @@ readString(): string
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -1193,7 +1193,7 @@ writeParcelable(val: Parcelable): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -1246,7 +1246,7 @@ readParcelable(dataIn: Parcelable): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| -------- | ------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
| 1900012 | call js callback function failed |
......@@ -1302,7 +1302,7 @@ writeByteArray(byteArray: number[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -1337,7 +1337,7 @@ readByteArray(dataIn: number[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -1379,7 +1379,7 @@ readByteArray(): number[]
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| -------- | ------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -1421,7 +1421,7 @@ writeShortArray(shortArray: number[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ----- | ----- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -1455,7 +1455,7 @@ readShortArray(dataIn: number[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------ | ------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -1496,7 +1496,7 @@ readShortArray(): number[]
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| -------- | ------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -1537,7 +1537,7 @@ writeIntArray(intArray: number[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ----- | --------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -1571,7 +1571,7 @@ readIntArray(dataIn: number[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -1612,7 +1612,7 @@ readIntArray(): number[]
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ----- | ------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -1653,7 +1653,7 @@ writeLongArray(longArray: number[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | ----- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -1687,7 +1687,7 @@ readLongArray(dataIn: number[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | ------ |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -1728,7 +1728,7 @@ readLongArray(): number[]
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -1769,7 +1769,7 @@ writeFloatArray(floatArray: number[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -1803,7 +1803,7 @@ readFloatArray(dataIn: number[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -1844,7 +1844,7 @@ readFloatArray(): number[]
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -1885,7 +1885,7 @@ writeDoubleArray(doubleArray: number[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -1919,7 +1919,7 @@ readDoubleArray(dataIn: number[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -1960,7 +1960,7 @@ readDoubleArray(): number[]
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -2001,7 +2001,7 @@ writeBooleanArray(booleanArray: boolean[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -2035,7 +2035,7 @@ readBooleanArray(dataIn: boolean[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -2076,7 +2076,7 @@ readBooleanArray(): boolean[]
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -2117,7 +2117,7 @@ writeCharArray(charArray: number[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| -------- | ------ |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -2151,7 +2151,7 @@ readCharArray(dataIn: number[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -2192,7 +2192,7 @@ readCharArray(): number[]
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -2234,7 +2234,7 @@ writeStringArray(stringArray: string[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -2268,7 +2268,7 @@ readStringArray(dataIn: string[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -2309,7 +2309,7 @@ readStringArray(): string[]
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -2344,7 +2344,7 @@ writeNoException(): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -2386,15 +2386,17 @@ readException(): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function(elementName, remoteProxy) {
......@@ -2412,7 +2414,11 @@ readException(): void
"bundleName": "com.ohos.server",
"abilityName": "com.ohos.server.EntryAbility",
};
FA.connectAbility(want, connect);
//FA模型使用此方法连接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的sendMessageRequest接口方法发送消息
......@@ -2466,7 +2472,7 @@ writeParcelableArray(parcelableArray: Parcelable[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -2522,7 +2528,7 @@ readParcelableArray(parcelableArray: Parcelable[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
| 1900012 | call js callback function failed |
......@@ -2583,7 +2589,7 @@ writeRemoteObjectArray(objectArray: IRemoteObject[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | ------- |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -2630,7 +2636,7 @@ readRemoteObjectArray(objects: IRemoteObject[]): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -2683,7 +2689,7 @@ readRemoteObjectArray(): IRemoteObject[]
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -2765,7 +2771,7 @@ static dupFileDescriptor(fd: number) :number
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | ------- |
| -------- | -------- |
| 1900013 | call os dup function failed |
**示例：**
......@@ -2839,7 +2845,7 @@ writeFileDescriptor(fd: number): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| -------- | ------ |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -2876,7 +2882,7 @@ readFileDescriptor(): number
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -2919,7 +2925,7 @@ writeAshmem(ashmem: Ashmem): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | ------- |
| -------- | ------- |
| 1900003 | write to ashmem failed |
**示例：**
......@@ -2961,7 +2967,7 @@ readAshmem(): Ashmem
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900004 | read from ashmem failed |
**示例：**
......@@ -3032,7 +3038,7 @@ writeRawData(rawData: number[], size: number): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | ------ |
| -------- | -------- |
| 1900009 | write data to message sequence failed |
**示例：**
......@@ -3073,7 +3079,7 @@ readRawData(size: number): number[]
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900010 | read data from message sequence failed |
**示例：**
......@@ -4028,7 +4034,7 @@ writeSequenceable(val: Sequenceable): boolean
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------- |
| ------- | -------------------------------- |
| boolean | true：写入成功，false：写入失败。|
**示例：**
......@@ -4069,13 +4075,13 @@ readSequenceable(dataIn: Sequenceable): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------- | ---- | --------------------------------------- |
| ------ | ----------------------------- | ------- | ---------------------------------------------- |
| dataIn | [Sequenceable](#sequenceabledeprecated) | 是 | 需要从MessageParcel读取成员变量的对象。 |
**返回值：**
| 类型 | 说明 |
| ------- | ------------------------------------------- |
| ------- | ---------------------------------------- |
| boolean | true：反序列化成功，false：反序列化失败。|
**示例：**
......@@ -4125,7 +4131,7 @@ writeByteArray(byteArray: number[]): boolean
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------- |
| ------- | -------------------------------- |
| boolean | true：写入成功，false：写入失败。|
**示例：**
......@@ -4204,7 +4210,7 @@ writeShortArray(shortArray: number[]): boolean
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------- |
| ------- | -------------------------------- |
| boolean | true：写入成功，false：写入失败。|
**示例：**
......@@ -4280,7 +4286,7 @@ writeIntArray(intArray: number[]): boolean
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------- |
| ------- | -------------------------------- |
| boolean | true：写入成功，false：写入失败。|
**示例：**
......@@ -4432,7 +4438,7 @@ writeFloatArray(floatArray: number[]): boolean
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------- |
| ------- | -------------------------------- |
| boolean | true：写入成功，false：写入失败。|
**示例：**
......@@ -4508,7 +4514,7 @@ writeDoubleArray(doubleArray: number[]): boolean
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------- |
| ------- | -------------------------------- |
| boolean | true：写入成功，false：写入失败。|
**示例：**
......@@ -4584,7 +4590,7 @@ writeBooleanArray(booleanArray: boolean[]): boolean
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------- |
| ------- | -------------------------------- |
| boolean | true：写入成功，false：写入失败。|
**示例：**
......@@ -4660,7 +4666,7 @@ writeCharArray(charArray: number[]): boolean
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------- |
| ------- | -------------------------------- |
| boolean | true：写入成功，false：写入失败。|
**示例：**
......@@ -4736,7 +4742,7 @@ writeStringArray(stringArray: string[]): boolean
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------- |
| ------- | -------------------------------- |
| boolean | true：写入成功，false：写入失败。|
**示例：**
......@@ -4847,10 +4853,12 @@ readException(): void
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.;featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function(elementName, remoteProxy) {
......@@ -4868,7 +4876,11 @@ readException(): void
"bundleName": "com.ohos.server",
"abilityName": "com.ohos.server.EntryAbility",
};
FA.connectAbility(want, connect);
//FA模型使用此方法连接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的sendMessageRequest接口方法发送消息
......@@ -4915,7 +4927,7 @@ writeSequenceableArray(sequenceableArray: Sequenceable[]): boolean
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------- |
| ------- | -------------------------------- |
| boolean | true：写入成功，false：写入失败。|
**示例：**
......@@ -5011,7 +5023,7 @@ writeRemoteObjectArray(objectArray: IRemoteObject[]): boolean
**返回值：**
| 类型 | 说明 |
| ------- | -------------------------------------------------------------------------------------------------------------------- |
| ------- | -------------------------------- |
| boolean | true：写入成功，false：写入失败。|
**示例：**
......@@ -5104,7 +5116,7 @@ readRemoteObjectArray(): IRemoteObject[]
**返回值：**
| 类型 | 说明 |
| --------------- | -------- |
| --------------- | --------------------------- |
| IRemoteObject[] | 返回IRemoteObject对象数组。 |
**示例：**
......@@ -5204,7 +5216,7 @@ containFileDescriptors(): boolean
**返回值：**
| 类型 | 说明 |
| ------- | ------------------------------------------------------------------ |
| ------- | --------------------------------------------- |
| boolean |true：包含文件描述符，false：未包含文件描述符。|
**示例：**
......@@ -5238,7 +5250,7 @@ writeFileDescriptor(fd: number): boolean
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------------------- |
| ------- | -------------------------------- |
| boolean | true：操作成功，false：操作失败。|
**示例：**
......@@ -5295,7 +5307,7 @@ writeAshmem(ashmem: Ashmem): boolean
**返回值：**
| 类型 | 说明 |
| ------- | -------------------------------------------------------------------- |
| ------- | -------------------------------- |
| boolean | true：写入成功，false：写入失败。|
**示例：**
......@@ -5372,7 +5384,7 @@ writeRawData(rawData: number[], size: number): boolean
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------------------- |
| ------- | -------------------------------- |
| boolean | true：写入成功，false：写入失败。|
**示例：**
......@@ -5436,8 +5448,8 @@ marshalling(dataOut: MessageSequence): boolean
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------------------- |
| boolean | true：封送成功，false：封送失败。
| ------- | -------------------------------- |
| boolean | true：封送成功，false：封送失败。|
**示例：**
```ts
......@@ -5485,7 +5497,7 @@ unmarshalling(dataIn: MessageSequence): boolean
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| ------- | ---------------------------------------- |
| boolean | true：反序列化成功，false：反序列化失败。|
**示例：**
......@@ -5535,14 +5547,14 @@ marshalling(dataOut: MessageParcel): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ----------------------------------------- |
| ------- | ----------------------------------------- | ---- | ----------------------------------------- |
| dataOut | [MessageParcel](#messageparceldeprecated) | 是 | 可序列对象将被封送到的MessageParcel对象。 |
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------------------- |
| boolean | true：封送成功，false：封送失败。
| ------- | -------------------------------- |
| boolean | true：封送成功，false：封送失败。 |
**示例：**
```ts
......@@ -5584,13 +5596,13 @@ unmarshalling(dataIn: MessageParcel): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------------- | ---- | --------------------------------------------- |
| ------ | ----------------------------------------- | ---- | --------------------------------------------- |
| dataIn | [MessageParcel](#messageparceldeprecated) | 是 | 已将可序列对象封送到其中的MessageParcel对象。 |
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| ------- | ---------------------------------------- |
| boolean | true：反序列化成功，false：反序列化失败。|
**示例：**
......@@ -5638,7 +5650,7 @@ asObject(): IRemoteObject
**返回值：**
| 类型 | 说明 |
| ---- | ----- |
| ----- | ----- |
| [IRemoteObject](#iremoteobject) | 如果调用者是RemoteObject对象，则直接返回本身；如果调用者是[RemoteProxy](#remoteproxy)对象，则返回它的持有者[IRemoteObject](#iremoteobject)。 |
**示例：**
......@@ -5654,20 +5666,22 @@ asObject(): IRemoteObject
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function (elementName, remoteProxy) {
onConnect: function(elementName, remoteProxy) {
console.log("RpcClient: js onConnect called.");
proxy = remoteProxy;
},
onDisconnect: function (elementName) {
onDisconnect: function(elementName) {
console.log("RpcClient: onDisconnect");
},
onFailed: function () {
onFailed: function() {
console.log("RpcClient: onFailed");
}
};
......@@ -5675,7 +5689,11 @@ asObject(): IRemoteObject
"bundleName": "com.ohos.server",
"abilityName": "com.ohos.server.EntryAbility",
};
FA.connectAbility(want, connect);
//FA模型使用此方法连接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的asObject接口方法获取代理或远端对象
......@@ -5691,7 +5709,6 @@ asObject(): IRemoteObject
}
}
let iRemoteObject = new TestProxy(proxy).asObject();
```
## DeathRecipient
......@@ -5803,7 +5820,7 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---- |
| ------- | ----------------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 |
| data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的&nbsp;MessageParcel对象。 |
| reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 |
......@@ -5812,7 +5829,7 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| ------- | -------------------------------- |
| boolean | true：发送成功，false：发送失败。|
......@@ -5829,7 +5846,7 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| ------- | ---------------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 |
| data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的&nbsp;MessageParcel对象。 |
| reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 |
......@@ -5853,7 +5870,7 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence,
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| ------- | ------------------------------------ | ---- | -------------------------------------------------------------------------------------- |
| code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 |
| data | [MessageSequence](#messagesequence9) | 是 | 保存待发送数据的&nbsp;MessageSequence对象。 |
| reply | [MessageSequence](#messagesequence9) | 是 | 接收应答数据的MessageSequence对象。 |
......@@ -5877,7 +5894,7 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence,
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| -------- | ------------------------------------ | ---- | -------------------------------------------------------------------------------------- |
| code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 |
| data | [MessageSequence](#messagesequence9) | 是 | 保存待发送数据的&nbsp;MessageSequence对象。 |
| reply | [MessageSequence](#messagesequence9) | 是 | 接收应答数据的MessageSequence对象。 |
......@@ -5897,7 +5914,7 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| -------- | ----------------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 |
| data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的&nbsp;MessageParcel对象。 |
| reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 |
......@@ -5924,7 +5941,7 @@ registerDeathRecipient(recipient: DeathRecipient, flags: number): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900008 | proxy or remote object is invalid |
### addDeathrecipient<sup>(deprecated)</sup>
......@@ -5947,7 +5964,7 @@ addDeathRecipient(recipient: DeathRecipient, flags: number): boolean
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| ------- | ---------------------------------------- |
| boolean | true：回调注册成功，false：回调注册失败。|
......@@ -5971,7 +5988,7 @@ unregisterDeathRecipient(recipient: DeathRecipient, flags: number): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900008 | proxy or remote object is invalid |
### removeDeathRecipient<sup>(deprecated)</sup>
......@@ -5994,7 +6011,7 @@ removeDeathRecipient(recipient: DeathRecipient, flags: number): boolean
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| ------- | -----------------------------------------|
| boolean | true：回调注销成功，false：回调注销失败。|
### getDescriptor<sup>9+</sup>
......@@ -6016,7 +6033,7 @@ getDescriptor(): string
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900008 | proxy or remote object is invalid |
......@@ -6048,7 +6065,7 @@ isObjectDead(): boolean
**返回值：**
| 类型 | 说明 |
| ------- | ------------------------------------------- |
| ------- | ---------------------------------- |
| boolean | true：对象死亡，false：对象未死亡。|
......@@ -6079,7 +6096,7 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| ------- | ----------------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 |
| data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的&nbsp;MessageParcel对象。 |
| reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 |
......@@ -6088,15 +6105,17 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| ------- | ---------------------------------|
| boolean | true：发送成功，false：发送失败。|
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function(elementName, remoteProxy) {
......@@ -6114,7 +6133,11 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
"bundleName": "com.ohos.server",
"abilityName": "com.ohos.server.EntryAbility",
};
FA.connectAbility(want, connect);
//FA模型使用此方法连接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的sendRequest接口方法发送消息
......@@ -6149,7 +6172,7 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence,
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| ------- | ------------------------------------ | ---- | -------------------------------------------------------------------------------------- |
| code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 |
| data | [MessageSequence](#messagesequence9) | 是 | 保存待发送数据的&nbsp;MessageSequence对象。 |
| reply | [MessageSequence](#messagesequence9) | 是 | 接收应答数据的MessageSequence对象。 |
......@@ -6163,10 +6186,12 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence,
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function(elementName, remoteProxy) {
......@@ -6184,7 +6209,11 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence,
"bundleName": "com.ohos.server",
"abilityName": "com.ohos.server.EntryAbility",
};
FA.connectAbility(want, connect);
//FA模型使用此方法连接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的sendMessageRequest接口方法发送消息
......@@ -6227,7 +6256,7 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| ------- | ----------------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 |
| data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的&nbsp;MessageParcel对象。 |
| reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 |
......@@ -6241,10 +6270,12 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function(elementName, remoteProxy) {
......@@ -6262,7 +6293,11 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
"bundleName": "com.ohos.server",
"abilityName": "com.ohos.server.EntryAbility",
};
FA.connectAbility(want, connect);
//FA模型使用此方法连接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的sendRequest接口方法发送消息
......@@ -6303,7 +6338,7 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence,
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| -------- | ------------------------------------ | ---- | -------------------------------------------------------------------------------------- |
| code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 |
| data | [MessageSequence](#messagesequence9) | 是 | 保存待发送数据的&nbsp;MessageSequence对象。 |
| reply | [MessageSequence](#messagesequence9) | 是 | 接收应答数据的MessageSequence对象。 |
......@@ -6312,10 +6347,12 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence,
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function(elementName, remoteProxy) {
......@@ -6346,7 +6383,11 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence,
result.data.reclaim();
result.reply.reclaim();
}
FA.connectAbility(want, connect);
//FA模型使用此方法链接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的sendMessageRequest接口方法发送消息
......@@ -6358,7 +6399,7 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence,
data.writeInt(1);
data.writeString("hello");
try {
proxy.sendRequest(1, data, reply, option, sendRequestCallback);
proxy.sendMessageRequest(1, data, reply, option, sendRequestCallback);
} catch(error) {
console.info("rpc send sequence request fail, errorCode " + error.code);
console.info("rpc send sequence request fail, errorMessage " + error.message);
......@@ -6378,7 +6419,7 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| -------- | ----------------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 |
| data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的&nbsp;MessageParcel对象。 |
| reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 |
......@@ -6387,10 +6428,12 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function(elementName, remoteProxy) {
......@@ -6421,7 +6464,11 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
result.data.reclaim();
result.reply.reclaim();
}
FA.connectAbility(want, connect);
//FA模型使用此方法链接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的sendRequest接口方法发送消息
......@@ -6460,22 +6507,24 @@ getLocalInterface(interface: string): IRemoteBroker
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900006 | only remote object permitted |
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function(elementName, remoteProxy) {
console.log("RpcClient: js onConnect called.");
proxy = remoteProxy;
},
onDisconnect: function (elementName) {
onDisconnect: function(elementName) {
console.log("RpcClient: onDisconnect");
},
onFailed: function() {
......@@ -6483,10 +6532,14 @@ getLocalInterface(interface: string): IRemoteBroker
}
};
let want = {
"bundleName":"com.ohos.server",
"abilityName":"com.ohos.server.EntryAbility",
"bundleName": "com.ohos.server",
"abilityName": "com.ohos.server.EntryAbility",
};
FA.connectAbility(want, connect);
//FA模型使用此方法连接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的getLocalInterface接口方法查询接口对象
......@@ -6525,17 +6578,19 @@ queryLocalInterface(interface: string): IRemoteBroker
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function(elementName, remoteProxy) {
console.log("RpcClient: js onConnect called.");
proxy = remoteProxy;
},
onDisconnect: function (elementName) {
onDisconnect: function(elementName) {
console.log("RpcClient: onDisconnect");
},
onFailed: function() {
......@@ -6543,10 +6598,14 @@ queryLocalInterface(interface: string): IRemoteBroker
}
};
let want = {
"bundleName":"com.ohos.server",
"abilityName":"com.ohos.server.EntryAbility",
"bundleName": "com.ohos.server",
"abilityName": "com.ohos.server.EntryAbility",
};
FA.connectAbility(want, connect);
//FA模型使用此方法连接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的queryLocalInterface接口获取接口对象
......@@ -6576,15 +6635,17 @@ registerDeathRecipient(recipient: DeathRecipient, flags: number): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900008 | proxy or remote object is invalid |
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function(elementName, remoteProxy) {
......@@ -6602,7 +6663,11 @@ registerDeathRecipient(recipient: DeathRecipient, flags: number): void
"bundleName": "com.ohos.server",
"abilityName": "com.ohos.server.EntryAbility",
};
FA.connectAbility(want, connect);
//FA模型使用此方法连接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的registerDeathRecipient接口注册死亡回调
......@@ -6642,15 +6707,17 @@ addDeathRecipient(recipient: DeathRecipient, flags: number): boolean
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| ------- | ---------------------------------------- |
| boolean | true：回调注册成功，false：回调注册失败。|
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function(elementName, remoteProxy) {
......@@ -6668,7 +6735,11 @@ addDeathRecipient(recipient: DeathRecipient, flags: number): boolean
"bundleName": "com.ohos.server",
"abilityName": "com.ohos.server.EntryAbility",
};
FA.connectAbility(want, connect);
//FA模型使用此方法连接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的addDeathRecippient接口方法新增死亡回调
......@@ -6703,15 +6774,17 @@ unregisterDeathRecipient(recipient: DeathRecipient, flags: number): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900008 | proxy or remote object is invalid |
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function(elementName, remoteProxy) {
......@@ -6729,7 +6802,11 @@ unregisterDeathRecipient(recipient: DeathRecipient, flags: number): void
"bundleName": "com.ohos.server",
"abilityName": "com.ohos.server.EntryAbility",
};
FA.connectAbility(want, connect);
//FA模型使用此方法连接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的unregisterDeathRecipient接口方法注销死亡回调
......@@ -6770,15 +6847,17 @@ removeDeathRecipient(recipient: DeathRecipient, flags: number): boolean
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| ------- | ---------------------------------------- |
| boolean | true：回调注销成功，false：回调注销失败。|
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function(elementName, remoteProxy) {
......@@ -6796,7 +6875,11 @@ removeDeathRecipient(recipient: DeathRecipient, flags: number): boolean
"bundleName": "com.ohos.server",
"abilityName": "com.ohos.server.EntryAbility",
};
FA.connectAbility(want, connect);
//FA模型使用此方法连接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的removeDeathRecipient接口方法去注册死亡回调
......@@ -6831,16 +6914,18 @@ getDescriptor(): string
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| -------- | ------- |
| -------- | -------- |
| 1900008 | proxy or remote object is invalid |
| 1900007 | communication failed |
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function(elementName, remoteProxy) {
......@@ -6858,7 +6943,11 @@ getDescriptor(): string
"bundleName": "com.ohos.server",
"abilityName": "com.ohos.server.EntryAbility",
};
FA.connectAbility(want, connect);
//FA模型使用此方法连接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的getDescriptor接口方法获取对象的接口描述符
......@@ -6890,10 +6979,12 @@ getInterfaceDescriptor(): string
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function(elementName, remoteProxy) {
......@@ -6911,7 +7002,11 @@ getInterfaceDescriptor(): string
"bundleName": "com.ohos.server",
"abilityName": "com.ohos.server.EntryAbility",
};
FA.connectAbility(want, connect);
//FA模型使用此方法连接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的getInterfaceDescriptor接口方法查询当前代理对象接口的描述符
......@@ -6932,15 +7027,17 @@ isObjectDead(): boolean
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------------------- |
| boolean | true：对应的对象已经死亡，false：对应的对象未死亡|
| ------- | ------------------------------------------------- |
| boolean | true：对应的对象已经死亡，false：对应的对象未死亡 |
**示例：**
获取服务
Stage模型的应用在获取服务前需要先获取context，具体方法可参考[获取context](#获取context)
```ts
import FA from "@ohos.ability.featureAbility";
//仅FA模型需要导入@ohos.ability.featureAbility
//import FA from "@ohos.ability.featureAbility";
let proxy;
let connect = {
onConnect: function(elementName, remoteProxy) {
......@@ -6958,7 +7055,11 @@ isObjectDead(): boolean
"bundleName": "com.ohos.server",
"abilityName": "com.ohos.server.EntryAbility",
};
FA.connectAbility(want, connect);
//FA模型使用此方法连接服务
//FA.connectAbility(want,connect);
globalThis.context.connectServiceExtensionAbility(want, connect);
```
上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的isObjectDead接口方法判断当前对象是否已经死亡
......@@ -7042,8 +7143,8 @@ isAsync(): boolean;
**返回值：**
| 类型 | 说明 |
| ------- | ------------------------------------ |
| boolean | true：同步调用成功，false：异步调用成功。 |
| ------- | ---------------------------------------- |
| boolean | true：同步调用成功，false：异步调用成功。|
**示例：**
......@@ -7350,7 +7451,7 @@ static isLocalCalling(): boolean
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------------------- |
| ------- | -------------------------------------------------- |
| boolean | true：调用在同一台设备，false：调用未在同一台设备。|
**示例：**
......@@ -7523,7 +7624,7 @@ static setCallingIdentity(identity: string): boolean
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------------------- |
| ------- | ---------------------------------|
| boolean | true：设置成功，false：设置失败。|
**示例：**
......@@ -7576,7 +7677,7 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| ------- | ----------------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 |
| data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的&nbsp;MessageParcel对象。 |
| reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 |
......@@ -7585,7 +7686,7 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| ------- | -------------------------------- |
| boolean | true：发送成功，false：发送失败。|
**示例：**
......@@ -7642,7 +7743,7 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| ------- | ----------------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 |
| data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的&nbsp;MessageParcel对象。 |
| reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 |
......@@ -7712,7 +7813,7 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence,
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| ------- | ------------------------------------ | ---- | -------------------------------------------------------------------------------------- |
| code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 |
| data | [MessageSequence](#messagesequence9) | 是 | 保存待发送数据的&nbsp;MessageSequence对象。 |
| reply | [MessageSequence](#messagesequence9) | 是 | 接收应答数据的MessageSequence对象。 |
......@@ -7768,7 +7869,7 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence,
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | ---------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| ------------- | ------------------------------------ | ---- | -------------------------------------------------------------------------------------- |
| code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 |
| data | [MessageSequence](#messagesequence9) | 是 | 保存待发送数据的&nbsp;MessageSequence对象。 |
| reply | [MessageSequence](#messagesequence9) | 是 | 接收应答数据的MessageSequence对象。 |
......@@ -7818,7 +7919,7 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | -------------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| ------------- | ----------------------------------------- | ---- | -------------------------------------------------------------------------------------- |
| code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 |
| data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的&nbsp;MessageParcel对象。 |
| reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 |
......@@ -7882,7 +7983,7 @@ sendMessageRequest请求的响应处理函数，服务端在该函数里处理
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------------- | ---- | --------------------------------------- |
| ------ | ----------------------------------------- | ---- | --------------------------------------- |
| code | number | 是 | 对端发送的服务请求码。 |
| data | [MessageParcel](#messageparceldeprecated) | 是 | 携带客户端调用参数的MessageParcel对象。 |
| reply | [MessageParcel](#messageparceldeprecated) | 是 | 写入结果的MessageParcel对象。 |
......@@ -7891,7 +7992,7 @@ sendMessageRequest请求的响应处理函数，服务端在该函数里处理
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------------------- |
| ------- | -------------------------------- |
| boolean | true：操作成功，false：操作失败。|
**示例：**
......@@ -7943,7 +8044,7 @@ sendMessageRequest请求的响应处理函数，服务端在该函数里同步
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------------- | ---- | ----------------------------------------- |
| ------ | ------------------------------------ | ---- | ----------------------------------------- |
| code | number | 是 | 对端发送的服务请求码。 |
| data | [MessageSequence](#messagesequence9) | 是 | 携带客户端调用参数的MessageSequence对象。 |
| reply | [MessageSequence](#messagesequence9) | 是 | 写入结果的MessageSequence对象。 |
......@@ -7952,7 +8053,7 @@ sendMessageRequest请求的响应处理函数，服务端在该函数里同步
**返回值：**
| 类型 | 说明 |
| ----------------- | ---------------------------------------------------------------------------------------------- |
| ----------------- | ----------------------------------------------------------------------------------------------- |
| boolean | 若在onRemoteMessageRequest中同步地处理请求，则返回一个布尔值：true：操作成功，false：操作失败。 |
| Promise\<boolean> | 若在onRemoteMessageRequest中异步地处理请求，则返回一个Promise对象。 |
......@@ -8233,7 +8334,7 @@ getDescriptor(): string
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900008 | proxy or remote object is invalid |
**示例：**
......@@ -8625,7 +8726,7 @@ mapTypedAshmem(mapType: number): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | ------ |
| -------- | -------- |
| 1900001 | call mmap function failed |
**示例：**
......@@ -8659,7 +8760,7 @@ mapAshmem(mapType: number): boolean
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------------------- |
| ------- | -------------------------------- |
| boolean | true：映射成功，false：映射失败。|
**示例：**
......@@ -8683,7 +8784,7 @@ mapReadWriteAshmem(): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900001 | call mmap function failed |
**示例：**
......@@ -8711,7 +8812,7 @@ mapReadAndWriteAshmem(): boolean
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------------------- |
| ------- | -------------------------------- |
| boolean | true：映射成功，false：映射失败。|
**示例：**
......@@ -8735,7 +8836,7 @@ mapReadonlyAshmem(): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900001 | call mmap function failed |
**示例：**
......@@ -8763,7 +8864,7 @@ mapReadOnlyAshmem(): boolean
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------------------- |
| ------- | -------------------------------- |
| boolean | true：映射成功，false：映射失败。|
**示例：**
......@@ -8793,7 +8894,7 @@ setProtectionType(protectionType: number): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| -------- | ------- |
| -------- | -------- |
| 1900002 | call os ioctl function failed |
**示例：**
......@@ -8827,7 +8928,7 @@ setProtection(protectionType: number): boolean
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------------------- |
| ------- | -------------------------------- |
| boolean | true：设置成功，false：设置失败。|
**示例：**
......@@ -8859,7 +8960,7 @@ writeAshmem(buf: number[], size: number, offset: number): void
以下错误码的详细介绍请参见[ohos.rpc错误码](../errorcodes/errorcode-rpc.md)
| 错误码ID | 错误信息 |
| ------- | -------- |
| -------- | -------- |
| 1900003 | write to ashmem failed |
**示例：**
......@@ -8897,8 +8998,8 @@ writeToAshmem(buf: number[], size: number, offset: number): boolean
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------------------------------------------------------------------- |
| boolean | true：如果数据写入成功，false：在其他情况下，如数据写入越界或未获得写入权限。。 |
| ------- | ----------------------------------------------------------------------------- |
| boolean | true：如果数据写入成功，false：在其他情况下，如数据写入越界或未获得写入权限。 |
**示例：**
......@@ -8981,7 +9082,7 @@ readFromAshmem(size: number, offset: number): number[]
**示例：**
```ts
``` ts
let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024);
let mapResult = ashmem.mapReadAndWriteAshmem();
console.info("RpcTest map ashmem result is " + mapResult);
......@@ -8991,3 +9092,37 @@ readFromAshmem(size: number, offset: number): number[]
let readResult = ashmem.readFromAshmem(5, 0);
console.log("RpcTest: read to Ashmem result is : " + readResult);
```
## 获取context
**示例：**
```ts
import Ability from '@ohos.app.ability.UIAbility';
export default class MainAbility extends Ability {
onCreate(want, launchParam) {
console.log("[Demo] MainAbility onCreate");
globalThis.context = this.context;
}
onDestroy() {
console.log("[Demo] MainAbility onDestroy");
}
onWindowStageCreate(windowStage) {
// Main window is created, set main page for this ability
console.log("[Demo] MainAbility onWindowStageCreate");
}
onWindowStageDestroy() {
// Main window is destroyed, release UI related resources
console.log("[Demo] MainAbility onWindowStageDestroy");
}
onForeground() {
// Ability has brought to foreground
console.log("[Demo] MainAbility onForeground");
}
onBackground() {
// Ability has back to background
console.log("[Demo] MainAbility onBackground");
}
};
```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或