From e4c6220721708ab8dc1b355ea7487a4ecaaa501c Mon Sep 17 00:00:00 2001 From: njupthan Date: Mon, 28 Feb 2022 20:12:53 +0800 Subject: [PATCH 01/18] update d.ts file Signed-off-by: njupthan --- api/@ohos.application.Ability.d.ts | 77 ++++++++++++++++++++++------- api/application/AbilityContext.d.ts | 10 ++-- 2 files changed, 64 insertions(+), 23 deletions(-) diff --git a/api/@ohos.application.Ability.d.ts b/api/@ohos.application.Ability.d.ts index 65963be527..9f98343b86 100755 --- a/api/@ohos.application.Ability.d.ts +++ b/api/@ohos.application.Ability.d.ts @@ -20,21 +20,54 @@ import window from './@ohos.window'; import { Configuration } from './@ohos.application.Configuration'; import rpc from '/@ohos.rpc'; +/** + * The prototype of the listener function interface registered by the Caller. + * + * @since 9 + * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @devices phone, tablet, tv, wearable, car + * @permission N/A + * @param msg Monitor status notification information. + * @return - + * @StageModelOnly + */ +export interface OnReleaseCallBack { + (msg: string): void; +} + +/** + * The prototype of the message listener function interface registered by the Callee. + * + * @since 9 + * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @devices phone, tablet, tv, wearable, car + * @permission N/A + * @param indata Notification data notified from the caller. + * @return rpc.Sequenceable + * @StageModelOnly + */ +export interface CaleeCallBack { + (indata: rpc.MessageParcel): rpc.Sequenceable; +} + /** * The interface of a Caller. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore * @devices phone, tablet, tv, wearable, car * @permission N/A * @StageModelOnly */ - interface Caller { +export interface Caller { /** * Notify the server of Sequenceable type data. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @param method The notification event string listened to by the callee. + * @param data Notification data to the callee. + * @return - * @StageModelOnly */ call(method: string, data: rpc.Sequenceable): Promise; @@ -43,8 +76,10 @@ import rpc from '/@ohos.rpc'; * Notify the server of Sequenceable type data and return the notification result. * * @since 9 - * @sysCap AAFwk - * return Sequenceable data + * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @param method The notification event string listened to by the callee. + * @param data Notification data to the callee. + * @return Returns the callee's notification result data on success, and returns undefined on failure. * @StageModelOnly */ callWithResult(method: string, data: rpc.Sequenceable): Promise; @@ -53,8 +88,8 @@ import rpc from '/@ohos.rpc'; * Clear service records. * * @since 9 - * @sysCap AAFwk - * return Sequenceable data + * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @return - * @StageModelOnly */ release(): void; @@ -63,38 +98,44 @@ import rpc from '/@ohos.rpc'; * Register death listener notification callback. * * @since 9 - * @sysCap AAFwk - * return Sequenceable data + * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @param callback Register a callback function for listening for notifications. + * @return - * @StageModelOnly */ - onRelease(callback: function): void; + onRelease(callback: OnReleaseCallBack): void; } /** * The interface of a Callee. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore * @devices phone, tablet, tv, wearable, car * @permission N/A * @StageModelOnly */ - interface Callee { +export interface Callee { /** * Register data listener callback. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @param method A string registered to listen for notification events. + * @param callback Register a callback function that listens for notification events. + * @return - * @StageModelOnly */ - on(method: string, callback: function): void; + on(method: string, callback: CaleeCallBack): void; /** * Unregister data listener callback. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @param method A string registered to listen for notification events. + * @return - * @StageModelOnly */ off(method: string): void; @@ -140,7 +181,7 @@ export default class Ability { * Call Service Stub Object. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore * @StageModelOnly */ callee: Callee; @@ -221,7 +262,7 @@ export default class Ability { * * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ @@ -232,7 +273,7 @@ export default class Ability { * * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ diff --git a/api/application/AbilityContext.d.ts b/api/application/AbilityContext.d.ts index 442c46a5d0..df2e6292b9 100755 --- a/api/application/AbilityContext.d.ts +++ b/api/application/AbilityContext.d.ts @@ -56,7 +56,7 @@ export default class AbilityContext extends Context { * Indicates configuration information. * * @since 9 - * @sysCap AAFwk + * @sysCap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ config: Configuration; @@ -79,12 +79,12 @@ export default class AbilityContext extends Context { * * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk - * @param parameter Indicates the ability to start. - * @return Caller + * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @param want Indicates the ability to start. + * @return Returns to the Caller interface on success Returns empty or undefined on failure * @StageModelOnly */ - startAbilityByCall(want: Want): Promise; + startAbilityByCall(want: Want): Promise; /** * Starts a new ability with account. -- Gitee From 254eed481265e40aea0d4bff47214308294caf15 Mon Sep 17 00:00:00 2001 From: clevercong Date: Tue, 1 Mar 2022 12:11:12 +0800 Subject: [PATCH 02/18] update telephony and net js api d.ts files. Signed-off-by: clevercong --- api/@ohos.net.socket.d.ts | 26 +++--- api/@ohos.net.webSocket.d.ts | 126 ++++++++++++++++++++++++++++++ api/@ohos.telephony.call.d.ts | 68 +++++++++------- api/@ohos.telephony.data.d.ts | 26 +++--- api/@ohos.telephony.observer.d.ts | 6 +- api/@ohos.telephony.radio.d.ts | 36 ++++----- api/@ohos.telephony.sim.d.ts | 26 +++--- api/@ohos.telephony.sms.d.ts | 26 +++--- 8 files changed, 238 insertions(+), 102 deletions(-) create mode 100644 api/@ohos.net.webSocket.d.ts diff --git a/api/@ohos.net.socket.d.ts b/api/@ohos.net.socket.d.ts index ccabf9041a..a659f947f7 100644 --- a/api/@ohos.net.socket.d.ts +++ b/api/@ohos.net.socket.d.ts @@ -1,17 +1,17 @@ /* -* Copyright (C) 2021 Huawei Device Co., Ltd. -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ + * Copyright (C) 2021 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ import {AsyncCallback, Callback, ErrorCallback} from "./basic"; import connection from "./@ohos.net.connection"; diff --git a/api/@ohos.net.webSocket.d.ts b/api/@ohos.net.webSocket.d.ts new file mode 100644 index 0000000000..ebf4dcd5ca --- /dev/null +++ b/api/@ohos.net.webSocket.d.ts @@ -0,0 +1,126 @@ +/* + * Copyright (C) 2021 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import {AsyncCallback, ErrorCallback} from "./basic"; + +/** + * Provides WebSocket APIs. + * + * @since 6 + * @syscap SystemCapability.Communication.NetStack + */ +declare namespace webSocket { + /** + * Creates a web socket connection. + */ + function createWebSocket(): WebSocket; + + export interface WebSocketRequestOptions { + /** + * HTTP request header. + */ + header?: Object; + } + + export interface WebSocketCloseOptions { + /** + * Error code. + */ + code?: number; + /** + * Error cause. + */ + reason?: string; + } + + export interface WebSocket { + /** + * Initiates a WebSocket request to establish a WebSocket connection to a given URL. + * + * @param url URL for establishing a WebSocket connection. + * @param options Optional parameters {@link WebSocketRequestOptions}. + * @param callback Returns callback used to return the execution result. + * @permission ohos.permission.INTERNET + */ + connect(url: string, callback: AsyncCallback): void; + connect(url: string, options: WebSocketRequestOptions, callback: AsyncCallback): void; + connect(url: string, options?: WebSocketRequestOptions): Promise; + + /** + * Sends data through a WebSocket connection. + * + * @param data Data to send. It can be a string(API 6) or an ArrayBuffer(API 8). + * @param callback Returns callback used to return the execution result. + * @permission ohos.permission.INTERNET + */ + send(data: string | ArrayBuffer, callback: AsyncCallback): void; + send(data: string | ArrayBuffer): Promise; + + /** + * Closes a WebSocket connection. + * + * @param options Optional parameters {@link WebSocketCloseOptions}. + * @param callback Returns callback used to return the execution result. + * @permission ohos.permission.INTERNET + */ + close(callback: AsyncCallback): void; + close(options: WebSocketCloseOptions, callback: AsyncCallback): void; + close(options?: WebSocketCloseOptions): Promise; + + /** + * Enables listening for the open events of a WebSocket connection. + */ + on(type: 'open', callback: AsyncCallback): void; + + /** + * Cancels listening for the open events of a WebSocket connection. + */ + off(type: 'open', callback?: AsyncCallback): void; + + /** + * Enables listening for the message events of a WebSocket connection. + * data in AsyncCallback can be a string(API 6) or an ArrayBuffer(API 8). + */ + on(type: 'message', callback: AsyncCallback): void; + + /** + * Cancels listening for the message events of a WebSocket connection. + * data in AsyncCallback can be a string(API 6) or an ArrayBuffer(API 8). + */ + off(type: 'message', callback?: AsyncCallback): void; + + /** + * Enables listening for the close events of a WebSocket connection. + */ + on(type: 'close', callback: AsyncCallback<{ code: number, reason: string }>): void; + + /** + * Cancels listening for the close events of a WebSocket connection. + */ + off(type: 'close', callback?: AsyncCallback<{ code: number, reason: string }>): void; + + /** + * Enables listening for the error events of a WebSocket connection. + */ + on(type: 'error', callback: ErrorCallback): void; + + /** + * Cancels listening for the error events of a WebSocket connection. + */ + off(type: 'error', callback?: ErrorCallback): void; + } +} + +export default webSocket; \ No newline at end of file diff --git a/api/@ohos.telephony.call.d.ts b/api/@ohos.telephony.call.d.ts index 7b5a03dd61..11f0ddb79b 100644 --- a/api/@ohos.telephony.call.d.ts +++ b/api/@ohos.telephony.call.d.ts @@ -1,17 +1,17 @@ /* -* Copyright (C) 2021 Huawei Device Co., Ltd. -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ + * Copyright (C) 2021 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ import {AsyncCallback, Callback} from "./basic"; @@ -38,6 +38,16 @@ declare namespace call { function dial(phoneNumber: string, options: DialOptions, callback: AsyncCallback): void; function dial(phoneNumber: string, options?: DialOptions): Promise; + /** + * Go to the dial screen and the called number is displayed. + * + * @param phoneNumber Indicates the called number. + * @syscap SystemCapability.SysAppComponents.CONTACT + * @devices phone, tablet + */ + function makeCall(phoneNumber: string, callback: AsyncCallback): void; + function makeCall(phoneNumber: string): Promise; + /** * Checks whether a call is ongoing. * @@ -414,9 +424,9 @@ declare namespace call { * @since 8 */ export interface CallTransferInfo { - transferNum: string, - type: CallTransferType, - settingType: CallTransferSettingType + transferNum: string; + type: CallTransferType; + settingType: CallTransferSettingType; } /** @@ -446,16 +456,16 @@ declare namespace call { * @since 7 */ export interface CallAttributeOptions { - accountNumber: string, - speakerphoneOn: boolean, - accountId: number, - videoState: VideoStateType, - startTime: number, - isEcc: boolean, - callType: CallType, - callId: number, - callState: DetailedCallState, - conferenceState: ConferenceState, + accountNumber: string; + speakerphoneOn: boolean; + accountId: number; + videoState: VideoStateType; + startTime: number; + isEcc: boolean; + callType: CallType; + callId: number; + callState: DetailedCallState; + conferenceState: ConferenceState; } /** @@ -510,9 +520,9 @@ declare namespace call { * @since 8 */ export interface CallRestrictionInfo { - type: CallRestrictionType, - password: string - mode: CallRestrictionMode + type: CallRestrictionType; + password: string; + mode: CallRestrictionMode; } /** diff --git a/api/@ohos.telephony.data.d.ts b/api/@ohos.telephony.data.d.ts index 24a6fa7556..8f394b6477 100644 --- a/api/@ohos.telephony.data.d.ts +++ b/api/@ohos.telephony.data.d.ts @@ -1,17 +1,17 @@ /* -* Copyright (C) 2021 Huawei Device Co., Ltd. -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ + * Copyright (C) 2021 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ import {AsyncCallback} from "./basic"; diff --git a/api/@ohos.telephony.observer.d.ts b/api/@ohos.telephony.observer.d.ts index e7d6294044..2fd39fa9c0 100644 --- a/api/@ohos.telephony.observer.d.ts +++ b/api/@ohos.telephony.observer.d.ts @@ -162,12 +162,12 @@ declare namespace observer { * @since 7 */ export interface SimStateData { - type: CardType, - state: SimState, + type: CardType; + state: SimState; /** * @since 8 */ - reason: LockReason + reason: LockReason; } /** diff --git a/api/@ohos.telephony.radio.d.ts b/api/@ohos.telephony.radio.d.ts index 38b942aba0..e3a6bcbeb9 100644 --- a/api/@ohos.telephony.radio.d.ts +++ b/api/@ohos.telephony.radio.d.ts @@ -1,17 +1,17 @@ /* -* Copyright (C) 2021 Huawei Device Co., Ltd. -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ + * Copyright (C) 2021 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ import {AsyncCallback} from "./basic"; @@ -641,11 +641,11 @@ declare namespace radio { * @since 8 */ export interface CdmaCellInformation { - baseId: number, - latitude: number, - longitude: number, - nid: number, - sid: number, + baseId: number; + latitude: number; + longitude: number; + nid: number; + sid: number; } /** diff --git a/api/@ohos.telephony.sim.d.ts b/api/@ohos.telephony.sim.d.ts index 83d8ed9902..93237791f0 100644 --- a/api/@ohos.telephony.sim.d.ts +++ b/api/@ohos.telephony.sim.d.ts @@ -1,17 +1,17 @@ /* -* Copyright (C) 2021 Huawei Device Co., Ltd. -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ + * Copyright (C) 2021 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ import {AsyncCallback} from "./basic"; diff --git a/api/@ohos.telephony.sms.d.ts b/api/@ohos.telephony.sms.d.ts index 5b8e4b45e2..f011e9dd03 100644 --- a/api/@ohos.telephony.sms.d.ts +++ b/api/@ohos.telephony.sms.d.ts @@ -1,17 +1,17 @@ /* -* Copyright (C) 2021 Huawei Device Co., Ltd. -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ + * Copyright (C) 2021 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ import {AsyncCallback} from "./basic"; -- Gitee From 1abcc570a6d3bf6edd76d40610a1a6d68f3af9a0 Mon Sep 17 00:00:00 2001 From: njupthan Date: Tue, 1 Mar 2022 13:36:50 +0800 Subject: [PATCH 03/18] update d.ts file Signed-off-by: njupthan --- api/@ohos.application.Ability.d.ts | 54 +++++++++++++---------------- api/application/AbilityContext.d.ts | 33 +++++++++--------- 2 files changed, 40 insertions(+), 47 deletions(-) diff --git a/api/@ohos.application.Ability.d.ts b/api/@ohos.application.Ability.d.ts index 9f98343b86..7849829fcb 100755 --- a/api/@ohos.application.Ability.d.ts +++ b/api/@ohos.application.Ability.d.ts @@ -24,8 +24,7 @@ import rpc from '/@ohos.rpc'; * The prototype of the listener function interface registered by the Caller. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @permission N/A * @param msg Monitor status notification information. * @return - @@ -39,8 +38,7 @@ export interface OnReleaseCallBack { * The prototype of the message listener function interface registered by the Callee. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @permission N/A * @param indata Notification data notified from the caller. * @return rpc.Sequenceable @@ -54,8 +52,7 @@ export interface CaleeCallBack { * The interface of a Caller. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @permission N/A * @StageModelOnly */ @@ -64,7 +61,7 @@ export interface Caller { * Notify the server of Sequenceable type data. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @param method The notification event string listened to by the callee. * @param data Notification data to the callee. * @return - @@ -76,7 +73,7 @@ export interface Caller { * Notify the server of Sequenceable type data and return the notification result. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @param method The notification event string listened to by the callee. * @param data Notification data to the callee. * @return Returns the callee's notification result data on success, and returns undefined on failure. @@ -88,7 +85,7 @@ export interface Caller { * Clear service records. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ @@ -98,7 +95,7 @@ export interface Caller { * Register death listener notification callback. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @param callback Register a callback function for listening for notifications. * @return - * @StageModelOnly @@ -110,8 +107,7 @@ export interface Caller { * The interface of a Callee. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @permission N/A * @StageModelOnly */ @@ -121,7 +117,7 @@ export interface Callee { * Register data listener callback. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @param method A string registered to listen for notification events. * @param callback Register a callback function that listens for notification events. * @return - @@ -133,7 +129,7 @@ export interface Callee { * Unregister data listener callback. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @param method A string registered to listen for notification events. * @return - * @StageModelOnly @@ -145,7 +141,7 @@ export interface Callee { * The class of an ability. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @permission N/A * @StageModelOnly */ @@ -154,7 +150,7 @@ export default class Ability { * Indicates configuration information about an ability context. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @StageModelOnly */ context: AbilityContext; @@ -163,7 +159,7 @@ export default class Ability { * Indicates ability launch want. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @StageModelOnly */ launchWant: Want; @@ -172,7 +168,7 @@ export default class Ability { * Indicates ability last request want. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @StageModelOnly */ lastRequestWant: Want; @@ -181,7 +177,7 @@ export default class Ability { * Call Service Stub Object. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @StageModelOnly */ callee: Callee; @@ -190,7 +186,7 @@ export default class Ability { * Called back when an ability is started for initialization. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ @@ -200,7 +196,7 @@ export default class Ability { * Called back when an ability window stage is created. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ @@ -210,7 +206,7 @@ export default class Ability { * Called back when an ability window stage is destroyed. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ @@ -220,7 +216,7 @@ export default class Ability { * Called back before an ability is destroyed. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ @@ -230,7 +226,7 @@ export default class Ability { * Called back when the state of an ability changes to foreground. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ @@ -240,7 +236,7 @@ export default class Ability { * Called back when the state of an ability changes to background. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ @@ -250,7 +246,7 @@ export default class Ability { * Called back when an ability prepares to migrate. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return true if ability agrees to migrate and saves data successfully, otherwise false. * @StageModelOnly */ @@ -260,9 +256,8 @@ export default class Ability { * Called when the launch mode of an ability is set to singleton. * This happens when you re-launch an ability that has been at the top of the ability stack. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ @@ -271,9 +266,8 @@ export default class Ability { /** * Called when the system configuration is updated. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @return - * @StageModelOnly */ diff --git a/api/application/AbilityContext.d.ts b/api/application/AbilityContext.d.ts index df2e6292b9..8dbcd71363 100755 --- a/api/application/AbilityContext.d.ts +++ b/api/application/AbilityContext.d.ts @@ -29,7 +29,7 @@ import Caller from '../@ohos.application.Ability'; * The context of an ability. It allows access to ability-specific resources. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -38,7 +38,7 @@ export default class AbilityContext extends Context { * Indicates configuration information about an ability. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ abilityInfo: AbilityInfo; @@ -47,7 +47,7 @@ export default class AbilityContext extends Context { * Indicates configuration information about an module. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ currentHapModuleInfo: HapModuleInfo; @@ -56,7 +56,7 @@ export default class AbilityContext extends Context { * Indicates configuration information. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ config: Configuration; @@ -65,7 +65,7 @@ export default class AbilityContext extends Context { * Starts a new ability. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param parameter Indicates the ability to start. * @return - * @StageModelOnly @@ -77,9 +77,8 @@ export default class AbilityContext extends Context { /** * Get the caller object of the startup capability * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want Indicates the ability to start. * @return Returns to the Caller interface on success Returns empty or undefined on failure * @StageModelOnly @@ -90,7 +89,7 @@ export default class AbilityContext extends Context { * Starts a new ability with account. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want Indicates the want info to start. * @param want Indicates the account to start. * @systemapi hide for inner use. @@ -105,7 +104,7 @@ export default class AbilityContext extends Context { * Starts an ability and returns the execution result when the ability is destroyed. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param parameter Indicates the ability to start. * @return Returns the {@link AbilityResult}. * @StageModelOnly @@ -118,7 +117,7 @@ export default class AbilityContext extends Context { * Starts an ability and returns the execution result when the ability is destroyed with account. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want Indicates the want info to start. * @param want Indicates the account to start. * @systemapi hide for inner use. @@ -133,7 +132,7 @@ export default class AbilityContext extends Context { * Destroys this Page ability. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @return - * @StageModelOnly */ @@ -145,7 +144,7 @@ export default class AbilityContext extends Context { * and destroys this Page ability. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param parameter Indicates the result to return. * @return - * @StageModelOnly @@ -157,7 +156,7 @@ export default class AbilityContext extends Context { * Connects the current ability to an ability using the AbilityInfo.AbilityType.SERVICE template. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want The element name of the service ability * @param options The remote object instance * @hide hide for inner use. @@ -170,7 +169,7 @@ export default class AbilityContext extends Context { * Connects the current ability to an ability using the AbilityInfo.AbilityType.SERVICE template with account. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want The element name of the service ability * @param options The remote object instance * @param accountId The account to connect @@ -184,7 +183,7 @@ export default class AbilityContext extends Context { * The callback interface was connect successfully. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param connection The number code of the ability connected * @hide hide for inner use. * @StageModelOnly @@ -196,7 +195,7 @@ export default class AbilityContext extends Context { * Set mission label of current ability. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param label The label of ability that showed in recent missions. * @StageModelOnly */ @@ -207,7 +206,7 @@ export default class AbilityContext extends Context { * Requests certain permissions from the system. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param permissions Indicates the list of permissions to be requested. This parameter cannot be null or empty. * @StageModelOnly */ -- Gitee From eca2c789d426c068f95c89a77886894ae808fd95 Mon Sep 17 00:00:00 2001 From: SoftSquirrel Date: Tue, 1 Mar 2022 14:54:16 +0800 Subject: [PATCH 04/18] IssueNo: #I4VQXI: delete getAllShortcutInfo interface Description: delete getAllShortcutInfo interface Sig: SIG_ApplicaitonFramework Feature or Bugfix: Feature Binary Source: No Signed-off-by: SoftSquirrel --- api/@ohos.bundle.d.ts | 12 ------------ api/bundle/abilityInfo.d.ts | 2 +- 2 files changed, 1 insertion(+), 13 deletions(-) diff --git a/api/@ohos.bundle.d.ts b/api/@ohos.bundle.d.ts index 8d2be229f4..d33f0a1e05 100644 --- a/api/@ohos.bundle.d.ts +++ b/api/@ohos.bundle.d.ts @@ -489,18 +489,6 @@ declare namespace bundle { function getLaunchWantForBundle(bundleName: string, callback: AsyncCallback): void; function getLaunchWantForBundle(bundleName: string): Promise; - /** - * Obtains information about the shortcuts of the application. - * - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @param bundleName Indicates the bundle name of the application. - * @return Returns a list of ShortcutInfo objects containing shortcut information about the application. - * @permission ohos.permission.MANAGE_SHORTCUTS - */ - function getAllShortcutInfo(bundleName: string, callback: AsyncCallback>): void; - function getAllShortcutInfo(bundleName: string): Promise>; - /** * get module usage record list in descending order of lastLaunchTime. * diff --git a/api/bundle/abilityInfo.d.ts b/api/bundle/abilityInfo.d.ts index 87bd8399bc..099ba7a1b7 100644 --- a/api/bundle/abilityInfo.d.ts +++ b/api/bundle/abilityInfo.d.ts @@ -225,7 +225,7 @@ export interface AbilityInfo { readonly metadata: Array; /** - * @default Indicates the metadata of ability + * @default Indicates whether the ability is enabled * @since 8 * @syscap SystemCapability.BundleManager.BundleFramework */ -- Gitee From 29c295c15ba9383540e2ca9d549e2f1be6967458 Mon Sep 17 00:00:00 2001 From: SoftSquirrel Date: Tue, 1 Mar 2022 14:58:56 +0800 Subject: [PATCH 05/18] IssueNo: #I4VQXI: delete getAllShortcutInfo interface Description: delete getAllShortcutInfo interface Sig: SIG_ApplicaitonFramework Feature or Bugfix: Feature Binary Source: No Signed-off-by: SoftSquirrel --- api/@ohos.bundle.d.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/api/@ohos.bundle.d.ts b/api/@ohos.bundle.d.ts index d33f0a1e05..bdef6418df 100644 --- a/api/@ohos.bundle.d.ts +++ b/api/@ohos.bundle.d.ts @@ -20,7 +20,6 @@ import { AbilityInfo } from './bundle/abilityInfo'; import { ExtensionAbilityInfo } from './bundle/extensionAbilityInfo'; import { Want } from './ability/want'; import { BundleInstaller } from './bundle/bundleInstaller'; -import { ShortcutInfo } from './bundle/shortcutInfo'; import { ModuleUsageRecord } from './bundle/moduleUsageRecord'; import { PermissionDef } from './bundle/PermissionDef'; -- Gitee From d42564d938f47f3d9f98ea934c771a6e4cc40304 Mon Sep 17 00:00:00 2001 From: wanghang Date: Tue, 1 Mar 2022 16:10:50 +0800 Subject: [PATCH 06/18] IssueNo:#I4VSFT:updata permission Description:updata permission Sig:SIG_ApplicaitonFramework Feature or Bugfix:Feature Binary Source:No Signed-off-by: wanghang Change-Id: I82dd1ec2ab1598ae6dbf7cff87101dca4651485b --- api/@ohos.distributedBundle.d.ts | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/api/@ohos.distributedBundle.d.ts b/api/@ohos.distributedBundle.d.ts index 90aef0113a..e9fea81850 100644 --- a/api/@ohos.distributedBundle.d.ts +++ b/api/@ohos.distributedBundle.d.ts @@ -23,6 +23,7 @@ import { RemoteAbilityInfo } from './bundle/remoteAbilityInfo'; * @since 8 * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @permission NA + * @systemapi Hide this for inner system use */ declare namespace distributedBundle { /** @@ -32,7 +33,7 @@ import { RemoteAbilityInfo } from './bundle/remoteAbilityInfo'; * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @param elementName Indicates the elementName. * @return Returns the ability info of the remote device. - * @permission ohos.permission.GET_REMOTE_ABILITY_INFO_PRIVILEGED + * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED * @systemapi */ function getRemoteAbilityInfo(elementName: ElementName, callback: AsyncCallback): void; @@ -45,7 +46,7 @@ import { RemoteAbilityInfo } from './bundle/remoteAbilityInfo'; * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @param elementNames Indicates the elementNames, Maximum array length ten. * @return Returns the ability infos of the remote device. - * @permission ohos.permission.GET_REMOTE_ABILITY_INFO_PRIVILEGED + * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED * @systemapi */ function getRemoteAbilityInfos(elementNames: Array, callback: AsyncCallback>): void; -- Gitee From fd8b3608d21716a78ff924a8ec09bede1fac0065 Mon Sep 17 00:00:00 2001 From: lvxiaoqiang Date: Tue, 1 Mar 2022 16:51:15 +0800 Subject: [PATCH 07/18] add settings const value napi Signed-off-by: lvxiaoqiang --- api/@ohos.settings.d.ts | 852 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 829 insertions(+), 23 deletions(-) diff --git a/api/@ohos.settings.d.ts b/api/@ohos.settings.d.ts index 90c9e382fc..68ce75932a 100644 --- a/api/@ohos.settings.d.ts +++ b/api/@ohos.settings.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 Huawei Device Co., Ltd. + * Copyright (c) 2022 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -12,47 +12,853 @@ * See the License for the specific language governing permissions and * limitations under the License. */ +import { AsyncCallback } from './basic'; import { DataAbilityHelper } from './ability/dataAbilityHelper'; /** * This module provides settings data access abilities. * - * @since 8 + * @since 7 * @devices phone, tablet, tv, wearable, car * @import import settings from '@ohos.settings' * @permission N/A */ declare namespace settings { + /** + * Provides methods for setting time and date formats. + * + * @since 7 + */ + namespace date { + /** + * Indicates the date format. + * + *

The formats {@code mm/dd/yyyy}, {@code dd/mm/yyyy}, and {@code yyyy/mm/dd} are available. + * + * @since 7 + */ + const DATE_FORMAT: string + + /** + * Specifies whether the time is displayed in 12-hour or 24-hour format. + * + *

If the value is {@code 12}, the 12-hour format is used. If the value is {@code 24}, the 24-hour format + * is used. + * + * @since 7 + */ + const TIME_FORMAT: string + + /** + * Specifies whether the date, time, and time zone are automatically obtained from the Network + * Identity and Time Zone (NITZ). + * + *

If the value is {@code true}, the information is automatically obtained from NITZ. + * If the value is {@code false}, the information is not obtained from NITZ. + * + * @since 7 + */ + const AUTO_GAIN_TIME: string + + /** + * Specifies whether the time zone is automatically obtained from NITZ. + * + *

If the value is {@code true}, the information is automatically obtained from NITZ. If the value + * is {@code false}, the information is not obtained from NITZ. + * + * @since 7 + */ + const AUTO_GAIN_TIME_ZONE: string + } + + /** + * Provides methods for setting the display effect, including the font size, screen brightness, screen rotation, + * animation factor, and display color. + * + * @since 7 + */ + namespace display { + /** + * Indicates the scaling factor of fonts, which is a float number. + * + * @since 7 + */ + const FONT_SCALE: string + + /** + * Indicates the screen brightness. The value ranges from 0 to 255. + * + * @since 7 + */ + const SCREEN_BRIGHTNESS_STATUS: string + + /** + * Specifies whether automatic screen brightness adjustment is enabled. + * + *

If the value is {@code 1}, automatic adjustment is enabled. If the value is {@code 0}, automatic + * adjustment is disabled. + * + * @since 7 + */ + const AUTO_SCREEN_BRIGHTNESS: string + + /** + * Indicates the value of {@code AUTO_SCREEN_BRIGHTNESS} when automatic screen brightness adjustment is used. + * + * @since 7 + */ + const AUTO_SCREEN_BRIGHTNESS_MODE: number + + /** + * Indicates the value of {@code AUTO_SCREEN_BRIGHTNESS} when manual screen brightness adjustment is used. + * + * @since 7 + */ + const MANUAL_SCREEN_BRIGHTNESS_MODE: number + + /** + * Indicates the duration that the device waits before going to sleep after a period of inactivity, in + * milliseconds. + * + * @since 7 + */ + const SCREEN_OFF_TIMEOUT: string + + /** + * Indicates the screen rotation when no other policy is available. + * + *

This constant is invalid when auto-rotation is enabled. When auto-rotation is disabled, the following + * values are available: + * + *

    + *
  • {@code 0} - The screen rotates 0 degrees. + *
  • {@code 1} - The screen rotates 90 degrees. + *
  • {@code 2} - The screen rotates 180 degrees. + *
  • {@code 3} - The screen rotates 270 degrees. + *
+ * + * @since 7 + */ + const DEFAULT_SCREEN_ROTATION: string + + /** + * Indicates the scaling factor for the animation duration. + * + *

This affects the start delay and duration of all such animations. If the value is {@code 0}, + * the animation ends immediately. The default value is {@code 1}. + * + * @since 7 + */ + const ANIMATOR_DURATION_SCALE: string + + /** + * Indicates the scaling factor for transition animations. + * If the value is {@code 0}, transition animations are disabled. + * + * @since 7 + */ + const TRANSITION_ANIMATION_SCALE: string + + /** + * Indicates the scaling factor for normal window animations. + * If the value is {@code 0}, window animations are disabled. + * + * @since 7 + */ + const WINDOW_ANIMATION_SCALE: string + + /** + * Specifies whether display color inversion is enabled. + * + *

If the value is {@code 1}, display color inversion is enabled. If the value is {@code 0}, display color + * inversion is disabled. + * + * @since 7 + */ + const DISPLAY_INVERSION_STATUS: string + } + + /** + * Provides methods for setting general information about devices, including the device name, startup wizard, + * airplane mode, debugging information, accessibility feature switch, and touch exploration status. + * + * @since 7 + */ + namespace general { + /** + * Specifies whether the startup wizard has been run. + * + *

If the value is {@code 0}, the startup wizard has not been run. If the value is not {@code 0}, the startup + * wizard has been run. + * + * @since 7 + */ + const SETUP_WIZARD_FINISHED: string + + /** + * Specifies what happens after the user presses the call end button if the user is not in a call. + * + *

    + *
  • {@code 0} - Nothing happens. + *
  • {@code 1} - The home screen is displayed. + *
  • {@code 2} - The device enters the sleep state and the screen is locked. + *
  • {@code 3} - The home screen is displayed. If the user is already on the home screen, the device enters + * the sleep state. + *
+ * + * @since 7 + */ + const END_BUTTON_ACTION: string + + /** + * Specifies whether the accelerometer is used to change screen orientation, that is, whether auto-rotation is + * enabled. + * + *

The value {@code 1} indicates that the accelerometer is enabled by default, and {@code 0} indicates that + * the accelerometer is disabled by default. + * + * @since 7 + */ + const ACCELEROMETER_ROTATION_STATUS: string + + /** + * Specifies whether airplane mode is enabled. + * + *

If the value is {@code 1}, airplane mode is enabled. If the value is {@code 0}, airplane mode is disabled. + * + * @since 7 + */ + const AIRPLANE_MODE_STATUS: string + + /** + * Specifies whether the device is provisioned. + * + *

On a multi-user device with a single system user, the screen may be locked when the value is {@code true}. + * In addition, other abilities cannot be started on the system user unless they are marked to display over + * the screen lock. + * + * @since 7 + */ + const DEVICE_PROVISION_STATUS: string + + /** + * Specifies whether the hard disk controller (HDC) on USB devices is enabled. + * + *

If the value is {@code true}, the HDC is enabled. If the value is {@code false}, the HDC is disabled. + * + * @since 7 + */ + const HDC_STATUS: string + + /** + * Indicates the number of boot operations after the device is powered on. + * + * @since 7 + */ + const BOOT_COUNTING: string + + /** + * Specifies whether contact metadata synchronization is enabled. + * + *

If the value is {@code true}, synchronization is enabled. If the value is {@code false}, + * synchronization is disabled. + * + * @since 7 + */ + const CONTACT_METADATA_SYNC_STATUS: string + + /** + * Specifies whether developer options are enabled. + * + *

If the value is {@code true}, developer options are enabled. + * If the value is {@code false}, developer options are disabled. + * + * @since 7 + */ + const DEVELOPMENT_SETTINGS_STATUS: string + + /** + * Indicates the device name. + * + * @since 7 + */ + const DEVICE_NAME: string + + /** + * Specifies whether USB mass storage is enabled. + * + *

If the value is {@code true}, USB mass storage is enabled. + * If the value is {@code false}, USB mass storage is disabled. + * + * @since 7 + */ + const USB_STORAGE_STATUS: string + + /** + * Specifies whether the device waits for the debugger when starting an application to debug. + * + *

If the value is {@code 1}, the device waits for the debugger. + * If the value is {@code 0}, the system does not wait for the debugger, and so the application runs normally. + * + * @since 7 + */ + const DEBUGGER_WAITING: string + + /** + * Indicates the bundle name of the application to debug. + * + * @since 7 + */ + const DEBUG_APP_PACKAGE: string + + /** + * Specifies whether any accessibility feature is enabled. + * + *

If the value is {@code 1}, the accessibility feature is enabled. If the value is {@code 0}, the + * accessibility feature is disabled. + * + * @since 7 + */ + const ACCESSIBILITY_STATUS: string + + /** + * Indicates the list of accessibility features that have been activated. + * + * @since 7 + */ + const ACTIVATED_ACCESSIBILITY_SERVICES: string + + /** + * Indicates the default geographical location that can be used by the browser. Multiple geographical locations + * are separated by spaces. + * + * @since 7 + */ + const GEOLOCATION_ORIGINS_ALLOWED: string + + /** + * Specifies whether an application should attempt to skip all introductory hints at the first startup. This is + * intended for temporary users or users who are familiar with the environment. + * + *

If the value is {@code 1}, the application attempts to skip all introductory hints at the first startup. + * If the value is {@code 0}, the application does not skip introductory hints at the first startup. + * + * @since 7 + */ + const SKIP_USE_HINTS: string + + /** + * Indicates whether touch exploration is enabled. + * + *

If the value is {@code 1}, touch exploration is enabled. If the value is {@code 0}, touch exploration is + * disabled. + * + * @since 7 + */ + const TOUCH_EXPLORATION_STATUS: string + } + + /** + * Provides methods for setting information about input methods, including automatic capitalization, automatic + * punctuation, autocorrect, password presentation, input method engine, and input method subtypes. + * + * @since 7 + */ + namespace input { + /** + * Indicates the default input method and its ID. + * + * @since 7 + */ + const DEFAULT_INPUT_METHOD: string + + /** + * Indicates the default input method keyboard type and its ID. + * + * @since 7 + */ + const ACTIVATED_INPUT_METHOD_SUB_MODE: string + + /** + * Indicates the list of input methods that have been activated. + * + *

The list is a string that contains the IDs of activated input methods. The IDs are separated by colons + * (:), and keyboardTypes of an input method are separated by semicolons (;). An example format is + * {@code ima0:keyboardType0;keyboardType1;ima1:ima2:keyboardTypes0}. The type of imaID is ElementName, + * and the type of keyboard is int. + * + * @since 7 + */ + const ACTIVATED_INPUT_METHODS: string + + /** + * Specifies whether the input method selector is visible. + * + *

If the value is {@code 1}, the input method selector is visible. If the value is {@code 0}, the input + * method selector is invisible. + * + * @since 7 + */ + const SELECTOR_VISIBILITY_FOR_INPUT_METHOD: string + + /** + * Specifies whether automatic capitalization is enabled for the text editor. + * + *

If the value is {@code 0}, automatic capitalization is disabled. If the value {@code 1}, automatic + * capitalization is enabled. + * + * @since 7 + */ + const AUTO_CAPS_TEXT_INPUT: string + + /** + * Specifies whether automatic punctuation is enabled for the text editor. Automatic punctuation enables the + * text editor to convert two spaces into a period (.) and a space. + * + *

If the value is {@code 0}, automatic punctuation is disabled. If the value {@code 1}, automatic + * punctuation is enabled. + * + * @since 7 + */ + const AUTO_PUNCTUATE_TEXT_INPUT: string + + /** + * Specifies whether autocorrect is enabled for the text editor. Autocorrect enables the text editor to correct + * typos. + * + *

If the value is {@code 0}, autocorrect is disabled. If the value {@code 1}, autocorrect is enabled. + * + * @since 7 + */ + const AUTO_REPLACE_TEXT_INPUT: string + + /** + * Specifies whether password presentation is enabled in the text editor. Password presentation enables the + * text editor to show password characters when the user types them. + * + *

If the value is {@code 0}, password presentation is disabled. If the value {@code 1}, password + * presentation is enabled. + * + * @since 7 + */ + const SHOW_PASSWORD_TEXT_INPUT: string + } + + /** + * Provides methods for setting network information, including the data roaming status, HTTP proxy configurations, + * and preferred networks. + * + * @since 7 + */ + namespace network { + /** + * Specifies whether data roaming is enabled. + * + *

If the value is {@code true}, data roaming is enabled. If the value is {@code false}, + * data roaming is disabled. + * + * @since 7 + */ + const DATA_ROAMING_STATUS: string + + /** + * Indicates the host name and port number of the global HTTP proxy. + * The host name and port number are separated by a colon (:). + * + * @since 7 + */ + const HTTP_PROXY_CFG: string + + /** + * Indicates the user preferences of the network to use. + * + * @since 7 + */ + const NETWORK_PREFERENCE_USAGE: string + } + + /** + * Provides methods for setting the answering mode of incoming and outgoing calls. + * + * @since 7 + */ + namespace phone { + /** + * Specifies whether real-time text (RTT) calling is enabled. If enabled, incoming and outgoing calls are + * answered as RTT calls when supported by the device and carrier. If the value is {@code 1}, RTT calling is + * enabled. If the value is {@code 0}, RTT calling is disabled. + * + * @since 7 + */ + const RTT_CALLING_STATUS: string + } + + /** + * Provides methods for setting the sound effect, including the ringtone, dial tone, alarm sound, notification tone, + * and haptic feedback. + * + * @since 7 + */ + namespace sound { + /** + * Indicates whether the device vibrates when it is ringing for an incoming call. + * + *

This constant will be used by Phone and Settings applications. The value is of the boolean type. + * This constant affects only the scenario where the device rings for an incoming call. It does not affect + * any other application or scenario. + * + * @since 7 + */ + const VIBRATE_WHILE_RINGING: string + + /** + * Indicates the storage area of the system default alarm. + * + *

You can obtain the URI of the system default alarm. + * + * @since 7 + */ + const DEFAULT_ALARM_ALERT: string + + /** + * Indicates the type of the dual-tone multifrequency (DTMF) tone played when dialing. + * + *

The value {@code 0} indicates the normal short sound effect, and {@code 1} indicates the long sound + * effect. + * + * @since 7 + */ + const DTMF_TONE_TYPE_WHILE_DIALING: string + + /** + * Specifies whether the DTMF tone is played when dialing. + * + *

If the value is {@code 1}, the DTMF tone is played. If the value is {@code 0}, the DTMF tone is not + * played. + * + * @since 7 + */ + const DTMF_TONE_WHILE_DIALING: string + + /** + * Specifies which audio streams are affected by changes on the ringing mode and Do Not Disturb (DND) mode. + * + *

If you want a specific audio stream to be affected by changes of the ringing mode and DDN mode, set the + * corresponding bit to {@code 1}. + * + * @since 7 + */ + const AFFECTED_MODE_RINGER_STREAMS: string + + /** + * Specifies which audio streams are affected by the mute mode. + * + *

If you want a specific audio stream to remain muted in mute mode, set the corresponding bit to {@code 1}. + * + * @since 7 + */ + const AFFECTED_MUTE_STREAMS: string + + /** + * Indicates the storage area of the system default notification tone. + * + *

You can obtain the URI of the system default notification tone. + * + * @since 7 + */ + const DEFAULT_NOTIFICATION_SOUND: string + + /** + * Indicates the storage area of the system default ringtone. + * + *

You can obtain the URI of the system default ringtone. + * + * @since 7 + */ + const DEFAULT_RINGTONE: string + + /** + * Specifies whether the sound effects are enabled. + * + *

If the value is {@code 0}, the sound effects are disabled. If the value is {@code 1}, the sound effects + * are enabled. + * + * @since 7 + */ + const SOUND_EFFECTS_STATUS: string + + /** + * Specifies whether the device vibrates for an event. This parameter is used inside the system. + * + *

If the value is {@code 1}, the device vibrates for an event. If the value is {@code 0}, the device does + * not vibrate for an event. + * + * @since 7 + */ + const VIBRATE_STATUS: string + + /** + * Indicates whether the device enables haptic feedback. + * + *

The value is of the boolean type. + * + * @since 7 + */ + const HAPTIC_FEEDBACK_STATUS: string + } + + /** + * Provides methods for setting information about text-to-speech (TTS) conversion, including the pitch, speech rate, + * engine, and plug-ins. + * + * @since 7 + */ + namespace TTS { + /** + * Indicates the default pitch of the text-to-speech (TTS) engine. + * + *

100 = 1x. If the value is set to {@code 200}, the frequency is twice the normal sound frequency. + * + * @since 7 + */ + const DEFAULT_TTS_PITCH: string + + /** + * Indicates the default speech rate of the TTS engine. 100 = 1x. + * + * @since 7 + */ + const DEFAULT_TTS_RATE: string + + /** + * Indicates the default TTS engine. + * + * @since 7 + */ + const DEFAULT_TTS_SYNTH: string + + /** + * Indicates the list of activated plug-in packages used for TTS. Multiple plug-in packages are separated by + * spaces. + * + * @since 7 + */ + const ENABLED_TTS_PLUGINS: string + } + + /** + * Provides methods for setting radio network information, including information about Bluetooth, Wi-Fi, Near Field + * Communication (NFC), and the airplane mode. + * + * @since 7 + */ + namespace wireless { + /** + * Specifies whether the device can be discovered or connected by other devices through Bluetooth. + * + * If the value is {@code 0}, the device cannot be connected or discovered. If the value is {@code 1}, the + * device can be connected but cannot be discovered. If the value is {@code 2}, the device can be connected + * and discovered. + * + * @since 7 + */ + const BLUETOOTH_DISCOVER_ABILITY_STATUS: string + + /** + * Indicates the duration (in seconds) that the device can be discovered through Bluetooth. + * + *

After the duration expires, the device cannot be discovered through Bluetooth. + * + * @since 7 + */ + const BLUETOOTH_DISCOVER_TIMEOUT: string + + /** + * Indicates the list of radio signals to be disabled when airplane mode is enabled. Multiple radio + * signals are separated by commas (,). + * + *

    + *
  • {@code BLUETOOTH_RADIO} - Bluetooth is disabled in airplane mode. + *
  • {@code CELL_RADIO} - Cellular radio is disabled in airplane mode. + *
  • {@code NFC_RADIO} - NFC is disabled in airplane mode. + *
  • {@code WIFI_RADIO} - Wi-Fi is disabled in airplane mode. + *
+ * + * @since 7 + */ + const AIRPLANE_MODE_RADIOS: string /** - * get settingsdata uri - * @since 8 - * @param name uri parameter - * @return settingsdata uri + * Specifies whether Bluetooth is enabled. + * + *

If the value is {@code true}, Bluetooth is enabled. If the value is {@code false}, Bluetooth is disabled. + * + * @since 7 */ - function getUri(name: string): string; + const BLUETOOTH_STATUS: string /** - * get value from settingsdata - * @since 8 - * @param dataAbilityHelper dataAbilityHelper instance - * @param name name - * @param defValue default value - * @return settingsdata value + * A constant of {@code AIRPLANE_MODE_RADIOS} to indicate that Bluetooth is disabled in airplane mode. + * + * @since 7 */ - function getValue(dataAbilityHelper: DataAbilityHelper, name: string, defValue: string): string; + const BLUETOOTH_RADIO: string /** - * set settingsdata value - * @need permission ohos.permission.WRITE_SYSTEM_SETTING - * @since 8 - * @param dataAbilityHelper dataAbilityHelper instance - * @param name name - * @param value value - * @return value set result + * A constant of {@code AIRPLANE_MODE_RADIOS} to indicate that cellular radio is disabled in airplane mode. + * + * @since 7 */ - function setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: string): boolean; + const CELL_RADIO: string + + /** + * A constant of {@code AIRPLANE_MODE_RADIOS} to indicate that NFC is disabled in airplane mode. + * + * @since 7 + */ + const NFC_RADIO: string + + /** + * A constant of {@code AIRPLANE_MODE_RADIOS} to indicate that Wi-Fi is disabled in airplane mode. + * + * @since 7 + */ + const WIFI_RADIO: string + + /** + * Specifies whether the Wi-Fi configuration created by the application of the device owner should be + * locked down. + * + *

If the value is {@code true}, the Wi-Fi configuration should be locked down. + * If the value is {@code false}, the Wi-Fi configuration should not be locked down. + * + * @since 7 + */ + const OWNER_LOCKDOWN_WIFI_CFG: string + + /** + * Indicates the maximum number of attempts to obtain an IP address from the DHCP server. + * + * @since 7 + */ + const WIFI_DHCP_MAX_RETRY_COUNT: string + + /** + * Indicates the maximum duration to hold a wake lock when waiting for the mobile data connection to + * establish after the Wi-Fi connection is disconnected. + * + * @since 7 + */ + const WIFI_TO_MOBILE_DATA_AWAKE_TIMEOUT: string + + /** + * Specifies whether Wi-Fi is enabled. + * + *

If the value is {@code true}, Wi-Fi is enabled. If the value is {@code false}, Wi-Fi is disabled. + * + * @since 7 + */ + const WIFI_STATUS: string + + /** + * Specifies whether Wi-Fi watchdog is enabled. + * + *

If the value is {@code true}, Wi-Fi watchdog is enabled. + * If the value is {@code false}, Wi-Fi watchdog is disabled. + * + * @since 7 + */ + const WIFI_WATCHDOG_STATUS: string + } + + /** + * Constructs a URI for a specific name-value pair for monitoring data of the ability that uses the Data + * template. + * + * @param name Indicates the name of the setting to set. + * @return Returns the corresponding URI; returns {@code null} if the URI does not exist. + * @since 7 + */ + function getURI(name: string, callback: AsyncCallback): void; + function getURI(name: string): Promise; + + /** + * Obtains the value of a specified character string in the database. + * + * @param dataAbilityHelper Indicates the {@link ohos.aafwk.ability.DataAbilityHelper} used to access + * the database. + * @param name Indicates the name of the character string. + * @return Returns the value of the character string in the table if any is found; returns {@code null} + * otherwise. + * @since 7 + */ + function getValue(dataAbilityHelper: DataAbilityHelper, name: string, callback: AsyncCallback): void; + function getValue(dataAbilityHelper: DataAbilityHelper, name: string): Promise; + + /** + * Saves a character string name and its value to the database. + * + * @param dataAbilityHelper Indicates the {@link ohos.aafwk.ability.DataAbilityHelper} used to access + * the database. + * @param name Indicates the name of the character string. + * @param value Indicates the value of the character string. + * @return Returns {@code true} if the operation is successful; returns {@code false} otherwise. + * @since 7 + * @hide SystemApi + */ + function setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object, callback: AsyncCallback): void; + function setValue(dataAbilityHelper: DataAbilityHelper, name: string, value: object): Promise; + + /** + * Enables or disables airplane mode. + * + * @param enable Specifies whether to enable airplane mode. The value {@code true} means to enable airplane + * mode, and {@code false} means to disable airplane mode. + * @return Returns {@code true} if the operation is successful; returns {@code false} otherwise. + * @since 7 + */ + function enableAirplaneMode(enable: boolean, callback: AsyncCallback): void; + function enableAirplaneMode(enable: boolean): Promise; + + /** + * Checks whether a specified application can show as float window. + * + * @param context Indicates the application context. + * @return Returns {@code true} if the application can draw over other applications; returns {@code false} + * otherwise. + * @since 7 + */ + function canShowFloating(callback: AsyncCallback): void; + function canShowFloating(): Promise; + + /** + * get settingsdata uri(synchronization method) + * @since 8 + * @param name Indicates the name of the setting to set. + * @return Return settingsdata uri. + */ + function getUriSync(name: string): string; + /** + * get value from settingsdata(synchronization method) + * @since 8 + * @param dataAbilityHelper Indicates dataAbilityHelper instance + * @param name Indicates the name of the character string. + * @param defValue Indicates the default value of the character string. + * @return settingsdata value + */ + function getValueSync(dataAbilityHelper: DataAbilityHelper, name: string, defValue: string): string; + + /** + * set settingsdata value(synchronization method) + * @need permission ohos.permission.WRITE_SYSTEM_SETTING + * @since 8 + * @param dataAbilityHelper Indicates dataAbilityHelper instance + * @param name Indicates the name of the character string. + * @param value Indicates the value of the character string. + * @return Returns {@code true} if the operation is successful; returns {@code false} otherwise. + */ + function setValueSync(dataAbilityHelper: DataAbilityHelper, name: string, value: string): boolean; } -export default settings; +export default settings; \ No newline at end of file -- Gitee From 3171b52686061274330253f074e0ffcafda89cf1 Mon Sep 17 00:00:00 2001 From: clevercong Date: Tue, 1 Mar 2022 19:38:52 +0800 Subject: [PATCH 08/18] update doc Signed-off-by: clevercong --- api/@ohos.net.webSocket.d.ts | 2 +- api/@ohos.telephony.call.d.ts | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/api/@ohos.net.webSocket.d.ts b/api/@ohos.net.webSocket.d.ts index ebf4dcd5ca..cbb967bee4 100644 --- a/api/@ohos.net.webSocket.d.ts +++ b/api/@ohos.net.webSocket.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2021 Huawei Device Co., Ltd. + * Copyright (C) 2022 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at diff --git a/api/@ohos.telephony.call.d.ts b/api/@ohos.telephony.call.d.ts index 11f0ddb79b..9a0f4077d0 100644 --- a/api/@ohos.telephony.call.d.ts +++ b/api/@ohos.telephony.call.d.ts @@ -42,8 +42,7 @@ declare namespace call { * Go to the dial screen and the called number is displayed. * * @param phoneNumber Indicates the called number. - * @syscap SystemCapability.SysAppComponents.CONTACT - * @devices phone, tablet + * @syscap SystemCapability.Applications.Contacts */ function makeCall(phoneNumber: string, callback: AsyncCallback): void; function makeCall(phoneNumber: string): Promise; -- Gitee From 9e0b1faa9327ac30c9795d6d0a06a5fbf6681a1e Mon Sep 17 00:00:00 2001 From: clevercong Date: Tue, 1 Mar 2022 19:45:46 +0800 Subject: [PATCH 09/18] update copyright date. Signed-off-by: clevercong --- api/@ohos.net.http.d.ts | 2 +- api/@ohos.net.socket.d.ts | 2 +- api/@ohos.telephony.call.d.ts | 2 +- api/@ohos.telephony.data.d.ts | 2 +- api/@ohos.telephony.observer.d.ts | 2 +- api/@ohos.telephony.radio.d.ts | 2 +- api/@ohos.telephony.sim.d.ts | 2 +- api/@ohos.telephony.sms.d.ts | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/api/@ohos.net.http.d.ts b/api/@ohos.net.http.d.ts index de5a6c3ec8..b6ecab57c1 100644 --- a/api/@ohos.net.http.d.ts +++ b/api/@ohos.net.http.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2021 Huawei Device Co., Ltd. + * Copyright (C) 2021-2022 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at diff --git a/api/@ohos.net.socket.d.ts b/api/@ohos.net.socket.d.ts index a659f947f7..fb88669e14 100644 --- a/api/@ohos.net.socket.d.ts +++ b/api/@ohos.net.socket.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2021 Huawei Device Co., Ltd. + * Copyright (C) 2021-2022 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at diff --git a/api/@ohos.telephony.call.d.ts b/api/@ohos.telephony.call.d.ts index 9a0f4077d0..d1e4486775 100644 --- a/api/@ohos.telephony.call.d.ts +++ b/api/@ohos.telephony.call.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2021 Huawei Device Co., Ltd. + * Copyright (C) 2021-2022 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at diff --git a/api/@ohos.telephony.data.d.ts b/api/@ohos.telephony.data.d.ts index 8f394b6477..d32d033a35 100644 --- a/api/@ohos.telephony.data.d.ts +++ b/api/@ohos.telephony.data.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2021 Huawei Device Co., Ltd. + * Copyright (C) 2021-2022 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at diff --git a/api/@ohos.telephony.observer.d.ts b/api/@ohos.telephony.observer.d.ts index 2fd39fa9c0..8193aca055 100644 --- a/api/@ohos.telephony.observer.d.ts +++ b/api/@ohos.telephony.observer.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2021 Huawei Device Co., Ltd. + * Copyright (C) 2021-2022 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at diff --git a/api/@ohos.telephony.radio.d.ts b/api/@ohos.telephony.radio.d.ts index e3a6bcbeb9..c7486d60a3 100644 --- a/api/@ohos.telephony.radio.d.ts +++ b/api/@ohos.telephony.radio.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2021 Huawei Device Co., Ltd. + * Copyright (C) 2021-2022 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at diff --git a/api/@ohos.telephony.sim.d.ts b/api/@ohos.telephony.sim.d.ts index 93237791f0..3b3eac8443 100644 --- a/api/@ohos.telephony.sim.d.ts +++ b/api/@ohos.telephony.sim.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2021 Huawei Device Co., Ltd. + * Copyright (C) 2021-2022 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at diff --git a/api/@ohos.telephony.sms.d.ts b/api/@ohos.telephony.sms.d.ts index f011e9dd03..d674251555 100644 --- a/api/@ohos.telephony.sms.d.ts +++ b/api/@ohos.telephony.sms.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2021 Huawei Device Co., Ltd. + * Copyright (C) 2021-2022 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at -- Gitee From 486be759c0807917cf4cac8547dae15e6d1ada51 Mon Sep 17 00:00:00 2001 From: guyuanzhang Date: Tue, 1 Mar 2022 19:50:02 +0800 Subject: [PATCH 10/18] IssueNo:#I4VUH0 Description: fix syscap err Sig: SIG_ApplicationFramework Feature or Bugfix: Feature Binary Source: No Signed-off-by: guyuanzhang Change-Id: I7afeadecfc43a92acf52fe19d2963b9b18ab00bf --- api/@internal/ets/lifecycle.d.ts | 88 +++++++++---------- api/@ohos.ability.dataUriUtils.d.ts | 8 +- api/@ohos.ability.featureAbility.d.ts | 24 ++--- api/@ohos.ability.particleAbility.d.ts | 8 +- api/@ohos.ability.wantConstant.d.ts | 6 +- api/@ohos.app.abilityManager.d.ts | 10 +-- api/@ohos.application.AbilityConstant.d.ts | 12 +-- api/@ohos.application.AbilityStage.d.ts | 1 - api/@ohos.application.ServiceExtAbility.d.ts | 23 ++--- api/@ohos.application.StartOptions.d.ts | 7 +- api/@ohos.application.Want.d.ts | 20 ++--- api/@ohos.application.abilityManager.d.ts | 12 +-- api/@ohos.application.appManager.d.ts | 20 ++--- api/@ohos.application.formBindingData.d.ts | 4 +- api/@ohos.application.missionManager.d.ts | 22 ++--- ...ohos.application.uriPermissionManager.d.ts | 4 +- api/ability/abilityResult.d.ts | 6 +- api/ability/connectOptions.d.ts | 8 +- api/ability/continueAbilityOptions.d.ts | 6 +- api/ability/dataAbilityHelper.d.ts | 28 +++--- api/ability/dataAbilityOperation.d.ts | 18 ++-- api/ability/dataAbilityResult.d.ts | 6 +- api/ability/startAbilityParameter.d.ts | 6 +- api/ability/want.d.ts | 24 ++--- api/app/abilityMissionInfo.d.ts | 10 +-- api/app/activeProcessInfo.d.ts | 10 +-- api/app/context.d.ts | 34 +++---- api/app/processInfo.d.ts | 6 +- api/application/AbilityRunningInfo.d.ts | 16 ++-- api/application/AbilityStateData.d.ts | 15 ++-- api/application/AppStateData.d.ts | 8 +- api/application/ApplicationStateObserver.d.ts | 10 +-- api/application/BaseContext.d.ts | 4 +- api/application/Context.d.ts | 28 +++--- api/application/EventHub.d.ts | 12 +-- api/application/ExtAbilityContext.d.ts | 5 +- api/application/ExtensionRunningInfo.d.ts | 16 ++-- api/application/FormExtensionContext.d.ts | 4 +- api/application/MissionInfo.d.ts | 19 ++-- api/application/MissionListener.d.ts | 10 +-- api/application/MissionSnapshot.d.ts | 6 +- api/application/PermissionRequestResult.d.ts | 6 +- api/application/ProcessData.d.ts | 8 +- api/application/ProcessRunningInfo.d.ts | 14 +-- api/application/ServiceExtAbilityContext.d.ts | 21 ++--- api/application/ServiceExtensionContext.d.ts | 16 ++-- 46 files changed, 312 insertions(+), 337 deletions(-) diff --git a/api/@internal/ets/lifecycle.d.ts b/api/@internal/ets/lifecycle.d.ts index e93c7b285f..1ab0f948b8 100644 --- a/api/@internal/ets/lifecycle.d.ts +++ b/api/@internal/ets/lifecycle.d.ts @@ -31,7 +31,7 @@ import { PacMap } from "../ability/dataAbilityHelper"; * * @name LifecycleForm * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ export declare interface LifecycleForm { @@ -39,7 +39,7 @@ export declare interface LifecycleForm { * Called to return a {@link formBindingData.FormBindingData} object. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates the detailed information for creating a {@link formBindingData#FormBindingData}. * The {@code Want} object must include the form ID, form name, and grid style of the form, * which can be obtained from {@link formManager#FormParam#IDENTITY_KEY}, @@ -55,7 +55,7 @@ export declare interface LifecycleForm { * Called when the form provider is notified that a temporary form is successfully converted to a normal form. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param formId Indicates the ID of the form. * @return - * @FAModelOnly @@ -66,7 +66,7 @@ export declare interface LifecycleForm { * Called to notify the form provider to update a specified form. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param formId Indicates the ID of the form to update. * @return - * @FAModelOnly @@ -77,7 +77,7 @@ export declare interface LifecycleForm { * Called when the form provider receives form events from the system. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param newStatus Indicates the form events occurred. The key in the {@code Map} object indicates the form ID, * and the value indicates the event type, which can be either {@link formManager#VisibilityType#FORM_VISIBLE} * or {@link formManager#VisibilityType#FORM_INVISIBLE}. {@link formManager#VisibilityType#FORM_VISIBLE} @@ -93,7 +93,7 @@ export declare interface LifecycleForm { * JS forms. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param formId Indicates the ID of the form on which the message event is triggered, which is provided by * the client to the form provider. * @param message Indicates the value of the {@code params} field of the message event. This parameter is @@ -108,7 +108,7 @@ export declare interface LifecycleForm { * you want your application, as the form provider, to be notified of form deletion. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param formId Indicates the ID of the deleted form. * @return - * @FAModelOnly @@ -122,7 +122,7 @@ export declare interface LifecycleForm { * this method returns {@link FormState#DEFAULT} by default.

* * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates the description of the form for which the {@link formManager#FormState} is obtained. * The description covers the bundle name, ability name, module name, form name, and form dimensions. * @return Returns the {@link formManager#FormState} object. @@ -136,7 +136,7 @@ export declare interface LifecycleForm { * * @name LifecycleApp * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAMode + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ export declare interface LifecycleApp { @@ -144,7 +144,7 @@ export declare interface LifecycleApp { * Called back when the state of an ability changes from BACKGROUND to INACTIVE. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -154,7 +154,7 @@ export declare interface LifecycleApp { * Called back when an ability enters the BACKGROUND state. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -164,7 +164,7 @@ export declare interface LifecycleApp { * Called back before an ability is destroyed. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -174,7 +174,7 @@ export declare interface LifecycleApp { * Called back when an ability is started for initialization. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -185,7 +185,7 @@ export declare interface LifecycleApp { * to multi-window mode or from multi-window mode to fullscreen mode. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param isShownInMultiWindow Specifies whether this ability is currently in multi-window mode. * The value {@code true} indicates the multi-window mode, and {@code false} indicates another mode. * @param newConfig Indicates the new configuration information about this Page ability. @@ -199,7 +199,7 @@ export declare interface LifecycleApp { * Asks a user whether to start the migration. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return Returns {@code true} if the user allows the migration; returns {@code false} otherwise. * @FAModelOnly */ @@ -211,7 +211,7 @@ export declare interface LifecycleApp { * Scheduler Service requests data from the local ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param data Indicates the user data to save. * @return Returns {@code true} if the data is successfully saved; returns {@code false} otherwise. * @FAModelOnly @@ -225,7 +225,7 @@ export declare interface LifecycleApp { * notify the user of the successful migration and then exit the local ability.

* * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param result Indicates the migration result code. The value {@code 0} indicates that the migration is * successful, and {@code -1} indicates that the migration fails. * @return - @@ -239,7 +239,7 @@ export declare interface LifecycleApp { * is restored. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param data Indicates the user data to restore. * @return - * @FAModelOnly @@ -251,7 +251,7 @@ export declare interface LifecycleApp { * migration is performed for the ability from the local device to the remote device. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -263,7 +263,7 @@ export declare interface LifecycleApp { * this method is used only to save temporary states. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param outState Indicates the {@code PacMap} object used for storing user data and states. This * parameter cannot be null. * @return - @@ -277,7 +277,7 @@ export declare interface LifecycleApp { * states. Generally, this method is called after the {@link #onStart(Want)} method. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param inState Indicates the {@code PacMap} object used for storing data and states. This * parameter can not be null. * @return - @@ -290,7 +290,7 @@ export declare interface LifecycleApp { * change to the BACKGROUND or ACTIVE state). * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -300,7 +300,7 @@ export declare interface LifecycleApp { * Called back when an ability enters the ACTIVE state. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -310,7 +310,7 @@ export declare interface LifecycleApp { * Called when the launch mode of an ability is set to singleton. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates the new {@code want} containing information about the ability. * @return - * @FAModelOnly @@ -322,7 +322,7 @@ export declare interface LifecycleApp { * background and there is no enough memory for running as many background processes as possible. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param level Indicates the memory trim level, which shows the current memory usage status. * @return - * @FAModelOnly @@ -335,7 +335,7 @@ export declare interface LifecycleApp { * * @name LifecycleService * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAMode + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ export declare interface LifecycleService { @@ -344,7 +344,7 @@ export declare interface LifecycleService { * an ability). * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -354,7 +354,7 @@ export declare interface LifecycleService { * Called back when Service is started. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates the want of Service to start. * @param startId Indicates the number of times the Service ability has been started. The {@code startId} is * incremented by 1 every time the ability is started. For example, if the ability has been started @@ -368,7 +368,7 @@ export declare interface LifecycleService { * Called back before an ability is destroyed. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -378,7 +378,7 @@ export declare interface LifecycleService { * Called back when a Service ability is first connected to an ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates connection information about the Service ability. * @return Returns the proxy of the Service ability. * @FAModelOnly @@ -389,7 +389,7 @@ export declare interface LifecycleService { * Called back when all abilities connected to a Service ability are disconnected. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates disconnection information about the Service ability. * @return - * @FAModelOnly @@ -404,7 +404,7 @@ export declare interface LifecycleService { * called but {@link #terminateSelf} has not.

* * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param want Indicates the want of the Service ability being connected. * @return - * @FAModelOnly @@ -417,7 +417,7 @@ export declare interface LifecycleService { * * @name LifecycleData * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAMode + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ export declare interface LifecycleData { @@ -425,7 +425,7 @@ export declare interface LifecycleData { * Updates one or more data records in the database. This method should be implemented by a Data ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the database table storing the data to update. * @param valueBucket Indicates the data to update. This parameter can be null. * @param predicates Indicates filter criteria. If this parameter is null, all data records will be updated by @@ -441,7 +441,7 @@ export declare interface LifecycleData { * Queries one or more data records in the database. This method should be implemented by a Data ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the database table storing the data to query. * @param columns Indicates the columns to be queried, in array, for example, {"name","age"}. You should define * the processing logic when this parameter is null. @@ -458,7 +458,7 @@ export declare interface LifecycleData { * Deletes one or more data records. This method should be implemented by a Data ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the database table storing the data to delete. * @param predicates Indicates filter criteria. If this parameter is null, all data records will be deleted by * default. @@ -475,7 +475,7 @@ export declare interface LifecycleData { * even if the context has changed. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the uri to normalize. * @param callback function specified by framework to receive the result, developer should call this function to * return the result to framework. @@ -488,7 +488,7 @@ export declare interface LifecycleData { * Inserts multiple data records into the database. This method should be implemented by a Data ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the position where the data is to insert. * @param valueBuckets Indicates the data to insert. * @param callback function specified by framework to receive the result, developer should call this function to @@ -503,7 +503,7 @@ export declare interface LifecycleData { * The default implementation of this method returns the original uri passed to it. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the uri to denormalize. * @param callback function specified by framework to receive the result, developer should call this function to * return the result to framework. @@ -516,7 +516,7 @@ export declare interface LifecycleData { * Inserts a data record into the database. This method should be implemented by a Data ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the position where the data is to insert. * @param valueBucket Indicates the data to insert. * @param callback function specified by framework to receive the result, developer should call this function to @@ -530,7 +530,7 @@ export declare interface LifecycleData { * Opens a file. This method should be implemented by a Data ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the file to open. * @param mode Indicates the open mode, which can be "r" for read-only access, "w" for write-only access (erasing * whatever data is currently in the file), "wt" for write access that truncates any existing file, @@ -547,7 +547,7 @@ export declare interface LifecycleData { * Obtains the MIME type of files. This method should be implemented by a Data ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the files to obtain. * @param mimeTypeFilter Indicates the MIME type of the files to obtain. This parameter cannot be set to {@code * null}. @@ -565,7 +565,7 @@ export declare interface LifecycleData { * Called to carry {@code AbilityInfo} to this ability after the ability is initialized. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param info Indicates the {@code AbilityInfo} object containing information about this ability. * @return - * @FAModelOnly @@ -579,7 +579,7 @@ export declare interface LifecycleData { *

Data abilities supports general data types, including text, HTML, and JPEG.

* * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the uri of the data. * @param callback function specified by framework to receive the result, developer should call this function to * return the result to framework. diff --git a/api/@ohos.ability.dataUriUtils.d.ts b/api/@ohos.ability.dataUriUtils.d.ts index 3b978c07dd..af7b680500 100644 --- a/api/@ohos.ability.dataUriUtils.d.ts +++ b/api/@ohos.ability.dataUriUtils.d.ts @@ -25,7 +25,7 @@ declare namespace dataUriUtils { * Obtains the ID attached to the end of the path component of the given uri. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param uri Indicates the uri object from which the ID is to be obtained. * @return Returns the ID attached to the end of the path component; */ @@ -35,7 +35,7 @@ declare namespace dataUriUtils { * Attaches the given ID to the end of the path component of the given uri. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param uri Indicates the uri string from which the ID is to be obtained. * @param id Indicates the ID to attach. * @return Returns the uri object with the given ID attached. @@ -46,7 +46,7 @@ declare namespace dataUriUtils { * Deletes the ID from the end of the path component of the given uri. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param uri Indicates the uri object from which the ID is to be deleted. * @return Returns the uri object with the ID deleted. */ @@ -56,7 +56,7 @@ declare namespace dataUriUtils { * Updates the ID in the specified uri * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param uri Indicates the uri object to be updated. * @param id Indicates the new ID. * @return Returns the updated uri object. diff --git a/api/@ohos.ability.featureAbility.d.ts b/api/@ohos.ability.featureAbility.d.ts index 20b110239b..0aebda140e 100644 --- a/api/@ohos.ability.featureAbility.d.ts +++ b/api/@ohos.ability.featureAbility.d.ts @@ -25,7 +25,7 @@ import { ContinueAbilityOptions } from './ability/continueAbilityOptions'; * A Feature Ability represents an ability with a UI and is designed to interact with users. * @name featureAbility * @since 6 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @permission N/A * @FAModelOnly */ @@ -34,7 +34,7 @@ declare namespace featureAbility { * Obtain the want sended from the source ability. * * @since 6 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the ability to start. * @return - * @FAModelOnly @@ -46,7 +46,7 @@ declare namespace featureAbility { * Starts a new ability. * * @since 6 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the ability to start. * @return - * @FAModelOnly @@ -57,7 +57,7 @@ declare namespace featureAbility { /** * Obtains the application context. * - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return Returns the application context. * @since 6 * @FAModelOnly @@ -68,7 +68,7 @@ declare namespace featureAbility { * Starts an ability and returns the execution result when the ability is destroyed. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the ability to start. * @return Returns the {@link AbilityResult}. * @FAModelOnly @@ -81,7 +81,7 @@ declare namespace featureAbility { * and destroys this Page ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the result to return. * @return - * @FAModelOnly @@ -93,7 +93,7 @@ declare namespace featureAbility { * Destroys this Page ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -104,7 +104,7 @@ declare namespace featureAbility { * Obtains the dataAbilityHelper. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the file to open. * @return Returns the dataAbilityHelper. * @FAModelOnly @@ -115,7 +115,7 @@ declare namespace featureAbility { * Checks whether the main window of this ability has window focus. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return Returns {@code true} if this ability currently has window focus; returns {@code false} otherwise. * @FAModelOnly */ @@ -126,7 +126,7 @@ declare namespace featureAbility { * Connects the current ability to an ability using the AbilityInfo.AbilityType.SERVICE template. * @default - * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param request The element name of the service ability * @param options The remote object instance * @return Returns the number code of the ability connected @@ -138,7 +138,7 @@ declare namespace featureAbility { * The callback interface was connect successfully. * @default - * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param connection The number code of the ability connected * @FAModelOnly */ @@ -149,7 +149,7 @@ declare namespace featureAbility { * Migrates this ability to the given device on the same distributed network. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ diff --git a/api/@ohos.ability.particleAbility.d.ts b/api/@ohos.ability.particleAbility.d.ts index fc367272ac..968b176d9c 100644 --- a/api/@ohos.ability.particleAbility.d.ts +++ b/api/@ohos.ability.particleAbility.d.ts @@ -22,7 +22,7 @@ import { NotificationRequest } from './notification/notificationRequest'; * A Particle Ability represents an ability with service. * @name particleAbility * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @permission N/A * @FAModelOnly */ @@ -31,7 +31,7 @@ declare namespace particleAbility { * Service ability uses this method to start a specific ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param parameter Indicates the ability to start. * @return - * @FAModelOnly @@ -43,7 +43,7 @@ declare namespace particleAbility { * Destroys this service ability. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @return - * @FAModelOnly */ @@ -54,7 +54,7 @@ declare namespace particleAbility { * Obtains the dataAbilityHelper. * * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the file to open. * @return Returns the dataAbilityHelper. * @FAModelOnly diff --git a/api/@ohos.ability.wantConstant.d.ts b/api/@ohos.ability.wantConstant.d.ts index a0483c0095..bc93801bab 100644 --- a/api/@ohos.ability.wantConstant.d.ts +++ b/api/@ohos.ability.wantConstant.d.ts @@ -17,7 +17,7 @@ * the constant for action and entity in the want * @name wantConstant * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @permission N/A */ declare namespace wantConstant { @@ -25,7 +25,7 @@ declare namespace wantConstant { * the constant for action of the want * @name Action * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @permission N/A */ export enum Action { @@ -221,7 +221,7 @@ declare namespace wantConstant { * the constant for Entity of the want * @name Action * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @permission N/A */ export enum Entity { diff --git a/api/@ohos.app.abilityManager.d.ts b/api/@ohos.app.abilityManager.d.ts index 9b430de3ca..cc24a83c7b 100644 --- a/api/@ohos.app.abilityManager.d.ts +++ b/api/@ohos.app.abilityManager.d.ts @@ -22,7 +22,7 @@ import { MissionSnapshot } from './app/missionSnapshot'; * This module provides the capability to manage abilities and obtaining system task information. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @import import abilityManager from '@ohos.app.abilityManager' * @permission N/A */ @@ -38,7 +38,7 @@ declare namespace abilityManager { /** * Get information about running processes * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @return a list of ActiveProcessInfo records describing each process. * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION * @systemapi hide this for inner system use @@ -49,7 +49,7 @@ declare namespace abilityManager { /** * Get information about the running ability missions * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param upperLimit The maximum number of mission infos to return in the array. * @return an array of AbilityMissionInfo records describing each active mission. * @permission ohos.permission.ACCESS_MISSIONS @@ -61,7 +61,7 @@ declare namespace abilityManager { /** * Get information about recently run missions * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param upperLimit The maximum number of previous mission infos to return in the array. * @return an array of AbilityMissionInfo records describing each of the previous mission. * @permission ohos.permission.ACCESS_MISSIONS_EXTRA @@ -73,7 +73,7 @@ declare namespace abilityManager { /** * Delete the specified missions * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param missionIds An array of missions, representing the missions that need to be deleted. * @permission ohos.permission.DELETE_MISSIONS * @systemapi hide this for inner system use diff --git a/api/@ohos.application.AbilityConstant.d.ts b/api/@ohos.application.AbilityConstant.d.ts index d2691c2e98..e43db61c8a 100644 --- a/api/@ohos.application.AbilityConstant.d.ts +++ b/api/@ohos.application.AbilityConstant.d.ts @@ -17,7 +17,7 @@ * The definition of AbilityConstant. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -26,7 +26,7 @@ declare namespace AbilityConstant { * Interface of launch param. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ export interface LaunchParam { @@ -34,7 +34,7 @@ declare namespace AbilityConstant { * Indicates launch reason. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ launchReason: LaunchReason; @@ -43,7 +43,7 @@ declare namespace AbilityConstant { * Indicates last exit reason. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ lastExitReason: LastExitReason; @@ -53,7 +53,7 @@ declare namespace AbilityConstant { * Type of launch reason. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ export enum LaunchReason { @@ -67,7 +67,7 @@ declare namespace AbilityConstant { * Type of last exit reason. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ export enum LastExitReason { diff --git a/api/@ohos.application.AbilityStage.d.ts b/api/@ohos.application.AbilityStage.d.ts index 7d1762c145..5ef0796012 100644 --- a/api/@ohos.application.AbilityStage.d.ts +++ b/api/@ohos.application.AbilityStage.d.ts @@ -48,7 +48,6 @@ export default class AbilityStage { /** * Called back when start specified ability. * - * @devices phone, tablet, tv, wearable, car * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Core * @return - diff --git a/api/@ohos.application.ServiceExtAbility.d.ts b/api/@ohos.application.ServiceExtAbility.d.ts index 57a549082f..c87682539c 100644 --- a/api/@ohos.application.ServiceExtAbility.d.ts +++ b/api/@ohos.application.ServiceExtAbility.d.ts @@ -21,8 +21,7 @@ import Want from './@ohos.application.Want'; * class of service extension ability. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @StageModelOnly */ @@ -31,7 +30,7 @@ export default class ServiceExtAbility { * Indicates service extension ability context. * * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @StageModelOnly */ @@ -40,9 +39,8 @@ export default class ServiceExtAbility { /** * Called back when a service extension is started for initialization. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @return - * @StageModelOnly @@ -52,9 +50,8 @@ export default class ServiceExtAbility { /** * Called back before a service extension is destroyed. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @return - * @StageModelOnly @@ -64,9 +61,8 @@ export default class ServiceExtAbility { /** * Called back when a service extension is started. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want Indicates the want of service extension to start. * @param startId Indicates the number of times the service extension has been started. The {@code startId} is * incremented by 1 every time the service extension is started. For example, if the service extension @@ -80,9 +76,8 @@ export default class ServiceExtAbility { /** * Called back when a service extension is first connected to an ability. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want Indicates connection information about the Service ability. * @systemapi hide for inner use. * @return Returns the proxy of the Service ability. @@ -93,9 +88,8 @@ export default class ServiceExtAbility { /** * Called back when all abilities connected to a service extension are disconnected. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want Indicates disconnection information about the service extension. * @systemapi hide for inner use. * @return - @@ -107,9 +101,8 @@ export default class ServiceExtAbility { * Called when a new client attempts to connect to a service extension after all previous client connections to it * are disconnected. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param want Indicates the want of the service extension being connected. * @systemapi hide for inner use. * @return - diff --git a/api/@ohos.application.StartOptions.d.ts b/api/@ohos.application.StartOptions.d.ts index 5c0b9e7d04..b4cd41bbce 100644 --- a/api/@ohos.application.StartOptions.d.ts +++ b/api/@ohos.application.StartOptions.d.ts @@ -18,7 +18,7 @@ * * @name StartOptions * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -27,7 +27,7 @@ export default class StartOptions { * windowMode * @default - * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ windowMode?: number; @@ -35,9 +35,8 @@ export default class StartOptions { /** * displayId * @default - - * @devices phone, tablet * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ displayId?: number; diff --git a/api/@ohos.application.Want.d.ts b/api/@ohos.application.Want.d.ts index 337e376ae1..6b2c2b0ae6 100644 --- a/api/@ohos.application.Want.d.ts +++ b/api/@ohos.application.Want.d.ts @@ -18,7 +18,7 @@ * * @name Want * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @permission N/A */ export default class Want { @@ -26,7 +26,7 @@ export default class Want { * device id * @default - * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase */ deviceId?: string; @@ -34,7 +34,7 @@ export default class Want { * bundle name * @default - * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase */ bundleName?: string; @@ -42,14 +42,14 @@ export default class Want { * ability name * @default - * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase */ abilityName?: string; /** * The description of a URI in a Want. * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ uri?: string; @@ -57,7 +57,7 @@ export default class Want { /** * The description of the type in this Want. * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ type?: string; @@ -65,7 +65,7 @@ export default class Want { /** * The options of the flags in this Want. * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ flags?: number; @@ -73,7 +73,7 @@ export default class Want { /** * The description of an action in an want. * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ action?: string; @@ -81,7 +81,7 @@ export default class Want { /** * The description of the WantParams object in an Want * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ parameters?: {[key: string]: any}; @@ -89,7 +89,7 @@ export default class Want { /** * The description of a entities in a Want. * @since 8 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ entities?: Array; diff --git a/api/@ohos.application.abilityManager.d.ts b/api/@ohos.application.abilityManager.d.ts index ff2426a5e7..44885db203 100644 --- a/api/@ohos.application.abilityManager.d.ts +++ b/api/@ohos.application.abilityManager.d.ts @@ -22,7 +22,7 @@ import { ExtensionRunningInfo } from './application/ExtensionRunningInfo'; * The class of an ability manager. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ declare namespace abilityManager { @@ -30,7 +30,7 @@ declare namespace abilityManager { /** * @name AbilityState * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export enum AbilityState { @@ -45,7 +45,7 @@ declare namespace abilityManager { * Updates the configuration by modifying the configuration. * * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param config Indicates the new configuration. * @systemapi Hide this for inner system use. * @return - @@ -57,18 +57,18 @@ declare namespace abilityManager { * Get information about running abilitys * * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi Hide this for inner system use. * @return - */ function getAbilityRunningInfos(): Promise>; function getAbilityRunningInfos(callback: AsyncCallback>): void; - + /** * Get information about running extensions * * @since 9 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param upperLimit Get the maximum limit of the number of messages * @systemapi Hide this for inner system use. * @return - diff --git a/api/@ohos.application.appManager.d.ts b/api/@ohos.application.appManager.d.ts index dcb6dca86a..b6956e4857 100644 --- a/api/@ohos.application.appManager.d.ts +++ b/api/@ohos.application.appManager.d.ts @@ -22,7 +22,7 @@ import { ProcessRunningInfo } from './application/ProcessRunningInfo'; * This module provides the function of app manager service. * * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @import import appManager from '@ohos.application.appManager' * @permission N/A */ @@ -32,7 +32,7 @@ declare namespace appManager { * * @default - * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param observer The application state observer. * @systemapi hide this for inner system use * @return Returns the number code of the observer. @@ -43,7 +43,7 @@ declare namespace appManager { * Unregister application state observer. * * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param observerId Indicates the number code of the observer. * @systemapi hide this for inner system use * @return - @@ -55,7 +55,7 @@ declare namespace appManager { * getForegroundApplications. * * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide this for inner system use * @return Returns the list of AppStateData. */ @@ -66,7 +66,7 @@ declare namespace appManager { * Kill process with account. * * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param bundleName The process bundle name. * @param accountId The account id. * @systemapi hide this for inner system use @@ -79,7 +79,7 @@ declare namespace appManager { * Is user running in stability test. * * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @return Returns true if user is running stability test. */ function isRunningInStabilityTest(callback: AsyncCallback): void; @@ -89,7 +89,7 @@ declare namespace appManager { * Get information about running processes * * @since 8 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi Hide this for inner system use. * @return - */ @@ -99,8 +99,7 @@ declare namespace appManager { /** * Kill processes by bundle name * @since 8 - * @SysCap SystemCapability.Appexecfwk - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param bundleName bundle name. * @permission ohos.permission.DELETE_MISSIONS * @systemapi hide this for inner system use @@ -111,8 +110,7 @@ declare namespace appManager { /** * Clear up application data by bundle name * @since 8 - * @SysCap SystemCapability.Appexecfwk - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param bundleName bundle name. * @permission ohos.permission.DELETE_MISSIONS * @systemapi hide this for inner system use diff --git a/api/@ohos.application.formBindingData.d.ts b/api/@ohos.application.formBindingData.d.ts index ad39876591..6ede7819dc 100644 --- a/api/@ohos.application.formBindingData.d.ts +++ b/api/@ohos.application.formBindingData.d.ts @@ -18,14 +18,14 @@ * * @name formBindingData * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ declare namespace formBindingData { /** * Create an FormBindingData instance. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param obj Indicates the FormBindingData instance data. * @return Returns the {@link FormBindingData} instance. */ diff --git a/api/@ohos.application.missionManager.d.ts b/api/@ohos.application.missionManager.d.ts index 94f172f8e5..cc0a560a1a 100644 --- a/api/@ohos.application.missionManager.d.ts +++ b/api/@ohos.application.missionManager.d.ts @@ -24,7 +24,7 @@ import StartOptions from "./@ohos.application.StartOptions"; * * @name missionManager * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A * @systemapi hide for inner use. */ @@ -33,7 +33,7 @@ declare namespace missionManager { * Register the missionListener to ams. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return The index number of the MissionListener. */ function registerMissionListener(listener: MissionListener): number; @@ -42,7 +42,7 @@ declare namespace missionManager { * Unrgister the missionListener to ams. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function unregisterMissionListener(listenerId: number, callback: AsyncCallback): void; @@ -52,7 +52,7 @@ declare namespace missionManager { * Get the missionInfo with the given missionId. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return the {@link MissionInfo} of the given id. */ function getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback): void; @@ -62,7 +62,7 @@ declare namespace missionManager { * Get the missionInfo with the given missionId. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return The array of the {@link MissionInfo}. */ function getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback>): void; @@ -72,7 +72,7 @@ declare namespace missionManager { * Get the mission snapshot with the given missionId. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return The {@link MissionSnapshot} of the given id. */ function getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback): void; @@ -82,7 +82,7 @@ declare namespace missionManager { * Lock the mission. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function lockMission(missionId: number, callback: AsyncCallback): void; @@ -92,7 +92,7 @@ declare namespace missionManager { * Unlock the mission. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function unlockMission(missionId: number, callback: AsyncCallback): void; @@ -102,7 +102,7 @@ declare namespace missionManager { * Clear the given mission in the ability manager service. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function clearMission(missionId: number, callback: AsyncCallback): void; @@ -112,7 +112,7 @@ declare namespace missionManager { * Clear all missions in the ability manager service. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function clearAllMissions(callback: AsyncCallback): void; @@ -122,7 +122,7 @@ declare namespace missionManager { * Schedule the given mission to foreground. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ function moveMissionToFront(missionId: number, callback: AsyncCallback): void; diff --git a/api/@ohos.application.uriPermissionManager.d.ts b/api/@ohos.application.uriPermissionManager.d.ts index ad3ad1de00..37cd85441c 100644 --- a/api/@ohos.application.uriPermissionManager.d.ts +++ b/api/@ohos.application.uriPermissionManager.d.ts @@ -20,7 +20,7 @@ import wantConstant from "./@ohos.ability.wantConstant"; * The management class for uri of file. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ declare namespace uriPermissionManager { @@ -28,7 +28,7 @@ declare namespace uriPermissionManager { * Check whether the application corresponding to the accesstokenID has access rights to the URI. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param uri File URI. * @param flag wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION or wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION * @param accessTokenId Indicates the access token of the application. diff --git a/api/ability/abilityResult.d.ts b/api/ability/abilityResult.d.ts index bac8cd8756..253243e97f 100644 --- a/api/ability/abilityResult.d.ts +++ b/api/ability/abilityResult.d.ts @@ -16,7 +16,7 @@ import { Want } from './want'; /** * @since 7 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @permission N/A */ export interface AbilityResult { @@ -25,7 +25,7 @@ export interface AbilityResult { * code to identify an error. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase */ resultCode: number; @@ -34,7 +34,7 @@ export interface AbilityResult { * This parameter can be null. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase */ want?: Want; } \ No newline at end of file diff --git a/api/ability/connectOptions.d.ts b/api/ability/connectOptions.d.ts index 1604b9bf5e..8b283b0da1 100644 --- a/api/ability/connectOptions.d.ts +++ b/api/ability/connectOptions.d.ts @@ -17,7 +17,7 @@ import rpc from './../@ohos.rpc'; /** * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export interface ConnectOptions { @@ -26,7 +26,7 @@ export interface ConnectOptions { * * @default - * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param elementName The element name of the service ability * @param remoteObject The remote object instance */ @@ -37,7 +37,7 @@ export interface ConnectOptions { * * @default - * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param elementName The element name of the service ability */ onDisconnect: (elementName: ElementName) => void; @@ -47,7 +47,7 @@ export interface ConnectOptions { * * @default - * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param code The error code of the failed. */ onFailed: (code: number) => void; diff --git a/api/ability/continueAbilityOptions.d.ts b/api/ability/continueAbilityOptions.d.ts index 32c09d1414..12f2772298 100755 --- a/api/ability/continueAbilityOptions.d.ts +++ b/api/ability/continueAbilityOptions.d.ts @@ -15,7 +15,7 @@ /** * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export interface ContinueAbilityOptions { @@ -24,7 +24,7 @@ export interface ContinueAbilityOptions { * * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ deviceId: string; @@ -35,7 +35,7 @@ export interface ContinueAbilityOptions { * * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ reversible?: boolean; diff --git a/api/ability/dataAbilityHelper.d.ts b/api/ability/dataAbilityHelper.d.ts index f1cf3feefb..f1bf139a73 100644 --- a/api/ability/dataAbilityHelper.d.ts +++ b/api/ability/dataAbilityHelper.d.ts @@ -22,7 +22,7 @@ import rdb from '../@ohos.data.rdb'; /** * DataAbilityHelper - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * * @since 7 * @FAModelOnly @@ -32,7 +32,7 @@ export interface DataAbilityHelper { * Opens a file in a specified remote path. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the file to open. * @param mode Indicates the file open mode, which can be "r" for read-only access, "w" for write-only access * (erasing whatever data is currently in the file), "wt" for write access that truncates any existing @@ -49,7 +49,7 @@ export interface DataAbilityHelper { * Registers an observer to observe data specified by the given uri. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param type dataChange. * @param uri Indicates the path of the data to operate. * @param callback Indicates the callback when dataChange. @@ -62,7 +62,7 @@ export interface DataAbilityHelper { * Deregisters an observer used for monitoring data specified by the given uri. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param type dataChange. * @param uri Indicates the path of the data to operate. * @param callback Indicates the registered callback. @@ -75,7 +75,7 @@ export interface DataAbilityHelper { * Obtains the MIME type of the date specified by the given URI. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the data to operate. * @return Returns the MIME type that matches the data specified by uri. * @FAModelOnly @@ -87,7 +87,7 @@ export interface DataAbilityHelper { * Obtains the MIME types of files supported. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the files to obtain. * @param mimeTypeFilter Indicates the MIME types of the files to obtain. * @return Returns the matched MIME types Array. @@ -100,7 +100,7 @@ export interface DataAbilityHelper { * Converts the given uri that refers to the Data ability into a normalized uri. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the uri object to normalize. * @return Returns the normalized uri object if the Data ability supports URI normalization or null. * @FAModelOnly @@ -112,7 +112,7 @@ export interface DataAbilityHelper { * Converts the given normalized uri generated by normalizeUri(uri) into a denormalized one. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the uri object to normalize. * @return Returns the denormalized uri object if the denormalization is successful. * @FAModelOnly @@ -124,7 +124,7 @@ export interface DataAbilityHelper { * Notifies the registered observers of a change to the data resource specified by uri. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the data to operate. * @return - * @FAModelOnly @@ -136,7 +136,7 @@ export interface DataAbilityHelper { * Inserts a single data record into the database. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the data to insert. * @param valuesBucket Indicates the data record to insert. If this parameter is null, a blank row will be inserted. * @return Returns the index of the inserted data record. @@ -149,7 +149,7 @@ export interface DataAbilityHelper { * Inserts multiple data records into the database. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the data to batchInsert. * @param valuesBuckets Indicates the data records to insert. * @return Returns the number of data records inserted. @@ -162,7 +162,7 @@ export interface DataAbilityHelper { * Deletes one or more data records from the database. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of the data to delete. * @param predicates Indicates filter criteria. You should define the processing logic when this parameter is null. * @return Returns the number of data records deleted. @@ -175,7 +175,7 @@ export interface DataAbilityHelper { * Updates data records in the database. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of data to update. * @param valuesBucket Indicates the data to update. * @param predicates Indicates filter criteria. You should define the processing logic when this parameter is null. @@ -189,7 +189,7 @@ export interface DataAbilityHelper { * Queries data in the database. * * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @param uri Indicates the path of data to query. * @param columns Indicates the columns to query. If this parameter is null, all columns are queried. * @param predicates Indicates filter criteria. You should define the processing logic when this parameter is null. diff --git a/api/ability/dataAbilityOperation.d.ts b/api/ability/dataAbilityOperation.d.ts index 4d961357d1..8b8a1ca9c8 100644 --- a/api/ability/dataAbilityOperation.d.ts +++ b/api/ability/dataAbilityOperation.d.ts @@ -19,7 +19,7 @@ import rdb from '../@ohos.data.rdb'; /** * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @permission N/A */ export interface DataAbilityOperation { @@ -27,7 +27,7 @@ export interface DataAbilityOperation { * Indicates the path of data to operate. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ uri: string; @@ -36,7 +36,7 @@ export interface DataAbilityOperation { * Indicates a operation type. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ type: featureAbility.DataAbilityOperationType; @@ -45,7 +45,7 @@ export interface DataAbilityOperation { * Indicates the data values to be set. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ valuesBucket?: rdb.ValuesBucket; @@ -54,7 +54,7 @@ export interface DataAbilityOperation { * Indicates the valuesBucket object containing a set of key-value pairs. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ valueBackReferences?: rdb.ValuesBucket; @@ -64,7 +64,7 @@ export interface DataAbilityOperation { * will be operated by default. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ predicates?: dataAbility.DataAbilityPredicates; @@ -73,7 +73,7 @@ export interface DataAbilityOperation { * Indicates the back reference to be used as a filter criterion in predicates. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ predicatesBackReferences?: Map; @@ -82,7 +82,7 @@ export interface DataAbilityOperation { * Specifies whether a batch operation can be interrupted. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ interrupted?: boolean; @@ -91,7 +91,7 @@ export interface DataAbilityOperation { * Indicates the expected number of rows to update or delete. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ expectedCount?: number; diff --git a/api/ability/dataAbilityResult.d.ts b/api/ability/dataAbilityResult.d.ts index e7c53bc8f7..4b6600d682 100644 --- a/api/ability/dataAbilityResult.d.ts +++ b/api/ability/dataAbilityResult.d.ts @@ -16,7 +16,7 @@ /** * @name DataAbilityResult * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @permission N/A */ export interface DataAbilityResult { @@ -24,7 +24,7 @@ export interface DataAbilityResult { * Indicates the path of data to operate. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ uri?: string; @@ -33,7 +33,7 @@ export interface DataAbilityResult { * Indicates the number of rows affected by the operation. * @default - * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ count?:number; diff --git a/api/ability/startAbilityParameter.d.ts b/api/ability/startAbilityParameter.d.ts index 7ad38ddddd..29a635d29c 100644 --- a/api/ability/startAbilityParameter.d.ts +++ b/api/ability/startAbilityParameter.d.ts @@ -16,7 +16,7 @@ import { Want } from './want'; /** * @since 3 - * @sysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @permission N/A */ export interface StartAbilityParameter { @@ -25,7 +25,7 @@ export interface StartAbilityParameter { * * @default - * @since 3 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ want: Want; @@ -35,7 +35,7 @@ export interface StartAbilityParameter { * * @default - * @since 3 - * @SysCap SystemCapability.Ability.AbilityRuntime.FAModel + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel * @FAModelOnly */ abilityStartSetting?: {[key: string]: any}; diff --git a/api/ability/want.d.ts b/api/ability/want.d.ts index f6c264684f..40bfe433ae 100644 --- a/api/ability/want.d.ts +++ b/api/ability/want.d.ts @@ -17,7 +17,7 @@ * Want is the basic communication component of the system. * @name Want * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @permission N/A */ export declare interface Want { @@ -25,7 +25,7 @@ export declare interface Want { * device id * @default - * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase */ deviceId?: string; @@ -33,7 +33,7 @@ export declare interface Want { * bundle name * @default - * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase */ bundleName?: string; @@ -41,14 +41,14 @@ export declare interface Want { * ability name * @default - * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase */ abilityName?: string; /** * The description of a URI in a Want. * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ uri?: string; @@ -56,7 +56,7 @@ export declare interface Want { /** * The description of the type in this Want. * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ type?: string; @@ -64,7 +64,7 @@ export declare interface Want { /** * The options of the flags in this Want. * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ flags?: number; @@ -72,7 +72,7 @@ export declare interface Want { /** * The description of an action in an want. * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ action?: string; @@ -80,7 +80,7 @@ export declare interface Want { /** * The description of the WantParams object in an Want * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ parameters?: {[key: string]: any}; @@ -88,7 +88,7 @@ export declare interface Want { /** * The description of a entities in a Want. * @since 6 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ entities?: Array; @@ -96,7 +96,7 @@ export declare interface Want { /** * The description of a extension ability name in a Want. * @since 9 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ extensionAbilityName?: string; @@ -104,7 +104,7 @@ export declare interface Want { /** * The description of a extension ability type in a Want. * @since 9 - * @sysCap SystemCapability.Ability.AbilityBase + * @syscap SystemCapability.Ability.AbilityBase * @default - */ extensionAbilityType?: number; diff --git a/api/app/abilityMissionInfo.d.ts b/api/app/abilityMissionInfo.d.ts index 19c7870cd4..082993e896 100644 --- a/api/app/abilityMissionInfo.d.ts +++ b/api/app/abilityMissionInfo.d.ts @@ -18,7 +18,7 @@ import { ElementName } from '../bundle/elementName'; /** * @name Mission information corresponding to ability * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @import import AbilityMissionInfo from 'app/abilityMissionInfo' * @permission N/A */ @@ -26,7 +26,7 @@ export interface AbilityMissionInfo { /** * @default Unique identification of task stack information corresponding to ability * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ missionId: number; @@ -34,7 +34,7 @@ export interface AbilityMissionInfo { * @default The component launched as the first ability in the task stack * This can be considered the "application" of this task stack * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ bottomAbility: ElementName; @@ -42,14 +42,14 @@ export interface AbilityMissionInfo { * @default The ability component at the top of the history stack of the task * This is what the user is currently doing * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ topAbility: ElementName; /** * @default The corresponding ability description information in the task stack * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ windowMode: number; } diff --git a/api/app/activeProcessInfo.d.ts b/api/app/activeProcessInfo.d.ts index 68571a2d49..72ac4eb1bb 100644 --- a/api/app/activeProcessInfo.d.ts +++ b/api/app/activeProcessInfo.d.ts @@ -16,7 +16,7 @@ /** * @name This class saves process information about an application * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @import import app from 'app/activeProcessInfo' * @permission N/A */ @@ -24,28 +24,28 @@ export interface ActiveProcessInfo { /** * @default process id * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ pid: number; /** * @default user id * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ uid: number; /** * @default the name of the process * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ processName: string; /** * @default an array of the bundleNames running in the process * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ bundleNames: Array; } diff --git a/api/app/context.d.ts b/api/app/context.d.ts index 6bdb28af61..06097c18c9 100644 --- a/api/app/context.d.ts +++ b/api/app/context.d.ts @@ -25,7 +25,7 @@ import BaseContext from '../application/BaseContext'; * Can only be obtained through the ability. * * @since 6 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @import import abilityManager from 'app/context' * @permission N/A * @FAModelOnly @@ -39,7 +39,7 @@ export interface Context extends BaseContext { * the ability; if in the context of the application, return the * root dir of the application. * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @return the root dir * @FAModelOnly */ @@ -54,7 +54,7 @@ export interface Context extends BaseContext { * @note Pid and uid are optional. If you do not pass in pid and uid, * it will check your own permission. * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @return asynchronous callback with {@code 0} if the PID * and UID have the permission; callback with {@code -1} otherwise. * @FAModelOnly @@ -68,7 +68,7 @@ export interface Context extends BaseContext { * @param permissions Indicates the list of permissions to be requested. This parameter cannot be null. * @param requestCode Indicates the request code to be passed to the PermissionRequestResult * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ requestPermissionsFromUser(permissions: Array, requestCode: number, resultCallback: AsyncCallback): void; @@ -76,7 +76,7 @@ export interface Context extends BaseContext { /** * Obtains information about the current application. * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getApplicationInfo(callback: AsyncCallback): void @@ -85,7 +85,7 @@ export interface Context extends BaseContext { /** * Obtains the bundle name of the current ability. * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getBundleName(callback: AsyncCallback): void @@ -94,7 +94,7 @@ export interface Context extends BaseContext { /** * Obtains information about the current process, including the process ID and name. * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getProcessInfo(callback: AsyncCallback): void @@ -103,7 +103,7 @@ export interface Context extends BaseContext { /** * Obtains the ohos.bundle.ElementName object of the current ability. This method is available only to Page abilities. * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getElementName(callback: AsyncCallback): void @@ -112,7 +112,7 @@ export interface Context extends BaseContext { /** * Obtains the name of the current process. * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getProcessName(callback: AsyncCallback): void @@ -121,7 +121,7 @@ export interface Context extends BaseContext { /** * Obtains the bundle name of the ability that called the current ability. * @since 7 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ getCallingBundle(callback: AsyncCallback): void @@ -131,7 +131,7 @@ export interface Context extends BaseContext { /** * @name the result of requestPermissionsFromUser with asynchronous callback * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @FAModelOnly */ @@ -139,7 +139,7 @@ interface PermissionRequestResult { /** * @default The request code passed in by the user * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ requestCode: number; @@ -147,7 +147,7 @@ interface PermissionRequestResult { /** * @default The permissions passed in by the user * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ permissions: Array; @@ -155,7 +155,7 @@ interface PermissionRequestResult { /** * @default The results for the corresponding request permissions * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ authResults: Array; @@ -164,7 +164,7 @@ interface PermissionRequestResult { /** * @name PermissionOptions * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @FAModelOnly */ @@ -172,7 +172,7 @@ interface PermissionOptions { /** * @default The process id * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ pid?: number; @@ -180,7 +180,7 @@ interface PermissionOptions { /** * @default The user id * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @FAModelOnly */ uid?: number; diff --git a/api/app/processInfo.d.ts b/api/app/processInfo.d.ts index cd25a592d8..1074141503 100644 --- a/api/app/processInfo.d.ts +++ b/api/app/processInfo.d.ts @@ -16,7 +16,7 @@ /** * @name This class saves process information about an application * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @import import ProcessInfo from 'app/processInfo' * @permission N/A */ @@ -26,7 +26,7 @@ export interface ProcessInfo { * * @default - * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ pid: number; @@ -35,7 +35,7 @@ export interface ProcessInfo { * * @default - * @since 7 - * @SysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ processName: string; } \ No newline at end of file diff --git a/api/application/AbilityRunningInfo.d.ts b/api/application/AbilityRunningInfo.d.ts index 41bff388ce..243f1b4827 100644 --- a/api/application/AbilityRunningInfo.d.ts +++ b/api/application/AbilityRunningInfo.d.ts @@ -20,49 +20,49 @@ import abilityManager from '../@ohos.application.abilityManager'; * The class of an ability running information. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export interface AbilityRunningInfo { /** * @default ability element name * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ ability: ElementName; /** * @default process id * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ pid: number; /** * @default user id * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ uid: number; - + /** * @default the name of the process * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ processName: string; /** * @default ability start time * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ startTime: number; /** * @default Enumerates state of the ability state info * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ abilityState: abilityManager.AbilityState; } \ No newline at end of file diff --git a/api/application/AbilityStateData.d.ts b/api/application/AbilityStateData.d.ts index 653d556b05..0f32059761 100644 --- a/api/application/AbilityStateData.d.ts +++ b/api/application/AbilityStateData.d.ts @@ -17,7 +17,7 @@ * The ability or extension state data. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @permission N/A */ @@ -26,7 +26,7 @@ export default class AbilityStateData { * The bundle name. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ bundleName: string; @@ -35,7 +35,7 @@ export default class AbilityStateData { * The ability name. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ abilityName: string; @@ -44,7 +44,7 @@ export default class AbilityStateData { * The pid. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ pid: number; @@ -53,7 +53,7 @@ export default class AbilityStateData { * The uid. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ uid: number; @@ -62,7 +62,7 @@ export default class AbilityStateData { * The application state. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ state: number; @@ -70,9 +70,8 @@ export default class AbilityStateData { /** * The ability type, page or service and so on. * - * @devices phone, tablet, tv, wearable, car * @since 8 - * @sysCap appexecfwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ abilityType: number; diff --git a/api/application/AppStateData.d.ts b/api/application/AppStateData.d.ts index 62ae586ba6..753f38cc35 100644 --- a/api/application/AppStateData.d.ts +++ b/api/application/AppStateData.d.ts @@ -17,7 +17,7 @@ * The application state data. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @permission N/A */ @@ -26,7 +26,7 @@ export default class AppStateData { * The bundle name. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ bundleName: string; @@ -35,7 +35,7 @@ export default class AppStateData { * The uid. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ uid: number; @@ -44,7 +44,7 @@ export default class AppStateData { * The application state. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. */ state: number; diff --git a/api/application/ApplicationStateObserver.d.ts b/api/application/ApplicationStateObserver.d.ts index 5ce1e00ba5..96341bd8a3 100644 --- a/api/application/ApplicationStateObserver.d.ts +++ b/api/application/ApplicationStateObserver.d.ts @@ -21,7 +21,7 @@ import ProcessData from "./ProcessData"; * The application state observer. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @permission N/A */ @@ -30,7 +30,7 @@ export default class ApplicationStateObserver { * Will be called when foreground or background application changed. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param appStateData State changed Application info. * @systemapi hide for inner use. * @return - @@ -41,7 +41,7 @@ export default class ApplicationStateObserver { * Will be called when ability state changed. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param abilityStateData State changed ability info. * @systemapi hide for inner use. * @return - @@ -52,7 +52,7 @@ export default class ApplicationStateObserver { * Will be called when process created. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param processData Process info. * @systemapi hide for inner use. * @return - @@ -63,7 +63,7 @@ export default class ApplicationStateObserver { * Will be called when process died. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param processData Process info. * @systemapi hide for inner use. * @return - diff --git a/api/application/BaseContext.d.ts b/api/application/BaseContext.d.ts index 7b63cc832d..50ab781d4c 100644 --- a/api/application/BaseContext.d.ts +++ b/api/application/BaseContext.d.ts @@ -18,7 +18,7 @@ * 'application.Context' for Stage Mode. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export default interface BaseContext { @@ -26,7 +26,7 @@ export default interface BaseContext { * Indicates the context is FA Mode or Stage Mode. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ stageMode: boolean; } \ No newline at end of file diff --git a/api/application/Context.d.ts b/api/application/Context.d.ts index e8678b4327..73e7f73e2f 100755 --- a/api/application/Context.d.ts +++ b/api/application/Context.d.ts @@ -23,7 +23,7 @@ import EventHub from "./EventHub"; * application-specific resources. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -32,7 +32,7 @@ export default class Context extends BaseContext { * Indicates the capability of accessing application resources. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ resourceManager: resmgr.ResourceManager; @@ -41,7 +41,7 @@ export default class Context extends BaseContext { * Indicates configuration information about an application. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ applicationInfo: ApplicationInfo; @@ -50,7 +50,7 @@ export default class Context extends BaseContext { * Indicates app cache dir. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ cacheDir: string; @@ -59,7 +59,7 @@ export default class Context extends BaseContext { * Indicates app temp dir. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ tempDir: string; @@ -68,7 +68,7 @@ export default class Context extends BaseContext { * Indicates app files dir. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ filesDir : string; @@ -77,7 +77,7 @@ export default class Context extends BaseContext { * Indicates app database dir. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ databaseDir : string; @@ -86,7 +86,7 @@ export default class Context extends BaseContext { * Indicates app storage dir. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ storageDir : string; @@ -95,7 +95,7 @@ export default class Context extends BaseContext { * Indicates app bundle code dir. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ bundleCodeDir : string; @@ -104,7 +104,7 @@ export default class Context extends BaseContext { * Indicates app distributed files dir. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ distributedFilesDir: string; @@ -113,7 +113,7 @@ export default class Context extends BaseContext { * Indicates event hub. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ eventHub: EventHub; @@ -122,7 +122,7 @@ export default class Context extends BaseContext { * Create a bundle context * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @param bundleName Indicates the bundle name. * @return application context @@ -134,7 +134,7 @@ export default class Context extends BaseContext { * Get application context * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @return application context * @StageModelOnly */ @@ -144,7 +144,7 @@ export default class Context extends BaseContext { * Switch file area * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param mode file area. * @StageModelOnly */ diff --git a/api/application/EventHub.d.ts b/api/application/EventHub.d.ts index 8c198ce678..cbc9cbdc8b 100644 --- a/api/application/EventHub.d.ts +++ b/api/application/EventHub.d.ts @@ -17,8 +17,7 @@ * The event center of a context, support the subscription and publication of events. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -26,9 +25,8 @@ export default class EventHub { /** * Subscribe to an event. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param event Indicates the event. * @param callback Indicates the callback. * @return - @@ -39,9 +37,8 @@ export default class EventHub { /** * Unsubscribe from an event. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param event Indicates the event. * @param callback Indicates the callback. * @return - @@ -52,9 +49,8 @@ export default class EventHub { /** * Trigger the event callbacks. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param event Indicates the event. * @param args Indicates the callback arguments. * @return - diff --git a/api/application/ExtAbilityContext.d.ts b/api/application/ExtAbilityContext.d.ts index c8cccfb6b2..36ddd06d4d 100644 --- a/api/application/ExtAbilityContext.d.ts +++ b/api/application/ExtAbilityContext.d.ts @@ -20,8 +20,7 @@ import Context from "./Context"; * The context of an extension. It allows access to extension-specific resources. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -31,7 +30,7 @@ export default class ExtAbilityContext extends Context { * Indicates configuration information about an module. * * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly */ currentHapModuleInfo: HapModuleInfo; diff --git a/api/application/ExtensionRunningInfo.d.ts b/api/application/ExtensionRunningInfo.d.ts index 17cd0bd6e7..21b196d364 100644 --- a/api/application/ExtensionRunningInfo.d.ts +++ b/api/application/ExtensionRunningInfo.d.ts @@ -20,56 +20,56 @@ import bundle from '../@ohos.bundle'; * The class of an extension running information. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A */ export interface ExtensionRunningInfo { /** * @default Indicates the extension of the extension info * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ extension: ElementName; /** * @default process id * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ pid: number; /** * @default user id * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ uid: number; /** * @default the name of the process * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ processName: string; /** * @default ability start time * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ startTime: number; /** * @default All package names under the current process * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ clientPackage: Array; /** * @default Enumerates types of the entension info * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core */ type: bundle.ExtensionAbilityType; } \ No newline at end of file diff --git a/api/application/FormExtensionContext.d.ts b/api/application/FormExtensionContext.d.ts index dd2d16bc81..c3bd85bdb2 100644 --- a/api/application/FormExtensionContext.d.ts +++ b/api/application/FormExtensionContext.d.ts @@ -22,7 +22,7 @@ import formBindingData from '../@ohos.application.formBindingData'; * formExtension-specific resources. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission N/A * @StageModelOnly */ @@ -34,7 +34,7 @@ export default class FormExtensionContext extends ExtensionContext { *

You can use this method to update the given form

* * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Core + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @permission ohos.permission.REQUIRE_FORM. * @param formId Indicates the given form. * @param formBindingData Indicates the form data. diff --git a/api/application/MissionInfo.d.ts b/api/application/MissionInfo.d.ts index 0b2a3e92a1..5233bce35e 100644 --- a/api/application/MissionInfo.d.ts +++ b/api/application/MissionInfo.d.ts @@ -19,8 +19,7 @@ import Want from "../@ohos.application.Want"; * Mission information corresponding to ability. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A * @systemapi hide for inner use. */ @@ -29,7 +28,7 @@ export interface MissionInfo { * Indicates mission id. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ missionId: number; @@ -37,7 +36,7 @@ export interface MissionInfo { * Indicates running state. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ runningState: number; @@ -45,7 +44,7 @@ export interface MissionInfo { * Indicates locked state. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ lockedState: boolean; @@ -53,7 +52,7 @@ export interface MissionInfo { * Indicates the recent create or update time of the mission. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ timestamp: string; @@ -61,7 +60,7 @@ export interface MissionInfo { * Indicates want of the mission. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ want: Want; @@ -69,7 +68,7 @@ export interface MissionInfo { * Indicates label of the mission. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ label: string; @@ -77,7 +76,7 @@ export interface MissionInfo { * Indicates icon path of the mission. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ iconPath: string; @@ -85,7 +84,7 @@ export interface MissionInfo { * Indicates whether the mision is continuable. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ continuable: boolean; } \ No newline at end of file diff --git a/api/application/MissionListener.d.ts b/api/application/MissionListener.d.ts index d9f36505f5..12bd9e64bd 100644 --- a/api/application/MissionListener.d.ts +++ b/api/application/MissionListener.d.ts @@ -18,7 +18,7 @@ * * @name MissionListener * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A * @systemapi hide for inner use. */ @@ -27,7 +27,7 @@ * Called by system when mission created. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ onMissionCreated(mission: number): void; @@ -36,7 +36,7 @@ * Called by system when mission destroyed. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ onMissionDestroyed(mission: number): void; @@ -45,7 +45,7 @@ * Called by system when mission shapshot changed. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ onMissionSnapshotChanged(mission: number): void; @@ -54,7 +54,7 @@ * Called by system when mission moved to fornt. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @return - */ onMissionMovedToFront(mission: number): void; diff --git a/api/application/MissionSnapshot.d.ts b/api/application/MissionSnapshot.d.ts index d7b85a300f..3fa0dd0587 100644 --- a/api/application/MissionSnapshot.d.ts +++ b/api/application/MissionSnapshot.d.ts @@ -20,7 +20,7 @@ import { image } from '../@ohos.multimedia.image'; * Mission snapshot corresponding to mission. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A * @systemapi hide for inner use. */ @@ -29,7 +29,7 @@ export interface MissionSnapshot { * Indicates the ability elementName of the mission. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ ability: ElementName; @@ -37,7 +37,7 @@ export interface MissionSnapshot { * Indicates mission snapshot. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ snapshot: image.PixelMap; } \ No newline at end of file diff --git a/api/application/PermissionRequestResult.d.ts b/api/application/PermissionRequestResult.d.ts index 6c44ea461f..bd84e1f626 100755 --- a/api/application/PermissionRequestResult.d.ts +++ b/api/application/PermissionRequestResult.d.ts @@ -17,7 +17,7 @@ * The result of requestPermissionsFromUser with asynchronous callback. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A * @StageModelOnly */ @@ -26,7 +26,7 @@ export default class PermissionRequestResult { * The permissions passed in by the user. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @StageModelOnly */ permissions: Array; @@ -36,7 +36,7 @@ export default class PermissionRequestResult { * permission is granted, and the value -1 indicates not. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @StageModelOnly */ authResults: Array; diff --git a/api/application/ProcessData.d.ts b/api/application/ProcessData.d.ts index 3bd2427106..8be5e311ef 100644 --- a/api/application/ProcessData.d.ts +++ b/api/application/ProcessData.d.ts @@ -17,7 +17,7 @@ * The process data. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. * @permission N/A */ @@ -26,7 +26,7 @@ export default class ProcessData { * The bundle name. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. */ bundleName: string; @@ -35,7 +35,7 @@ export default class ProcessData { * The pid. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. */ pid: number; @@ -44,7 +44,7 @@ export default class ProcessData { * The uid. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. */ uid: number; diff --git a/api/application/ProcessRunningInfo.d.ts b/api/application/ProcessRunningInfo.d.ts index 9349cb9135..ba19a3b55b 100644 --- a/api/application/ProcessRunningInfo.d.ts +++ b/api/application/ProcessRunningInfo.d.ts @@ -17,35 +17,35 @@ * The class of an process running information. * * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @permission N/A */ export interface ProcessRunningInfo { /** * @default process id * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ pid: number; /** * @default user id * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ uid: number; - + /** * @default the name of the process * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ processName: string; - + /** * @default an array of the bundleNames running in the process * @since 8 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ bundleNames: Array; } \ No newline at end of file diff --git a/api/application/ServiceExtAbilityContext.d.ts b/api/application/ServiceExtAbilityContext.d.ts index 6ffe342387..f10e58fc9a 100644 --- a/api/application/ServiceExtAbilityContext.d.ts +++ b/api/application/ServiceExtAbilityContext.d.ts @@ -24,8 +24,7 @@ import StartOptions from "../@ohos.application.StartOptions"; * serviceExtension-specific resources. * * @since 9 - * @sysCap AAFwk - * @devices phone, tablet, tv, wearable, car + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @permission N/A * @StageModelOnly @@ -34,9 +33,8 @@ export default class ServiceExtAbilityContext extends ExtAbilityContext { /** * Service extension uses this method to start a specific ability. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param parameter Indicates the ability to start. * @systemapi hide for inner use. * @return - @@ -49,9 +47,8 @@ export default class ServiceExtAbilityContext extends ExtAbilityContext { /** * Service extension uses this method to start a specific ability with account. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param parameter Indicates the ability to start. * @param parameter Indicates the accountId to start. * @systemapi hide for inner use. @@ -65,9 +62,8 @@ export default class ServiceExtAbilityContext extends ExtAbilityContext { /** * Destroys this service extension. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide for inner use. * @return - * @StageModelOnly @@ -82,9 +78,8 @@ export default class ServiceExtAbilityContext extends ExtAbilityContext { * service extension. You must implement the {@link ConnectOptions} interface to obtain the proxy of the target * service extension when the Service extension is connected.

* - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param request Indicates the service extension to connect. * @systemapi hide for inner use. * @return connection id, int value. @@ -99,9 +94,8 @@ export default class ServiceExtAbilityContext extends ExtAbilityContext { * service extension. You must implement the {@link ConnectOptions} interface to obtain the proxy of the target * service extension when the Service extension is connected.

* - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param request Indicates the service extension to connect. * @param request Indicates the account to connect. * @systemapi hide for inner use. @@ -114,9 +108,8 @@ export default class ServiceExtAbilityContext extends ExtAbilityContext { * Disconnects an ability to a service extension, in contrast to * {@link connectAbility}. * - * @devices phone, tablet, tv, wearable, car * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Core * @param connection the connection id returned from connectAbility api. * @systemapi hide for inner use. * @return - diff --git a/api/application/ServiceExtensionContext.d.ts b/api/application/ServiceExtensionContext.d.ts index ce5e61f065..d07171a1fd 100644 --- a/api/application/ServiceExtensionContext.d.ts +++ b/api/application/ServiceExtensionContext.d.ts @@ -25,7 +25,7 @@ import { ExtensionAbilityInfo } from "../bundle/extensionAbilityInfo"; * serviceExtension-specific resources. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. * @permission N/A * @StageModelOnly @@ -35,7 +35,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * Service extension information. * * @since 9 - * @sysCap AAFwk + * @syscap SystemCapability.Ability.AbilityRuntime.Mission */ extensionAbilityInfo: ExtensionAbilityInfo; @@ -43,7 +43,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * Service extension uses this method to start a specific ability. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param parameter Indicates the ability to start. * @systemapi hide for inner use. * @return - @@ -57,7 +57,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * Service extension uses this method to start a specific ability with account. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param parameter Indicates the ability to start. * @param parameter Indicates the accountId to start. * @systemapi hide for inner use. @@ -72,7 +72,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * Destroys this service extension. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @systemapi hide for inner use. * @return - * @StageModelOnly @@ -88,7 +88,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * service extension when the Service extension is connected.

* * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param request Indicates the service extension to connect. * @systemapi hide for inner use. * @return connection id, int value. @@ -104,7 +104,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * service extension when the Service extension is connected.

* * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param request Indicates the service extension to connect. * @param request Indicates the account to connect. * @systemapi hide for inner use. @@ -118,7 +118,7 @@ export default class ServiceExtensionContext extends ExtensionContext { * {@link connectAbility}. * * @since 9 - * @sysCap SystemCapability.Ability.AbilityRuntime.Mission + * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param connection the connection id returned from connectAbility api. * @systemapi hide for inner use. * @return - -- Gitee From a3ec17f945feb70c95cea805da23e1800899f0cf Mon Sep 17 00:00:00 2001 From: clevercong Date: Tue, 1 Mar 2022 20:20:03 +0800 Subject: [PATCH 11/18] add since Signed-off-by: clevercong --- api/@ohos.telephony.call.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/api/@ohos.telephony.call.d.ts b/api/@ohos.telephony.call.d.ts index d1e4486775..96816be1f7 100644 --- a/api/@ohos.telephony.call.d.ts +++ b/api/@ohos.telephony.call.d.ts @@ -43,6 +43,7 @@ declare namespace call { * * @param phoneNumber Indicates the called number. * @syscap SystemCapability.Applications.Contacts + * @since 7 */ function makeCall(phoneNumber: string, callback: AsyncCallback): void; function makeCall(phoneNumber: string): Promise; -- Gitee From 5dfb2760f3b02d6ea12218956db5f2fec2d22465 Mon Sep 17 00:00:00 2001 From: "https://gitee.com/WALL_EYE" Date: Tue, 1 Mar 2022 21:36:34 +0800 Subject: [PATCH 12/18] API8 need AuthType Signed-off-by: https://gitee.com/WALL_EYE Change-Id: I8565a78b084a8a23efd38504e9c929ec0933d7e4 --- api/@ohos.userIAM.userAuth.d.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/api/@ohos.userIAM.userAuth.d.ts b/api/@ohos.userIAM.userAuth.d.ts index faf424d0e5..8a6e196087 100644 --- a/api/@ohos.userIAM.userAuth.d.ts +++ b/api/@ohos.userIAM.userAuth.d.ts @@ -92,7 +92,6 @@ declare namespace userAuth { /** * Auth types - * @deprecated since 8 */ type AuthType = "ALL" | "FACE_ONLY"; -- Gitee From 80c20685e5a4c70696c78de6ec465c4c307bb334 Mon Sep 17 00:00:00 2001 From: l00438547 Date: Tue, 1 Mar 2022 22:22:03 +0800 Subject: [PATCH 13/18] add js api for nfc tag and hce Signed-off-by: l00438547 --- api/@ohos.nfc.cardEmulation.js | 105 +++++++++++++++++++++++++ api/@ohos.nfc.controller.js | 116 +++++++++++++++++++++++++++ api/@ohos.nfc.tag.js | 118 ++++++++++++++++++++++++++++ api/tag/nfctech.js | 139 +++++++++++++++++++++++++++++++++ api/tag/tagSession.js | 132 +++++++++++++++++++++++++++++++ 5 files changed, 610 insertions(+) create mode 100755 api/@ohos.nfc.cardEmulation.js create mode 100755 api/@ohos.nfc.controller.js create mode 100755 api/@ohos.nfc.tag.js create mode 100755 api/tag/nfctech.js create mode 100755 api/tag/tagSession.js diff --git a/api/@ohos.nfc.cardEmulation.js b/api/@ohos.nfc.cardEmulation.js new file mode 100755 index 0000000000..505b362654 --- /dev/null +++ b/api/@ohos.nfc.cardEmulation.js @@ -0,0 +1,105 @@ +/* + * Copyright (c) 2021-2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Provides methods to operate or manage NFC card emulation. + * + * @import import cardEmulation from '@ohos.nfc.cardEmulation'; + * + * @since 6 + * @syscap SystemCapability.Communication.NFC.Core + */ +declare namespace cardEmulation { + enum Featuretype { + /** This constant is used to check whether HCE card emulation is supported. */ + HCE = 0, + + /** This constant is used to check whether SIM card emulation is supported. */ + UICC = 1, + + /** This constant is used to check whether eSE card emulation is supported. */ + ESE = 2, + } + + /** + * Checks whether a specified type of card emulation is supported. + * + *

This method is used to check Whether the host or secure element supports card emulation. + * + * @param feature Indicates the card emulation type, {@code HCE}, {@code UICC}, or {@code ESE}. + * @return Returns {@code true} if the specified type of card emulation is supported; returns + * {@code false} otherwise. + * + * @since 6 + */ + function isSupported(feature: number):boolean; + + /** + * A class for NFC host application. + * + *

The NFC host application use this class, then Nfc service can access the application + * installation information and connect to services of the application. + * + * @since 8 + * @syscap SystemCapability.Communication.NFC.Core + */ + export class HceService { + /** + * start HCE + * + * @return Returns {@code true} if HCE is enabled or has been enabled; returns {@code false} otherwise. + * @permission ohos.permission.NFC_CARD_EMULATION + * + * @since 8 + */ + startHCE(aidList: string[]): boolean; + + /** + * stop HCE + * + * @return Returns {@code true} if HCE is disabled or has been disabled; returns {@code false} otherwise. + * @permission ohos.permission.NFC_CARD_EMULATION + * + * @since 8 + */ + stopHCE(): boolean; + + + /** + * register HCE event to receive the APDU data. + * + * @param type the type to register. + * @param callback Callback used to listen for HCE data device received. + * @permission ohos.permission.NFC_CARD_EMULATION + * + * @since 8 + */ + + on(type: "hceCmd", callback: AsyncCallback): void; + + /** + * Sends a response APDU to the remote device. + * + *

This method is used by a host application when swiping card. + * + * @param responseApdu Indicates the response, which is a byte array. + * @permission ohos.permission.NFC_CARD_EMULATION + * + * @since 8 + */ + sendResponse(responseApdu: number[]): void; + } +} +export default cardEmulation; diff --git a/api/@ohos.nfc.controller.js b/api/@ohos.nfc.controller.js new file mode 100755 index 0000000000..35c767cb74 --- /dev/null +++ b/api/@ohos.nfc.controller.js @@ -0,0 +1,116 @@ +/* + * Copyright (c) 2021-2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { Callback } from './basic'; + +/** + * Provides methods to operate or manage NFC. + * + * @import import controller from '@ohos.nfc.controller'; + * + * @since 7 + * @syscap SystemCapability.Communication.NFC.Core + */ +declare namespace nfcController { + enum NfcState { + /** Indicates that NFC is disabled. */ + STATE_OFF = 1, + + /** Indicates that NFC is being enabled. */ + STATE_TURNING_ON = 2, + + /** Indicates that NFC is enabled. */ + STATE_ON = 3, + + /** Indicates that NFC is being disabled. */ + STATE_TURNING_OFF = 4, + } + + /** + * Checks whether a device supports NFC. + * + * @return Returns {@code true} if the device supports NFC; returns {@code false} otherwise. + * + * @since 7 + */ + function isNfcAvailable(): boolean + + /** + * register nfc state changed event. + * + * @param type the type to register. + * @param callback Callback used to listen for the nfc state changed event. + * + * @since 7 + */ + + function on(type: "nfcStateChange", callback: Callback): void + + /** + * unregister nfc state changed event. + * + * @param type the type to unregister. + * @param callback Callback used to listen for the nfc state changed event. + * + * @since 7 + */ + + function off(type: "nfcStateChange", callback?: Callback): void + + /** + * Enables NFC. + * + * @return Returns {@code true} if NFC is enabled or has been enabled; returns {@code false} otherwise. + * @permission ohos.permission.MANAGE_SECURE_SETTINGS + * + * @since 7 + */ + function openNfc(): boolean + + /** + * Disables NFC. + * + * @return Returns {@code true} if NFC is disabled or has been disabled; returns {@code false} otherwise. + * @permission ohos.permission.MANAGE_SECURE_SETTINGS + * + * @since 7 + */ + function closeNfc(): boolean + + /** + * Checks whether NFC is enabled. + * + * @return Returns {@code true} if NFC is enabled; returns {@code false} otherwise. + * + * @since 7 + */ + function isNfcOpen(): boolean + + /** + * Obtains the NFC status. + * + *

The NFC status can be any of the following:

  • {@link #STATE_OFF}: Indicates that NFC + * is disabled.
  • {@link #STATE_TURNING_ON}: Indicates that NFC is being enabled. + *
  • {@link #STATE_ON}: Indicates that NFC is enabled.
  • {@link #STATE_TURNING_OFF}: Indicates + * that NFC is being disabled.
+ * + * @return Returns the NFC status. + * + * @since 7 + */ + function getNfcState(): boolean +} + +export default nfcController; \ No newline at end of file diff --git a/api/@ohos.nfc.tag.js b/api/@ohos.nfc.tag.js new file mode 100755 index 0000000000..78ec3e6702 --- /dev/null +++ b/api/@ohos.nfc.tag.js @@ -0,0 +1,118 @@ +/* + * Copyright (c) 2021-2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { NfcATag, NfcBTag, NfcFTag, NfcVTag } from './tag/nfctech'; + +/** + * Provides methods to operate or manage NFC tag. + * + * @import import tag from '@ohos.nfc.tag'; + * + * @since 7 + * @sysCap SystemCapability.Communication.NFC.Core + */ +declare namespace tag { + /** Indicates an NFC-A tag. */ + const NFC_A = 1; + + /** Indicates an NFC-B tag. */ + const NFC_B = 2; + + /** Indicates an ISO-DEP tag. */ + const ISO_DEP = 3; + + /** Indicates an NFC-F tag. */ + const NFC_F = 4; + + /** Indicates an NFC-V tag. */ + const NFC_V = 5; + + /** Indicated an NDEF tag. */ + const NDEF = 6; + + /** Indicates a MifareClassic tag. */ + const MIFARE_CLASSIC = 8; + + /** Indicates a MifareUltralight tag. */ + const MIFARE_ULTRALIGHT = 9; + + /** + * Obtains an {@code NfcATag} object based on the tag information. + * + *

During tag reading, if the tag supports the NFC-A technology, an {@code NfcATag} object + * will be created based on the tag information. + * + * @param tagInfo Indicates the tag information. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + function getNfcATag(tagInfo: TagInfo): NfcATag + + /** + * Obtains an {@code NfcBTag} object based on the tag information. + * + *

During tag reading, if the tag supports the NFC-B technology, an {@code NfcBTag} object + * will be created based on the tag information. + * + * @param tagInfo Indicates the tag information. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + function getNfcBTag(tagInfo: TagInfo): NfcBTag + + /** + * Obtains an {@code NfcFTag} object based on the tag information. + * + *

During tag reading, if the tag supports the NFC-F technology, an {@code NfcFTag} object + * will be created based on the tag information. + * + * @param tagInfo Indicates the tag information. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + function getNfcFTag(tagInfo: TagInfo): NfcFTag + + /** + * Obtains an {@code NfcVTag} object based on the tag information. + * + *

During tag reading, if the tag supports the NFC-V technology, an {@code NfcVTag} object + * will be created based on the tag information. + * + * @param tagInfo Indicates the tag information. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + function getNfcVTag(tagInfo: TagInfo): NfcVTag + + + /** + * Provides tag information. + * + *

This class provides the technology a tag supports, for example, NFC-A. Applications can create + * different tags based on the supported technology. + * + * @since 7 + * @syscap SystemCapability.Communication.NFC.Core + * @permission ohos.permission.NFC_TAG + */ + export interface TagInfo { + supportedProfiles: number[]; + } +} +export default tag; \ No newline at end of file diff --git a/api/tag/nfctech.js b/api/tag/nfctech.js new file mode 100755 index 0000000000..fbcc5f2897 --- /dev/null +++ b/api/tag/nfctech.js @@ -0,0 +1,139 @@ +/* + * Copyright (c) 2021-2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +import { TagSession } form './tagSession'; + +/** + * Provides interfaces to control the read and write of tags that support the NFC-A technology. + * + *

This class is inherited from the {@link TagSession} abstract class, and provides methods to create + * {@code NfcATag} objects and obtain the ATQA and SAK. + * + * @since 7 + * @syscap SystemCapability.Communication.NFC.Core + */ +export interface NfcATag extends TagSession{ + /** + * Obtains the SAK of an NFC-A tag. + * + * @return Returns the SAK of the NFC-A tag. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + getSak():number; + + /** + * Obtains the ATQA of an NFC-A tag. + * + * @return Returns the ATQA of the NFC-A tag. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + getAtqa():number[]; +} + +/** + * Provides interfaces to create an {@code NfcBTag} and perform I/O operations on the tag. + * + *

This class inherits from the {@link TagSession} abstract class and provides interfaces to create an + * {@code NfcBTag} and obtain the tag information. + * + * @since 7 + * @syscap SystemCapability.Communication.NFC.Core + */ +export interface NfcBTag extends TagSession{ + /** + * Obtains the application data of a tag. + * + * @return Returns the application data of the tag. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + getRespAppData():number[]; + + /** + * Obtains the protocol information of a tag. + * + * @return Returns the protocol information of the tag. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + getRespProtocol():number[]; +} + +/** + * Provides methods for creating an NFC-F tag, obtaining tag information, and controlling tag read and write. + * + *

This class inherits from the {@link TagSession} abstract class and provides interfaces to create an + * {@code NfcFTag} and obtain the tag information. + * + * @since 7 + * @syscap SystemCapability.Communication.NFC.Core + */ +export interface NfcFTag extends TagSession{ + /** + * Obtains the system code from this {@code NfcFTag} instance. + * + * @return Returns the system code. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + getSystemCode():number[]; + + /** + * Obtains the PMm (consisting of the IC code and manufacturer parameters) from this {@code NfcFTag} instance. + * + * @return Returns the PMm. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + getPmm():number[]; +} + +/** + * Provides methods for creating an NFC-V tag, obtaining tag information, and controlling tag read and write. + * + *

This class inherits from the {@link TagSession} abstract class and provides interfaces to create an + * {@code NfcVTag} and obtain the tag information. + * + * @since 7 + * @syscap SystemCapability.Communication.NFC.Core + */ +export interface NfcVTag extends TagSession{ + /** + * Obtains the response flags from this {@code NfcVTag} instance. + * + * @return Returns the response flags. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + getResponseFlags():number; + + /** + * Obtains the data storage format identifier (DSFID) from this {@code NfcVTag} instance. + * + * @return Returns the DSFID. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + getDsfId():number; +} diff --git a/api/tag/tagSession.js b/api/tag/tagSession.js new file mode 100755 index 0000000000..c50deecbf2 --- /dev/null +++ b/api/tag/tagSession.js @@ -0,0 +1,132 @@ +/* + * Copyright (c) 2021-2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +import tag from '../ohos.nfc.tag'; +import { AsyncCallback } form './basic'; + +/** + * Controls tag read and write. + * + *

Classes for different types of tags inherit from this abstract class to control connections to + * tags, read data from tags, and write data to tags. + * + * @since 7 + * @syscap SystemCapability.Communication.NFC.Core + */ +export interface TagSession { + /** + * Obtains the tag information. + * + * @return Returns the tag information, which is a {@link TagInfo} object. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + getTagInfo(): tag.TagInfo; + + /** + * Connects to a tag. + * + *

This method must be called before data is read from or written to the tag. + * + * @return Returns {@code true} if the connection is set up; returns {@code false} otherwise. + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + connectTag(): boolean; + + /** + * Resets a connection with a tag and restores the default timeout duration for writing data to the tag. + * + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + reset(): void; + + /** + * Checks whether a connection has been set up with a tag. + * + * @return Returns {@code true} if a connection has been set up with the tag; + * returns {@code false} otherwise. + * + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + isTagConnected(); boolean; + + /** + * Sets the timeout duration (ms) for sending data to a tag. + * + *

If data is not sent to the tag within the duration, data sending fails. + * + * @param timeout Indicates the timeout duration to be set. + * @return Returns {@code true} if the setting is successful; returns {@code false} otherwise. + * + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + setSendDataTimeout(timeout: number): boolean; + + /** + * Queries the timeout duration (ms) for sending data to a tag. + * + * @return Returns the timeout duration. + * + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + getSendDataTimeout(): number; + + /** + * Writes data to a tag. + * + * @param data Indicates the data to be written to the tag. + * @return Returns bytes received in response. Or bytes with a length of 0 if the + * data fails to be written to the tag. + * + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + sendData(data: number[]): Promise; + + /** + * Writes data to a tag. + * + * @param data Indicates the data to be written to the tag. + * @return Returns bytes received in response. Or bytes with a length of 0 if the + * data fails to be written to the tag. + * + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + sendData(data: number[], callback: AsyncCallback): void; + + /** + * Queries the maximum length of data that can be sent to a tag. + * + * @return Returns the maximum length of the data to be sent to the tag. + * + * @permission ohos.permission.NFC_TAG + * + * @since 7 + */ + getMaxSendLength(): number; +} \ No newline at end of file -- Gitee From 7f17adcece7a35ebea1551d0b0be3511c3a4cee5 Mon Sep 17 00:00:00 2001 From: sunyaozu Date: Wed, 2 Mar 2022 10:19:16 +0800 Subject: [PATCH 14/18] fix sysCap error Signed-off-by: sunyaozu --- api/@ohos.i18n.d.ts | 132 ++++++++++++++++++++++---------------------- api/@ohos.intl.d.ts | 86 ++++++++++++++--------------- 2 files changed, 109 insertions(+), 109 deletions(-) diff --git a/api/@ohos.i18n.d.ts b/api/@ohos.i18n.d.ts index cec6042811..b8dc57ffdc 100644 --- a/api/@ohos.i18n.d.ts +++ b/api/@ohos.i18n.d.ts @@ -16,14 +16,14 @@ /** * Provides international settings related APIs. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 7 */ declare namespace i18n { /** * Obtains the country or region name localized for display on a given locale. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param country The locale whose country or region name will be displayed. * @param locale The locale used to display the country or region. * @param sentenceCase Specifies whether the country or region name is displayed in sentence case. @@ -35,7 +35,7 @@ export function getDisplayCountry(country: string, locale: string, sentenceCase? /** * Obtains the language name localized for display on a given locale. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param language The locale whose language name will be displayed. * @param locale The locale used to display the language. * @param sentenceCase Specifies whether the language name is displayed in sentence case. @@ -47,7 +47,7 @@ export function getDisplayLanguage(language: string, locale: string, sentenceCas /** * Obtain all languages supported by the system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns all languages supported by the system. * @since 7 * @systemapi Hide this for inner system use. @@ -57,7 +57,7 @@ export function getSystemLanguages(): Array; /** * Obtain all regions supported by the system in the language. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param language The language used to get the list of regions. * @return Returns all regions supported by the system in the language. * @since 7 @@ -68,7 +68,7 @@ export function getSystemCountries(language: string): Array; /** * Determine whether the current language or region is recommended. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param language The language code. * @param region The region code. * @return Returns whether the current language or region is recommended. @@ -80,7 +80,7 @@ export function isSuggested(language: string, region?: string): boolean; /** * Obtain the language currently used by the system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the language currently used by the system. * @since 7 */ @@ -89,7 +89,7 @@ export function getSystemLanguage(): string; /** * Set the language currently used by the system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param language The language to be used. * @since 7 * @systemapi Hide this for inner system use. @@ -99,7 +99,7 @@ export function setSystemLanguage(language: string): boolean; /** * Obtain the region currently used by the system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the region currently used by the system. * @since 7 */ @@ -108,7 +108,7 @@ export function getSystemRegion(): string; /** * Set the region currently used by the system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param region The region to be used. * @since 7 * @systemapi Hide this for inner system use. @@ -118,7 +118,7 @@ export function setSystemRegion(region: string): boolean; /** * Obtain the locale currently used by the system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the locale currently used by the system. * @since 7 */ @@ -127,7 +127,7 @@ export function getSystemLocale(): string; /** * Set the locale currently used by the system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale The locale to be used. * @since 7 * @systemapi Hide this for inner system use. @@ -137,14 +137,14 @@ export function setSystemLocale(locale: string): boolean; /** * Provides util functions. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export interface Util { /** * Convert from unit to to unit and format according to the locale. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param fromUnit Information of the unit to be converted. * @param toUnit Information about the unit to be converted to. * @param value Indicates the number to be formatted. @@ -158,7 +158,7 @@ export interface Util { /** * Provides the options of unit. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export interface UnitInfo { @@ -176,7 +176,7 @@ export interface UnitInfo { /** * Provides the options of PhoneNumberFormat. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export interface PhoneNumberFormatOptions { @@ -189,14 +189,14 @@ export interface PhoneNumberFormatOptions { /** * Provides the API for formatting phone number strings * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export class PhoneNumberFormat { /** * A constructor used to create a PhoneNumberFormat object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param country Indicates a character string containing the country information for the PhoneNumberFormat object. * @param type Indicates the type used to format the phone number, includes: "E164", "RFC3966", "INTERNATIONAL", "NATIONAL". * @since 8 @@ -206,7 +206,7 @@ export class PhoneNumberFormat { /** * Judges whether phone number is valid. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param number Indicates the input phone number to be judged. * @return Returns a boolean indicates whether the input phone number is valid. * @since 8 @@ -216,7 +216,7 @@ export class PhoneNumberFormat { /** * Obtains the formatted phone number strings of number. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param number Indicates the input phone number to be formatted. * @return Returns the formatted phone number. * @since 8 @@ -227,7 +227,7 @@ export class PhoneNumberFormat { /** * Get a Calendar instance specified by locale and type. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale The locale used to get calendar. * @param type If type is not specified, get locale's default Calendar, else get the specified type of Calendar. * such as buddhist, chinese, coptic, ethiopic, hebrew, gregory, indian, islamic_civil, islamic_tbla, islamic_umalqura, @@ -240,7 +240,7 @@ export class Calendar { /** * set the date. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param date Date object used to set the time and date. * @since 8 */ @@ -249,7 +249,7 @@ export class Calendar { /** * set the time. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param time Indicates the elapsed milliseconds from 1970.1.1 00:00:00 GMT. * @since 8 */ @@ -258,7 +258,7 @@ export class Calendar { /** * Set the time * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param year The year field of the calendar, ranges from 0 to 9999. * @param month The month field of the calendar, ranges from 0 to 11. * @param date The day field of the calendar, ranges from 1 to 31. @@ -272,7 +272,7 @@ export class Calendar { /** * Set the timezone of this calendar. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param timezone The id of a timezone. * @since 8 */ @@ -281,7 +281,7 @@ export class Calendar { /** * Get the timezone id of this calendar instance. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the timezone id of this calendar. * @since 8 */ @@ -290,7 +290,7 @@ export class Calendar { /** * Get the start day of a week. 1 indicates Sunday, 7 indicates Saturday. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns start day of a week. * @since 8 */ @@ -299,7 +299,7 @@ export class Calendar { /** * Set the start day of a week. 1 indicates Sunday, 7 indicates Saturday. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param value Indicates the start day of a week. 1 indicates Sunday, 7 indicates Saturday. * @since 8 */ @@ -308,7 +308,7 @@ export class Calendar { /** * Get the minimal days of a week, which is needed for the first day of a year. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the minimal days of a week. * @since 8 */ @@ -317,7 +317,7 @@ export class Calendar { /** * Set the minimal days of a week, which is needed for the first week of a year. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param value The value to be set. * @since 8 */ @@ -326,7 +326,7 @@ export class Calendar { /** * Get the associated value with the field. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param field Field values such as era, year, month, week_of_year, week_of_month, date, day_of_year, day_of_week * day_of_week_in_month, hour, hour_of_day, minute, second, millisecond, zone_offset, dst_offset, year_woy, * dow_local, extended_year, julian_day, milliseconds_in_day, is_leap_month. @@ -338,7 +338,7 @@ export class Calendar { /** * Get calendar's name localized for display in the given locale. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale Locale used to get the localized name for this calendar. * @return Returns the localized name of this calendar. * @since 8 @@ -349,7 +349,7 @@ export class Calendar { * Returns true if the given date is a weekend day. If the date is not given, * the date object of this calendar is used. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param date Date object whose attribute is desired. * @return Returns whether the date is a weekend day. * @since 8 @@ -360,7 +360,7 @@ export class Calendar { /** * Judge whether the locale is RTL locale. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale The locale to be used. * @return Returns true representing the locale is an RTL locale * @@ -371,7 +371,7 @@ export function isRTL(locale: string): boolean; /** * Obtains a BreakIterator object for finding the location of break point in text. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale the returned BreakIterator will adapt the rule, specified by the locale, to break text. * @return Returns a newly constructed BreakIterator object. * @since 8 @@ -381,14 +381,14 @@ export function isRTL(locale: string): boolean; /** * The BreakIterator class is used for finding the location of break point in text. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export class BreakIterator { /** * Obtains the current position of the BreakIterator instance. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the current position of the BreakIterator instance. * @since 8 */ @@ -398,7 +398,7 @@ export class BreakIterator { * Set the BreakIterator's position to the first break point, the first break point is always the beginning of the * processed text. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the index of the first break point. * @since 8 */ @@ -408,7 +408,7 @@ export class BreakIterator { * Set the BreakIterator's position to the last break point. the last break point is always the index beyond the * last character of the processed text. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the index of the last break point. * @since 8 */ @@ -417,7 +417,7 @@ export class BreakIterator { /** * Set the BreakItertor's position to the nth break point from the current break point. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param index indicates the number of break points to advance. If index is not given, n is treated as 1. * @return Returns the index of the BreakIterator after moving. If there is not enough break points, returns -1. * @since 8 @@ -427,7 +427,7 @@ export class BreakIterator { /** * Set the BreakItertor's position to the break point preceding the current break point. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the index of the BreakIterator after moving. If there is not enough break points, returns -1. * @since 8 */ @@ -436,7 +436,7 @@ export class BreakIterator { /** * Set the text to be processed. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param text Indicates the text to be processed by the BreakIterator. * @since 8 */ @@ -445,7 +445,7 @@ export class BreakIterator { /** * Set the BreakIterator's position to the first break point following the specified offset. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the index of the BreakIterator after moving. If there is not enough break points, returns -1. * @since 8 */ @@ -454,7 +454,7 @@ export class BreakIterator { /** * Obtains the text being processed. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the text that is processed by the BreakIterator. * @since 8 */ @@ -465,7 +465,7 @@ export class BreakIterator { * position will be set to the position indicated by the offset if it returns true, otherwise the BreakIterator * will be moved to the break point following the offset. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param offset The offset to be checked. * @return Returns true if the offset is a break point. * @since 8 @@ -477,14 +477,14 @@ export class BreakIterator { * Sequence text can be grouped under the specified area, * and grouping index with different lengths can be specified. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export class IndexUtil { /** * Get IndexUtil object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale Indicates a character string containing the locale information, including * the language and optionally the script and region, for the NumberFormat object. * @return Returns IndexUtil object. @@ -495,7 +495,7 @@ export class IndexUtil { /** * Get a list of labels for use as a UI index * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns a list of labels * @since 8 */ @@ -504,7 +504,7 @@ export class IndexUtil { /** * Add the index characters from a Locale to the index. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale The locale whose index characters are to be added. * @since 8 */ @@ -513,7 +513,7 @@ export class IndexUtil { /** * Get corresponding index of the input text. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param text input text * @since 8 */ @@ -523,14 +523,14 @@ export class IndexUtil { /** * Provides the API for accessing unicode character properties, sunch as whether a character is a digit. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export class Character { /** * Determines whether the specified code point is a digit character * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns true if the character is a digit character */ @@ -539,7 +539,7 @@ export class Character { /** * Determines if the specified character is a space character or not. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns true if the character is a space character */ @@ -548,7 +548,7 @@ export class Character { /** * Determines if the specified character is a whitespace character * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns true if the character is a whitespace character */ @@ -557,7 +557,7 @@ export class Character { /** * Determines if the specified character is a RTL character or not. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns true if the character is a RTL character */ @@ -566,7 +566,7 @@ export class Character { /** * Determines if the specified character is a Ideographic character or not. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns true if the character is a Ideographic character */ @@ -575,7 +575,7 @@ export class Character { /** * Determines if the specified character is a Letter or not. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns true if the character is a Letter */ @@ -584,7 +584,7 @@ export class Character { /** * Determines if the specified character is a LowerCase character or not. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns true if the character is a LowerCase character */ @@ -593,7 +593,7 @@ export class Character { /** * Determines if the specified character is a UpperCase character or not. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns true if the character is a UpperCase character */ @@ -602,7 +602,7 @@ export class Character { /** * Get the general category value of the specified character. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param char the character to be tested * @return Returns the general category of the specified character. */ @@ -612,7 +612,7 @@ export class Character { /** * check out whether system is 24-hour system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns a boolean represent whether system is 24-hour system. * @since 8 */ @@ -621,7 +621,7 @@ export class Character { /** * set 24-hour system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param option represent the boolean to be set. * @return Returns a boolean represent whether setting 24-hour system success. * @since 8 @@ -631,7 +631,7 @@ export class Character { /** * Add one language to preferred language List. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param language the language to be added. * @param index the position of preferred language list to be inserted. * @return Returns a boolean represent whether language added success. @@ -642,7 +642,7 @@ export function addPreferredLanguage(language: string, index?: number): boolean; /** * Remove one language from preferred language list. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param index the position of removed language in preferred language list. * @return Returns a boolean represent whether removed success. * @since 8 @@ -652,7 +652,7 @@ export function removePreferredLanguage(index: number): boolean; /** * Access the system preferred language list. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns a string Array represent the preferred language list. * @since 8 */ @@ -661,7 +661,7 @@ export function getPreferredLanguageList(): Array; /** * Get the first preferred language of system. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns a string represent the first preferred language of system. * @since 8 */ diff --git a/api/@ohos.intl.d.ts b/api/@ohos.intl.d.ts index 070d0614a1..5bf8f664ee 100755 --- a/api/@ohos.intl.d.ts +++ b/api/@ohos.intl.d.ts @@ -16,7 +16,7 @@ /** * Provides internationalization related APIs. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 6 */ declare namespace intl { @@ -24,7 +24,7 @@ declare namespace intl { * Provides the options of Locale. * * @since 8 - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n */ export interface LocaleOptions { /** @@ -73,14 +73,14 @@ export interface LocaleOptions { /** * Provides APIs for obtaining locale information. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 6 */ export class Locale { /** * A constructor used to create a Locale object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale Indicates a character string containing the locale information, including * the language and optionally the script and region. * @since 6 @@ -90,7 +90,7 @@ export class Locale { /** * Indicates the language of the locale. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 6 */ language: string @@ -98,7 +98,7 @@ export class Locale { /** * Indicates the script of the locale. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 6 */ script: string @@ -106,7 +106,7 @@ export class Locale { /** * Indicates the region of the locale. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 6 */ region: string @@ -115,7 +115,7 @@ export class Locale { * Indicates the basic locale information, which is returned as a substring of * a complete locale string. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 6 */ baseName: string @@ -153,7 +153,7 @@ export class Locale { /** * Convert the locale information to string. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns locale information in string form. */ toString(): string; @@ -161,7 +161,7 @@ export class Locale { /** * Maximize the locale's base information. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns maximized locale. */ maximize(): Locale; @@ -169,7 +169,7 @@ export class Locale { /** * Minimize the locale's base information. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns minimized locale. */ minimize(): Locale; @@ -178,7 +178,7 @@ export class Locale { /** * Provides the options of date time format. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n */ export interface DateTimeOptions { /** @@ -280,14 +280,14 @@ export interface DateTimeOptions { /** * Provides the API for formatting date strings. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 6 */ export class DateTimeFormat { /** * A constructor used to create a DateTimeFormat object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ constructor(); @@ -295,7 +295,7 @@ export class DateTimeFormat { /** * A constructor used to create a DateTimeFormat object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale Indicates character string containing the locale information, including * the language and optionally the script and region, for the DateTimeFormat object. * @param options Indicates the options used to format the date. @@ -306,7 +306,7 @@ export class DateTimeFormat { /** * Obtains the formatted date strings. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param date Indicates the Date object to be formatted. * @return Returns a date string formatted based on the specified locale. * @since 6 @@ -316,7 +316,7 @@ export class DateTimeFormat { /** * Obtains the formatted date strings of a date range. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param startDate Indicates the start date of the date range. * @param endDate Indicates the end date of the date range. * @return Returns a date string formatted based on the specified locale. @@ -327,7 +327,7 @@ export class DateTimeFormat { /** * Obtains the options of the DateTimeFormat object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the options of the DateTimeFormat object. * @since 6 */ @@ -337,7 +337,7 @@ export class DateTimeFormat { /** * Provides the options of number format. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n */ export interface NumberOptions { /** @@ -439,13 +439,13 @@ export interface NumberOptions { /** * Provides the API for formatting number strings. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n */ export class NumberFormat { /** * A constructor used to create a NumberFormat object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ constructor(); @@ -453,7 +453,7 @@ export class NumberFormat { /** * A constructor used to create a NumberFormat object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale Indicates a character string containing the locale information, including * the language and optionally the script and region, for the NumberFormat object. * @param options Indicates the options used to format the number. @@ -464,7 +464,7 @@ export class NumberFormat { /** * Obtains the formatted number string. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param number Indicates the number to be formatted. * @return Returns a number string formatted based on the specified locale. * @since 6 @@ -474,7 +474,7 @@ export class NumberFormat { /** * Obtains the options of the NumberFormat object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns the options of the NumberFormat object. * @since 6 */ @@ -484,7 +484,7 @@ export class NumberFormat { /** * Provides the options of Collator * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export interface CollatorOptions { @@ -533,21 +533,21 @@ export interface CollatorOptions { /** * Enable language-sensitive string comparison. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export class Collator { /** * A constructor used to create Collator object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ constructor(); /** * A constructor used to create Collator Object; * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale Indicates a character string containing the locale information, including * the language and optionally the script and region, for the Collator object. * @param options Indicates the options used to initialize Collator object. @@ -558,7 +558,7 @@ export class Collator { /** * compares two strings according to the sort order of this Collator object * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param first The first string to compare. * @param second The second string to compare. * @return Returns a number indicating how first compare to second: @@ -573,7 +573,7 @@ export class Collator { * Returns a new object with properties reflecting the locale and collation options computed * during initialization of the object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @return Returns a CollatorOptions object reflecting the properties of this object. * @since 8 */ @@ -583,7 +583,7 @@ export class Collator { /** * Provides the options of PluralRules * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export interface PluralRulesOptions { @@ -633,14 +633,14 @@ export interface PluralRulesOptions { /** * Enables plural-sensitive formatting and plural-related language rules. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export class PluralRules { /** * A constructor used to create PluralRules object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ constructor(); @@ -648,7 +648,7 @@ export class PluralRules { /** * A constructor used to create PluralRules object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale Indicates a character string containing the locale information, including * the language and optionally the script and region, for the PluralRules object. * @param options Indicates the options used to initialize PluralRules object. @@ -659,7 +659,7 @@ export class PluralRules { /** * Returns a string indicating which plural rule to use for locale-aware formatting. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param n The number to get a plural rule for. * @return A string representing the pluralization category of the number, * can be one of zero, one, two, few, many or other. @@ -671,7 +671,7 @@ export class PluralRules { /** * Provides the input options of RelativeTimeFormat. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export interface RelativeTimeFormatInputOptions { @@ -697,7 +697,7 @@ export class PluralRules { /** * Provides the resolved options of RelativeTimeFormat. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export interface RelativeTimeFormatResolvedOptions { @@ -728,14 +728,14 @@ export interface RelativeTimeFormatResolvedOptions { * Given a Time period length value and a unit, RelativeTimeFormat object enables * language-sensitive relative time formatting. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ export class RelativeTimeFormat { /** * A constructor used to create RelativeTimeFormat object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @since 8 */ constructor(); @@ -743,7 +743,7 @@ export class RelativeTimeFormat { /** * A constructor used to create RelativeTimeFormat object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param locale Indicates a character string containing the locale information, including * the language and optionally the script and region, for the RelativeTimeFormat object. * @param options Indicates the options used to initialize RelativeTimeFormat object. @@ -754,7 +754,7 @@ export class RelativeTimeFormat { /** * formats a value and unit according to the locale and formatting options of this object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param value Numeric value to use in the internationalized relative time message. * @param unit Unit to use in the relative time internationalized message. * Possible values are: year, quarter, month, week, day, hour, minute, second. @@ -767,7 +767,7 @@ export class RelativeTimeFormat { * returns an Array of objects representing the relative time format in parts that can be used for * custom locale-aware formatting * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @param value Numeric value to use in the internationalized relative time message. * @param unit to use in the relative time internationalized message. * Possible values are: year, quarter, month, week, day, hour, minute, second. @@ -780,7 +780,7 @@ export class RelativeTimeFormat { * Returns a new object with properties reflecting the locale and formatting options computed during * initialization of the object. * - * @sysCap SystemCapability.Global.I18n + * @syscap SystemCapability.Global.I18n * @returns RelativeTimeFormatOptions which reflecting the locale and formatting options of the object. * @since 8 */ -- Gitee From 4f55b7c7d6b61c4ce849f393470d07a83e42de23 Mon Sep 17 00:00:00 2001 From: x00405909 Date: Wed, 2 Mar 2022 10:19:56 +0800 Subject: [PATCH 15/18] =?UTF-8?q?syscap=20=E6=94=B9=E5=B0=8F=E5=86=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: x00405909 Change-Id: I56891fcba44d730c51398d851bc23b2510b7fbab --- api/@ohos.deviceInfo.d.ts | 2 +- api/@ohos.systemparameter.d.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/api/@ohos.deviceInfo.d.ts b/api/@ohos.deviceInfo.d.ts index 18cca63174..8e91729a90 100644 --- a/api/@ohos.deviceInfo.d.ts +++ b/api/@ohos.deviceInfo.d.ts @@ -17,7 +17,7 @@ * A static class pertaining to the product information. * * @since 6 - * @Syscap SystemCapability.Startup.SysInfo + * @syscap SystemCapability.Startup.SysInfo */ declare namespace deviceInfo { /** diff --git a/api/@ohos.systemparameter.d.ts b/api/@ohos.systemparameter.d.ts index 57a2906095..1e20358fa7 100644 --- a/api/@ohos.systemparameter.d.ts +++ b/api/@ohos.systemparameter.d.ts @@ -19,7 +19,7 @@ import { AsyncCallback, BusinessError } from './basic'; * The interface of system parameters class. * * @since 6 - * @Syscap SystemCapability.Startup.SysInfo + * @syscap SystemCapability.Startup.SysInfo * @hide */ declare namespace systemParameter { -- Gitee From 80e24032754fde2c7196556e28fed8f4a6b0d7f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miss=E6=B7=B1=E6=B5=B7=E9=B1=BC?= Date: Wed, 2 Mar 2022 07:21:21 +0000 Subject: [PATCH 16/18] update api/@ohos.wallpaper.d.ts. Signed-off-by: miss-deep-sea-fish --- api/@ohos.wallpaper.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/@ohos.wallpaper.d.ts b/api/@ohos.wallpaper.d.ts index b0f83f66f4..9b1776d5c4 100644 --- a/api/@ohos.wallpaper.d.ts +++ b/api/@ohos.wallpaper.d.ts @@ -17,7 +17,7 @@ import image from './@ohos.multimedia.image' /** * System wallpaper - * @sysCap SystemCapability.Miscservices.WallpaperFramework + * @syscap SystemCapability.Miscservices.WallpaperFramework * @devices phone, tablet, tv, wearable, car * @import import wallpaper from '@ohos.wallpaper'; * @since 7 -- Gitee From 0f91d5c27087f1d087951200446be5cd05c13d6b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miss=E6=B7=B1=E6=B5=B7=E9=B1=BC?= Date: Wed, 2 Mar 2022 07:22:05 +0000 Subject: [PATCH 17/18] update api/@ohos.systemTime.d.ts. Signed-off-by: miss-deep-sea-fish --- api/@ohos.systemTime.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/@ohos.systemTime.d.ts b/api/@ohos.systemTime.d.ts index 9071438b0e..8a15765fcb 100755 --- a/api/@ohos.systemTime.d.ts +++ b/api/@ohos.systemTime.d.ts @@ -18,7 +18,7 @@ import { AsyncCallback, ErrorCallback } from './basic'; /** * System time and timezone. * @since 7 - * @sysCap SystemCapability.Miscservices.Time + * @syscap SystemCapability.Miscservices.Time * @devices phone, tablet, tv, wearable, car * @import systemTime from '@ohos.systemTime'; */ -- Gitee From ce772be61580b1a9f1040c2ca0069ead2bc6ce53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miss=E6=B7=B1=E6=B5=B7=E9=B1=BC?= Date: Wed, 2 Mar 2022 07:22:50 +0000 Subject: [PATCH 18/18] update api/@ohos.pasteboard.d.ts. Signed-off-by: miss-deep-sea-fish --- api/@ohos.pasteboard.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/@ohos.pasteboard.d.ts b/api/@ohos.pasteboard.d.ts index facf37ba9e..e1e14bcded 100644 --- a/api/@ohos.pasteboard.d.ts +++ b/api/@ohos.pasteboard.d.ts @@ -17,7 +17,7 @@ import { Want } from './ability/want'; /** * systemPasteboard - * @sysCap SystemCapability.Miscservices.Pasteboard + * @syscap SystemCapability.Miscservices.Pasteboard * @devices phone, tablet, tv, wearable, car * @import import pasteboard from '@ohos.pasteboard'; */ -- Gitee