diff --git a/zh-cn/application-dev/reference/apis/js-apis-rpc.md b/zh-cn/application-dev/reference/apis/js-apis-rpc.md index e8b88c0404bbe9d0b477551168012e76de16f728..600db31d22c1b9e08f00dc3fe461212e50e6c076 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-rpc.md +++ b/zh-cn/application-dev/reference/apis/js-apis-rpc.md @@ -3131,7 +3131,9 @@ readRawData(size: number): number[] ## MessageParcel(deprecated) -在RPC过程中，发送方可以使用MessageParcel提供的写方法，将待发送的数据以特定格式写入该对象。接收方可以使用MessageParcel提供的读方法从该对象中读取特定格式的数据。数据格式包括：基础类型及数组、IPC对象、接口描述符和自定义序列化对象。建议后续使用MessageSequence类替代。 +>从API version 9 开始不再维护，建议使用[MessageSequence](#messagesequence9)类替代。 + +在RPC过程中，发送方可以使用MessageParcel提供的写方法，将待发送的数据以特定格式写入该对象。接收方可以使用MessageParcel提供的读方法从该对象中读取特定格式的数据。数据格式包括：基础类型及数组、IPC对象、接口描述符和自定义序列化对象。 ### create @@ -4023,7 +4025,9 @@ writeString(val: string): boolean 将字符串值写入MessageParcel实例。 **系统能力**：SystemCapability.Communication.IPC.Core + **参数：** + | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ----------------------------------------- | | val | string | 是 | 要写入的字符串值，其长度应小于40960字节。 | @@ -4128,7 +4132,7 @@ readSequenceable(dataIn: Sequenceable) : boolean | 参数名 | 类型 | 必填 | 说明 | | ------ | ----------------------------- | ---- | --------------------------------------- | - | dataIn | [Sequenceable](#sequenceable) | 是 | 需要从MessageParcel读取成员变量的对象。 | + | dataIn | [Sequenceable](#sequenceabledeprecated) | 是 | 需要从MessageParcel读取成员变量的对象。 | **返回值：** @@ -5137,6 +5141,7 @@ readRemoteObjectArray(objects: IRemoteObject[]): void **系统能力**：SystemCapability.Communication.IPC.Core **参数：** + | 参数名 | 类型 | 必填 | 说明 | | ------- | --------------- | ---- | --------- | | objects | IRemoteObject[] | 是 | 从MessageParcel读取的IRemoteObject对象数组。 | @@ -5510,9 +5515,6 @@ readRawData(size: number): number[] ## Parcelable9+ -> **说明：** -> 本类从API version 9开始启用，代替Sequenceable类。 - 在进程间通信（IPC）期间，将类的对象写入MessageSequence并从MessageSequence中恢复它们。 ### marshalling @@ -5619,7 +5621,9 @@ unmarshalling(dataIn: MessageSequence) : boolean ## Sequenceable(deprecated) -在进程间通信（IPC）期间，将类的对象写入MessageParcel并从MessageParcel中恢复它们。后续使用Parcelable类替代。 +>从API version 9 开始不再维护，建议使用[Parcelable](#parcelable9)类替代。 + +在进程间通信（IPC）期间，将类的对象写入MessageParcel并从MessageParcel中恢复它们。 ### marshalling @@ -5633,7 +5637,7 @@ marshalling(dataOut: MessageParcel): boolean | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | ----------------------------------------- | - | dataOut | [MessageParcel](#messageparcel) | 是 | 可序列对象将被封送到的MessageParcel对象。 | + | dataOut | [MessageParcel](#messageparceldeprecated) | 是 | 可序列对象将被封送到的MessageParcel对象。 | **返回值：** @@ -5684,7 +5688,7 @@ unmarshalling(dataIn: MessageParcel) : boolean | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------------- | ---- | --------------------------------------------- | - | dataIn | [MessageParcel](#messageparcel) | 是 | 已将可序列对象封送到其中的MessageParcel对象。 | + | dataIn | [MessageParcel](#messageparceldeprecated) | 是 | 已将可序列对象封送到其中的MessageParcel对象。 | **返回值：** @@ -5793,25 +5797,27 @@ onRemoteDied(): void **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.IPC.Core。 - | 参数： | 值 | 说明 | - | ------- | --------------- | ------------------------------------- | - | errCode | number | 错误码。 | - | code | number | 消息代码。 | - | data | MessageSequence | 发送给对端进程的MessageSequence对象。 | - | reply | MessageSequence | 对端进程返回的MessageSequence对象。 | + | 参数名 | 类型 | 必填 | 说明 | + | ------- | --------------- | ---- | ------------------------------------- | + | errCode | number | 是 | 错误码。 | + | code | number | 是 | 消息代码。 | + | data | MessageSequence | 是 | 发送给对端进程的MessageSequence对象。 | + | reply | MessageSequence | 是 | 对端进程返回的MessageSequence对象。 | ## SendRequestResult8+(deprecated) -发送请求的响应结果。后续使用RequestResult类替代。 +>从API version 9 开始不再维护，建议使用[RequestResult](#requestresult9)类替代。 + +发送请求的响应结果。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.IPC.Core。 - | 参数： | 值 | 说明 | - | ------- | ------------- | ----------------------------------- | - | errCode | number | 错误码。 | - | code | number | 消息代码。 | - | data | MessageParcel | 发送给对端进程的MessageParcel对象。 | - | reply | MessageParcel | 对端进程返回的MessageParcel对象。 | + | 参数名 | 类型 | 必填 | 说明 | + | ------- | ------------- | ---- | ----------------------------------- | + | errCode | number | 是 | 错误码。 | + | code | number | 是 | 消息代码。 | + | data | MessageParcel | 是 | 发送给对端进程的MessageParcel对象。 | + | reply | MessageParcel | 是 | 对端进程返回的MessageParcel对象。 | ## IRemoteObject @@ -5839,9 +5845,11 @@ getLocalInterface(descriptor: string): IRemoteBroker ### queryLocalInterface(deprecated) +>从API version 9 开始不再维护，建议使用[getLocalInterface](#getlocalinterface9)类替代。 + queryLocalInterface(descriptor: string): IRemoteBroker -查询接口。后续使用getLocalInterface方法替代。 +查询接口。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -5860,9 +5868,11 @@ queryLocalInterface(descriptor: string): IRemoteBroker ### sendRequest(deprecated) +>从API version 9 开始不再维护，建议使用[sendMessageRequest](#sendmessagerequest9)类替代。 + sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): boolean -以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则期约立即兑现，reply报文里没有内容。如果为选项设置了同步模式，则期约将在sendRequest返回时兑现，回复内容在reply报文里。建议使用sendMessageRequest9+替代。 +以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则期约立即兑现，reply报文里没有内容。如果为选项设置了同步模式，则期约将在sendRequest返回时兑现，回复内容在reply报文里。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -5871,8 +5881,8 @@ sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | ---- | | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | - | data | [MessageParcel](#messageparcel) | 是 | 保存待发送数据的 MessageParcel对象。 | - | reply | [MessageParcel](#messageparcel) | 是 | 接收应答数据的MessageParcel对象。 | + | data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的 MessageParcel对象。 | + | reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 | | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | **返回值：** @@ -5884,9 +5894,11 @@ sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options ### sendRequest8+(deprecated) +>从API version 9 开始不再维护，建议使用[sendMessageRequest](#sendmessagerequest9)类替代。 + sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<SendRequestResult> -以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则期约立即兑现，reply报文里没有内容。如果为选项设置了同步模式，则期约将在sendRequest返回时兑现，回复内容在reply报文里。后续建议使用sendMessageRequest9+替代。 +以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则期约立即兑现，reply报文里没有内容。如果为选项设置了同步模式，则期约将在sendRequest返回时兑现，回复内容在reply报文里。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -5895,8 +5907,8 @@ sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | -------------------------------------------------------------------------------------- | | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | - | data | [MessageParcel](#messageparcel) | 是 | 保存待发送数据的 MessageParcel对象。 | - | reply | [MessageParcel](#messageparcel) | 是 | 接收应答数据的MessageParcel对象。 | + | data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的 MessageParcel对象。 | + | reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 | | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | **返回值：** @@ -5919,8 +5931,8 @@ sendMessageRequest(code : number, data : MessageSequence, reply : MessageSequenc | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | -------------------------------------------------------------------------------------- | | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | - | data | MessageSequence | 是 | 保存待发送数据的 MessageSequence对象。 | - | reply | MessageSequence | 是 | 接收应答数据的MessageSequence对象。 | + | data | [MessageSequence](#messagesequence9) | 是 | 保存待发送数据的 MessageSequence对象。 | + | reply | [MessageSequence](#messagesequence9) | 是 | 接收应答数据的MessageSequence对象。 | | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | **返回值：** @@ -5943,17 +5955,19 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence, | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------- | ---- | -------------------------------------------------------------------------------------- | | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | - | data | MessageSequence | 是 | 保存待发送数据的 MessageSequence对象。 | - | reply | MessageSequence | 是 | 接收应答数据的MessageSequence对象。 | + | data | [MessageSequence](#messagesequence9) | 是 | 保存待发送数据的 MessageSequence对象。 | + | reply | [MessageSequence](#messagesequence9) | 是 | 接收应答数据的MessageSequence对象。 | | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | | callback | AsyncCallback<RequestResult> | 是 | 接收发送结果的回调。 | ### sendRequest8+(deprecated) +>从API version 9 开始不再维护，建议使用[sendMessageRequest](#sendmessagerequest9)类替代。 + sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: MessageOption, callback: AsyncCallback<SendRequestResult>): void -以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则立即收到回调，reply报文里没有内容。如果为选项设置了同步模式，则将在sendRequest返回时收到回调，回复内容在reply报文里。后续建议使用sendMessageRequest替代。 +以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则立即收到回调，reply报文里没有内容。如果为选项设置了同步模式，则将在sendRequest返回时收到回调，回复内容在reply报文里。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -5962,8 +5976,8 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | -------------------------------------------------------------------------------------- | | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | - | data | [MessageParcel](#messageparcel) | 是 | 保存待发送数据的 MessageParcel对象。 | - | reply | [MessageParcel](#messageparcel) | 是 | 接收应答数据的MessageParcel对象。 | + | data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的 MessageParcel对象。 | + | reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 | | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | | callback | AsyncCallback<SendRequestResult> | 是 | 接收发送结果的回调。 | @@ -5994,9 +6008,11 @@ registerDeathRecipient(recipient: DeathRecipient, flags: number): void ### addDeathrecipient(deprecated) +>从API version 9 开始不再维护，建议使用[registerDeathRecipient](#registerdeathrecipient9)类替代。 + addDeathRecipient(recipient: DeathRecipient, flags: number): boolean -注册用于接收远程对象死亡通知的回调。如果与RemoteProxy对象匹配的远程对象进程死亡，则调用此方法。建议使用registerDeathRecipient替代。 +注册用于接收远程对象死亡通知的回调。如果与RemoteProxy对象匹配的远程对象进程死亡，则调用此方法。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -6040,9 +6056,11 @@ removeDeathRecipient(recipient: DeathRecipient, flags: number): void ### removeDeathRecipient(deprecated) +>从API version 9 开始不再维护，建议使用[unregisterDeathRecipient](#unregisterdeathrecipient9)类替代。 + removeDeathRecipient(recipient: DeathRecipient, flags: number): boolean -注销用于接收远程对象死亡通知的回调。建议使用unregisterDeathRecipient替代。 +注销用于接收远程对象死亡通知的回调。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -6085,9 +6103,11 @@ getDescriptor(): string ### getInterfaceDescriptor(deprecated) +>从API version 9 开始不再维护，建议使用[getDescriptor](#getdescriptor9)类替代。 + getInterfaceDescriptor(): string -获取对象的接口描述符。接口描述符为字符串。建议使用getDescriptor替代。 +获取对象的接口描述符。接口描述符为字符串。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -6119,7 +6139,7 @@ isObjectDead(): boolean **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.IPC.Core。 -| 参数： | 值 | 说明 | +| 参数名 | 值 | 说明 | | --------------------- | ----------------------- | --------------------------------- | | PING_TRANSACTION | 1599098439 (0x5f504e47) | 内部指令码，用于测试IPC服务正常。 | | DUMP_TRANSACTION | 1598311760 (0x5f444d50) | 内部指令码，获取Binder内部状态。 | @@ -6130,9 +6150,11 @@ isObjectDead(): boolean ### sendRequest(deprecated) +>从API version 9 开始不再维护，建议使用[sendMessageRequest](#sendmessagerequest9)类替代。 + sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): boolean -以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则期约立即兑现，reply报文里没有内容。如果为选项设置了同步模式，则期约将在sendRequest返回时兑现，回复内容在reply报文里。建议使用sendMessageRequest9+替代。 +以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则期约立即兑现，reply报文里没有内容。如果为选项设置了同步模式，则期约将在sendRequest返回时兑现，回复内容在reply报文里。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -6141,8 +6163,8 @@ sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | -------------------------------------------------------------------------------------- | | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | - | data | [MessageParcel](#messageparcel) | 是 | 保存待发送数据的 MessageParcel对象。 | - | reply | [MessageParcel](#messageparcel) | 是 | 接收应答数据的MessageParcel对象。 | + | data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的 MessageParcel对象。 | + | reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 | | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | **返回值：** @@ -6204,8 +6226,8 @@ sendMessageRequest(code : number, data : MessageSequence, reply : MessageSequenc | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | -------------------------------------------------------------------------------------- | | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | - | data | MessageSequence | 是 | 保存待发送数据的 MessageSequence对象。 | - | reply | MessageSequence | 是 | 接收应答数据的MessageSequence对象。 | + | data | [MessageSequence](#messagesequence9) | 是 | 保存待发送数据的 MessageSequence对象。 | + | reply | [MessageSequence](#messagesequence9) | 是 | 接收应答数据的MessageSequence对象。 | | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | **返回值：** @@ -6263,9 +6285,11 @@ sendMessageRequest(code : number, data : MessageSequence, reply : MessageSequenc ### sendRequest8+(deprecated) +>从API version 9 开始不再维护，建议使用[sendMessageRequest](#sendmessagerequest9)类替代。 + sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<SendRequestResult> -以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则期约立即兑现，reply报文里没有内容。如果为选项设置了同步模式，则期约将在sendRequest返回时兑现，回复内容在reply报文里。建议使用sendMessageRequest9+替代。 +以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则期约立即兑现，reply报文里没有内容。如果为选项设置了同步模式，则期约将在sendRequest返回时兑现，回复内容在reply报文里。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -6274,8 +6298,8 @@ sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | -------------------------------------------------------------------------------------- | | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | - | data | [MessageParcel](#messageparcel) | 是 | 保存待发送数据的 MessageParcel对象。 | - | reply | [MessageParcel](#messageparcel) | 是 | 接收应答数据的MessageParcel对象。 | + | data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的 MessageParcel对象。 | + | reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 | | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | **返回值：** @@ -6343,8 +6367,8 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence, | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------- | ---- | -------------------------------------------------------------------------------------- | | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | - | data | MessageSequence | 是 | 保存待发送数据的 MessageSequence对象。 | - | reply | MessageSequence | 是 | 接收应答数据的MessageSequence对象。 | + | data | [MessageSequence](#messagesequence9) | 是 | 保存待发送数据的 MessageSequence对象。 | + | reply | [MessageSequence](#messagesequence9) | 是 | 接收应答数据的MessageSequence对象。 | | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | | callback | AsyncCallback<RequestResult> | 是 | 接收发送结果的回调。 | @@ -6400,8 +6424,10 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence, ### sendRequest8+(deprecated) +>从API version 9 开始不再维护，建议使用[sendMessageRequest](#sendmessagerequest9)类替代。 + sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: MessageOption, callback: AsyncCallback<SendRequestResult>): void -以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则立即收到回调，reply报文里没有内容。如果为选项设置了同步模式，则将在sendRequest返回时收到回调，回复内容在reply报文里。建议使用sendMessageRequest替代。 +以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则立即收到回调，reply报文里没有内容。如果为选项设置了同步模式，则将在sendRequest返回时收到回调，回复内容在reply报文里。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -6410,8 +6436,8 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | -------------------------------------------------------------------------------------- | | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | - | data | [MessageParcel](#messageparcel) | 是 | 保存待发送数据的 MessageParcel对象。 | - | reply | [MessageParcel](#messageparcel) | 是 | 接收应答数据的MessageParcel对象。 | + | data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的 MessageParcel对象。 | + | reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 | | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | | callback | AsyncCallback<SendRequestResult> | 是 | 接收发送结果的回调。 | @@ -6514,9 +6540,11 @@ getLocalInterface(interface: string): IRemoteBroker ### queryLocalInterface(deprecated) +>从API version 9 开始不再维护，建议使用[getLocalInterface](#getlocalinterface9)类替代。 + queryLocalInterface(interface: string): IRemoteBroker -查询并获取当前接口描述符对应的本地接口对象。建议使用getLocalInterface替代。 +查询并获取当前接口描述符对应的本地接口对象。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -6621,9 +6649,11 @@ registerDeathRecipient(recipient: DeathRecipient, flags: number): void ### addDeathRecippient(deprecated) +>从API version 9 开始不再维护，建议使用[registerDeathRecipient](#registerdeathrecipient9)类替代。 + addDeathRecipient(recipient : DeathRecipient, flags : number): boolean -注册用于接收远程对象死亡通知的回调，增加proxy对象上的死亡通知。建议使用registerDeathRecipient替代。 +注册用于接收远程对象死亡通知的回调，增加proxy对象上的死亡通知。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -6673,7 +6703,7 @@ addDeathRecipient(recipient : DeathRecipient, flags : number): boolean ### unregisterDeathRecipient9+ -removeDeathRecipient(recipient: DeathRecipient, flags: number): void +unregisterDeathRecipient(recipient: DeathRecipient, flags: number): void 注销用于接收远程对象死亡通知的回调。 @@ -6734,9 +6764,11 @@ removeDeathRecipient(recipient: DeathRecipient, flags: number): void ### removeDeathRecipient(deprecated) +>从API version 9 开始不再维护，建议使用[unregisterDeathRecipient](#unregisterdeathrecipient9)类替代。 + removeDeathRecipient(recipient : DeathRecipient, flags : number): boolean -注销用于接收远程对象死亡通知的回调。建议使用unregisterDeathRecipient替代。 +注销用于接收远程对象死亡通知的回调。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -6807,6 +6839,7 @@ getInterfaceDescriptor(): string | 错误码ID | 错误信息 | | -------- | ------- | | 1900008 | proxy or remote object is invalid | + | 1900007 | communication failed | **示例：** @@ -6842,9 +6875,11 @@ getInterfaceDescriptor(): string ### getInterfaceDescriptor(deprecated) +>从API version 9 开始不再维护，建议使用[getDescriptor](#getdescriptor9)类替代。 + getInterfaceDescriptor(): string -查询当前代理对象接口的描述符。建议使用getDescriptor替代。 +查询当前代理对象接口的描述符。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -6928,7 +6963,7 @@ isObjectDead(): boolean **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.IPC.Core。 - | 参数： | 值 | 说明 | + | 参数名 | 值 | 说明 | | ------------- | ---- | ----------------------------------------------------------- | | TF_SYNC | 0 | 同步调用。 | | TF_ASYNC | 1 | 异步调用。 | @@ -7267,8 +7302,8 @@ static flushCmdBuffer(object : IRemoteObject): void constructor(descriptor) { super(descriptor); } - addDeathRecipient(recipient: MyDeathRecipient, flags: number); - removeDeathRecipient(recipient: MyDeathRecipient, flags: number); + registerDeathRecipient(recipient: MyDeathRecipient, flags: number); + unregisterDeathRecipient(recipient: MyDeathRecipient, flags: number); isObjectDead(): boolean { return false; } @@ -7285,9 +7320,11 @@ static flushCmdBuffer(object : IRemoteObject): void ### flushCommands(deprecated) +>从API version 9 开始不再维护，建议使用[flushCmdBuffer](#flushcmdbuffer9)类替代。 + static flushCommands(object : IRemoteObject): number -将所有挂起的命令从指定的RemoteProxy刷新到相应的RemoteObject。建议在执行任何时间敏感操作之前调用此方法。使用flushCmdBuffer替代。 +将所有挂起的命令从指定的RemoteProxy刷新到相应的RemoteObject。建议在执行任何时间敏感操作之前调用此方法。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -7391,9 +7428,11 @@ static restoreCallingIdentity(identity : string): void ### setCallingIdentity(deprecated) +>从API version 9 开始不再维护，建议使用[restoreCallingIdentity](#restorecallingidentity9)类替代。 + static setCallingIdentity(identity : string): boolean -将UID和PID恢复为远程用户的UID和PID。它通常在使用resetCallingIdentity后调用，需要resetCallingIdentity返回的远程用户的UID和PID。建议使用restoreCallingIdentity替代。 +将UID和PID恢复为远程用户的UID和PID。它通常在使用resetCallingIdentity后调用，需要resetCallingIdentity返回的远程用户的UID和PID。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -7449,6 +7488,8 @@ RemoteObject构造函数。 ### sendRequest(deprecated) +>从API version 9 开始不再维护，建议使用[sendMessageRequest](#sendmessagerequest9)类替代。 + sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): boolean 以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则期约立即兑现，reply报文里没有内容。如果为选项设置了同步模式，则期约将在sendRequest返回时兑现，回复内容在reply报文里。 @@ -7460,8 +7501,8 @@ sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | -------------------------------------------------------------------------------------- | | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | - | data | [MessageParcel](#messageparcel) | 是 | 保存待发送数据的 MessageParcel对象。 | - | reply | [MessageParcel](#messageparcel) | 是 | 接收应答数据的MessageParcel对象。 | + | data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的 MessageParcel对象。 | + | reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 | | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | **返回值：** @@ -7514,9 +7555,11 @@ sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options ### sendRequest8+(deprecated) +>从API version 9 开始不再维护，建议使用[sendMessageRequest](#sendmessagerequest9)类替代。 + sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<SendRequestResult> -以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则期约立即兑现，reply报文里没有内容。如果为选项设置了同步模式，则期约将在sendRequest返回时兑现，回复内容在reply报文里。建议使用sendMessageRequest9+替代。 +以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则期约立即兑现，reply报文里没有内容。如果为选项设置了同步模式，则期约将在sendRequest返回时兑现，回复内容在reply报文里。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -7525,8 +7568,8 @@ sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | -------------------------------------------------------------------------------------- | | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | - | data | [MessageParcel](#messageparcel) | 是 | 保存待发送数据的 MessageParcel对象。 | - | reply | [MessageParcel](#messageparcel) | 是 | 接收应答数据的MessageParcel对象。 | + | data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的 MessageParcel对象。 | + | reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 | | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | **返回值：** @@ -7595,8 +7638,8 @@ sendMessageRequest(code : number, data : MessageSequence, reply : MessageSequenc | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | -------------------------------------------------------------------------------------- | | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | - | data | MessageSequence | 是 | 保存待发送数据的 MessageSequence对象。 | - | reply | MessageSequence | 是 | 接收应答数据的MessageSequence对象。 | + | data | [MessageSequence](#messagesequence9) | 是 | 保存待发送数据的 MessageSequence对象。 | + | reply | [MessageSequence](#messagesequence9) | 是 | 接收应答数据的MessageSequence对象。 | | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | **返回值：** @@ -7662,8 +7705,8 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence, | 参数名 | 类型 | 必填 | 说明 | | ------------- | ---------------------------------- | ---- | -------------------------------------------------------------------------------------- | | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | - | data | MessageSequence | 是 | 保存待发送数据的 MessageSequence对象。 | - | reply | MessageSequence | 是 | 接收应答数据的MessageSequence对象。 | + | data | [MessageSequence](#messagesequence9) | 是 | 保存待发送数据的 MessageSequence对象。 | + | reply | [MessageSequence](#messagesequence9) | 是 | 接收应答数据的MessageSequence对象。 | | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | | AsyncCallback | AsyncCallback<RequestResult> | 是 | 接收发送结果的回调。 | @@ -7679,10 +7722,8 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence, constructor(descriptor) { super(descriptor); } - addDeathRecipient(recipient: MyDeathRecipient, flags: number); - removeDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean { - return true; - } + registerDeathRecipient(recipient: MyDeathRecipient, flags: number); + unregisterDeathRecipient(recipient: MyDeathRecipient, flags: number); isObjectDead(): boolean { return false; } @@ -7712,9 +7753,11 @@ sendMessageRequest(code: number, data: MessageSequence, reply: MessageSequence, ### sendRequest8+(deprecated) +>从API version 9 开始不再维护，建议使用[sendMessageRequest](#sendmessagerequest9)类替代。 + sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: MessageOption, callback: AsyncCallback<SendRequestResult>): void -以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则立即收到回调，reply报文里没有内容。如果为选项设置了同步模式，则将在sendRequest返回时收到回调，回复内容在reply报文里。建议使用sendMessageRequest替代。 +以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则立即收到回调，reply报文里没有内容。如果为选项设置了同步模式，则将在sendRequest返回时收到回调，回复内容在reply报文里。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -7723,8 +7766,8 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me | 参数名 | 类型 | 必填 | 说明 | | ------------- | -------------------------------------- | ---- | -------------------------------------------------------------------------------------- | | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | - | data | [MessageParcel](#messageparcel) | 是 | 保存待发送数据的 MessageParcel对象。 | - | reply | [MessageParcel](#messageparcel) | 是 | 接收应答数据的MessageParcel对象。 | + | data | [MessageParcel](#messageparceldeprecated) | 是 | 保存待发送数据的 MessageParcel对象。 | + | reply | [MessageParcel](#messageparceldeprecated) | 是 | 接收应答数据的MessageParcel对象。 | | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | | AsyncCallback | AsyncCallback<SendRequestResult> | 是 | 接收发送结果的回调。 | @@ -7775,9 +7818,11 @@ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: Me ### onRemoteRequest8+(deprecated) +>从API version 9 开始不再维护，建议使用[onRemoteRequestEx](#onremoterequestex9)类替代。 + onRemoteRequest(code : number, data : MessageParcel, reply: MessageParcel, options : MessageOption): boolean -sendMessageRequest请求的响应处理函数，服务端在该函数里处理请求，回复结果。建议使用onRemoteRequestEx9+替代。 +sendMessageRequest请求的响应处理函数，服务端在该函数里处理请求，回复结果。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -7786,8 +7831,8 @@ sendMessageRequest请求的响应处理函数，服务端在该函数里处理 | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------------- | ---- | --------------------------------------- | | code | number | 是 | 对端发送的服务请求码。 | - | data | [MessageParcel](#messageparcel) | 是 | 携带客户端调用参数的MessageParcel对象。 | - | reply | [MessageParcel](#messageparcel) | 是 | 写入结果的MessageParcel对象。 | + | data | [MessageParcel](#messageparceldeprecated) | 是 | 携带客户端调用参数的MessageParcel对象。 | + | reply | [MessageParcel](#messageparceldeprecated) | 是 | 写入结果的MessageParcel对象。 | | option | [MessageOption](#messageoption) | 是 | 指示操作是同步还是异步。 | **返回值：** @@ -7847,9 +7892,9 @@ sendMessageRequest请求的响应处理函数，服务端在该函数里同步 | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------------- | ---- | ----------------------------------------- | | code | number | 是 | 对端发送的服务请求码。 | - | data | MessageSequence | 是 | 携带客户端调用参数的MessageSequence对象。 | - | reply | MessageSequence | 是 | 写入结果的MessageSequence对象。 | - | option | MessageSequence(#messageoption) | 是 | 指示操作是同步还是异步。 | + | data | [MessageSequence](#messagesequence9) | 是 | 携带客户端调用参数的MessageSequence对象。 | + | reply | [MessageSequence](#messagesequence9) | 是 | 写入结果的MessageSequence对象。 | + | option | [MessageOption](#messageoption) | 是 | 指示操作是同步还是异步。 | **返回值：** @@ -8124,9 +8169,11 @@ getLocalInterface(descriptor: string): IRemoteBroker ### queryLocalInterface(deprecated) +>从API version 9 开始不再维护，建议使用[getLocalInterface](#getlocalinterface9)类替代。 + queryLocalInterface(descriptor: string): IRemoteBroker -查询并获取当前接口描述符对应的远端对象是否已经存在。建议使用getLocalInterface替代。 +查询并获取当前接口描述符对应的远端对象是否已经存在。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -8222,9 +8269,11 @@ getInterfaceDescriptor(): string ### getInterfaceDescriptor(deprecated) +>从API version 9 开始不再维护，建议使用[getDescriptor](#getdescriptor9)类替代。 + getInterfaceDescriptor(): string -查询接口描述符。建议使用getDescriptor替代。 +查询接口描述符。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -8310,9 +8359,11 @@ modifyLocalInterface(localInterface: IRemoteBroker, descriptor: string): void ### attachLocalInterface(deprecated) +>从API version 9 开始不再维护，建议使用[modifyLocalInterface](#modifylocalinterface9)类替代。 + attachLocalInterface(localInterface: IRemoteBroker, descriptor: string): void -此接口用于把接口描述符和IRemoteBroker对象绑定。建议使用modifyLocalInterface替代。 +此接口用于把接口描述符和IRemoteBroker对象绑定。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -8407,9 +8458,11 @@ static create(name: string, size: number): Ashmem ### createAshmem8+(deprecated) +>从API version 9 开始不再维护，建议使用[create](#create9)类替代。 + static createAshmem(name: string, size: number): Ashmem -根据指定的名称和大小创建Ashmem对象。建议使用create替代。 +根据指定的名称和大小创建Ashmem对象。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -8479,9 +8532,11 @@ static create(ashmem: Ashmem): Ashmem ### createAshmemFromExisting8+(deprecated) +>从API version 9 开始不再维护，建议使用[create](#create9)类替代。 + static createAshmemFromExisting(ashmem: Ashmem): Ashmem -通过复制现有Ashmem对象的文件描述符(fd)来创建Ashmem对象。两个Ashmem对象指向同一个共享内存区域。建议使用create替代。 +通过复制现有Ashmem对象的文件描述符(fd)来创建Ashmem对象。两个Ashmem对象指向同一个共享内存区域。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -8599,9 +8654,11 @@ mapTypedAshmem(mapType: number): void ### mapAshmem8+(deprecated) +>从API version 9 开始不再维护，建议使用[mapTypedAshmem](#maptypedashmem9)类替代。 + mapAshmem(mapType: number): boolean -在此进程的虚拟地址空间上创建共享文件映射，映射区域大小由此Ashmem对象指定。建议使用mapTypedAshmem替代。 +在此进程的虚拟地址空间上创建共享文件映射，映射区域大小由此Ashmem对象指定。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -8657,9 +8714,11 @@ mapReadAndWriteAshmem(): void ### mapReadAndWriteAshmem8+(deprecated) +>从API version 9 开始不再维护，建议使用[mapReadWriteAshmem](#mapreadwriteashmem9)类替代。 + mapReadAndWriteAshmem(): boolean -在此进程虚拟地址空间上创建可读写的共享文件映射。建议使用mapReadWriteAshmem替代。 +在此进程虚拟地址空间上创建可读写的共享文件映射。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -8709,9 +8768,11 @@ mapReadonlyAshmem(): void ### mapReadOnlyAshmem8+(deprecated) +>从API version 9 开始不再维护，建议使用[mapReadonlyAshmem](#mapreadonlyashmem9)类替代。 + mapReadOnlyAshmem(): boolean -在此进程虚拟地址空间上创建只读的共享文件映射。建议使用mapReadonlyAshmem替代。 +在此进程虚拟地址空间上创建只读的共享文件映射。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -8767,9 +8828,11 @@ setProtectionType(protectionType: number): void ### setProtection8+(deprecated) +>从API version 9 开始不再维护，建议使用[setProtectionType](#setprotectiontype9)类替代。 + setProtection(protectionType: number): boolean -设置映射内存区域的保护等级。建议使用setProtectionType替代。 +设置映射内存区域的保护等级。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -8835,9 +8898,11 @@ writeAshmem(buf: number[], size: number, offset: number): void ### writeToAshmem8+(deprecated) +>从API version 9 开始不再维护，建议使用[writeAshmem](#writeashmem9)类替代。 + writeToAshmem(buf: number[], size: number, offset: number): boolean -将数据写入此Ashmem对象关联的共享文件。建议使用writeAshmem替代。 +将数据写入此Ashmem对象关联的共享文件。 **系统能力**：SystemCapability.Communication.IPC.Core @@ -8915,9 +8980,11 @@ readAshmem(size: number, offset: number): number[] ### readFromAshmem8+(deprecated) +>从API version 9 开始不再维护，建议使用[readAshmem](#readashmem9)类替代。 + readFromAshmem(size: number, offset: number): number[] -从此Ashmem对象关联的共享文件中读取数据。建议使用readAshmem替代。 +从此Ashmem对象关联的共享文件中读取数据。 **系统能力**：SystemCapability.Communication.IPC.Core