;
/**
- * Sets the oauth token visibility of the specifed authentication type to a third-party application.
+ * Sets the oauth token visibility of the specified authentication type to a third-party application.
*
* Only the owner of the application account has the permission to call this method.
*
@@ -341,7 +341,7 @@ declare namespace appAccount {
setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise;
/**
- * Checks the oauth token visibility of the specifed authentication type for a third-party application.
+ * Checks the oauth token visibility of the specified authentication type for a third-party application.
*
* Only the owner of the application account has the permission to call this method.
*
diff --git a/api/@ohos.account.distributedAccount.d.ts b/api/@ohos.account.distributedAccount.d.ts
index 33ba7f02e20789e9f61c298cf7834330eba5caef..38a0fa43bd19d003d967e3f1c7759eefd2c32ec5 100644
--- a/api/@ohos.account.distributedAccount.d.ts
+++ b/api/@ohos.account.distributedAccount.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.account.osAccount.d.ts b/api/@ohos.account.osAccount.d.ts
index 9229e35f59653bda9ede893ff9f339062254852a..703c36b1f37f2cf19e6223ba85f07080dac6bfc9 100644
--- a/api/@ohos.account.osAccount.d.ts
+++ b/api/@ohos.account.osAccount.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
@@ -64,11 +64,11 @@ declare namespace osAccount {
isMultiOsAccountEnable(): Promise;
/**
- * Checks whether an OS account is actived based on its local ID.
+ * Checks whether an OS account is activated based on its local ID.
*
* @since 7
* @param localId Indicates the local ID of the OS account.
- * @return Returns {@code true} if the OS account is actived; returns {@code false} otherwise.
+ * @return Returns {@code true} if the OS account is activated; returns {@code false} otherwise.
* @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS/ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
*/
isOsAccountActived(localId: number, callback: AsyncCallback): void;
@@ -466,7 +466,7 @@ declare namespace osAccount {
serialNumber: number;
/**
- * Os account is actived or not.
+ * Os account is activated or not.
* @since 8
*/
isActived: boolean;
diff --git a/api/@ohos.animator.d.ts b/api/@ohos.animator.d.ts
index 2f306abcc6f27540380af20e75ef2238c5f37250..3f4360181c446781c2a3284436bcfc7dc5f5265a 100644
--- a/api/@ohos.animator.d.ts
+++ b/api/@ohos.animator.d.ts
@@ -14,14 +14,14 @@
*/
/**
- * @devices phone, tablet, wearable, tv, car
+ * Defines the animator options.
+ * @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
export interface AnimatorOptions {
/**
* Duration of the animation, in milliseconds.
* The default value is 0.
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
duration: number;
@@ -44,7 +44,6 @@ export interface AnimatorOptions {
* cubic-bezier(x1, y1, x2, y2) You can customize an animation speed curve in the cubic-bezier() function. The x and y values of each input parameter must be between 0 and 1.
* Step curve. The number must be set and only an integer is supported, step-position is optional. It can be set to start or end. The default value is end.
* The default value is ease.
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
easing: string;
@@ -52,7 +51,6 @@ export interface AnimatorOptions {
/**
* Delay for the animation start. The default value indicates no delay.
* The default value is 0.
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
delay: number;
@@ -61,7 +59,6 @@ export interface AnimatorOptions {
* Whether to resume to the initial state after the animation is executed.
* none: The initial state is restored after the animation is executed.
* forwards: The state at the end of the animation (defined in the last key frame) is retained after the animation is executed.
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
fill: "none" | "forwards" | "backwards" | "both";
@@ -69,7 +66,6 @@ export interface AnimatorOptions {
/**
* The animation playback mode.
* The default value is "normal".
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
direction: "normal" | "reverse" | "alternate" | "alternate-reverse";
@@ -77,7 +73,6 @@ export interface AnimatorOptions {
/**
* Number of times the animation will be played. number indicates a fixed number of playback operations, and -1 an unlimited number of playback operations.
* The default value is 1.
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
iterations: number;
@@ -85,7 +80,6 @@ export interface AnimatorOptions {
/**
* Starting point of animator interpolation.
* The default value is 0.
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
begin: number;
@@ -93,77 +87,74 @@ export interface AnimatorOptions {
/**
* Ending point of Dynamic Interpolation
* The default value is 1.
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
end: number;
}
+/**
+ * Defines the Animator result interface.
+ * @syscap SystemCapability.ArkUI.ArkUI.Full
+ * @since 6
+ */
export interface AnimatorResult {
/**
* Update the options for current animator.
* @param options Options.
+ * @since 6
*/
update(options: AnimatorOptions): void;
/**
* Starts the animation.
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
play(): void;
/**
* Ends the animation.
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
finish(): void;
/**
* Pauses the animation.
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
pause(): void;
/**
* Cancels the animation.
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
cancel(): void;
/**
* Plays the animation in reverse direction.
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
reverse(): void;
/**
* Trigger when vsync callback.
* @param progress The current progress of animtion
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
onframe: (progress: number) => void;
/**
* The animation is finished.
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
onfinish: () => void;
/**
* The animation is canceled.
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
oncancel: () => void;
/**
* The animation is repeated.
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
onrepeat: () => void;
}
/**
- * @devices phone, tablet, wearable, tv, car
+ * Defines the Animator class.
+ * @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
* @import prompt from '@ohos.animator';
*/
@@ -171,7 +162,6 @@ export default class Animator {
/**
* Create an animator object for custum animation.
* @param options Options.
- * @devices phone, tablet, wearable, tv, car
* @since 6
*/
static createAnimator(options: AnimatorOptions): AnimatorResult;
diff --git a/api/@ohos.app.abilityManager.d.ts b/api/@ohos.app.abilityManager.d.ts
deleted file mode 100644
index 9b430de3ca7765df86929782bae19ee36ffc4cc4..0000000000000000000000000000000000000000
--- a/api/@ohos.app.abilityManager.d.ts
+++ /dev/null
@@ -1,85 +0,0 @@
-/*
- * 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';
-import { AbilityMissionInfo } from './app/abilityMissionInfo';
-import { ActiveProcessInfo } from './app/activeProcessInfo';
-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
- * @import import abilityManager from '@ohos.app.abilityManager'
- * @permission N/A
- */
-declare namespace abilityManager {
-
- enum ProcessErrCode {
- NO_ERROR = 0,
- CRASHED,
- NO_RESPONSE,
- }
-
-
- /**
- * Get information about running processes
- * @since 7
- * @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
- */
- function getActiveProcessInfos(): Promise>;
- function getActiveProcessInfos(callback: AsyncCallback>): void;
-
- /**
- * Get information about the running ability missions
- * @since 7
- * @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
- * @systemapi hide this for inner system use
- */
- function getActiveAbilityMissionInfos(upperLimit: number): Promise>;
- function getActiveAbilityMissionInfos(upperLimit: number, callback: AsyncCallback>): void;
-
- /**
- * Get information about recently run missions
- * @since 7
- * @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
- * @systemapi hide this for inner system use
- */
- function getPreviousAbilityMissionInfos(upperLimit: number): Promise>;
- function getPreviousAbilityMissionInfos(upperLimit: number, callback: AsyncCallback>): void;
-
- /**
- * Delete the specified missions
- * @since 7
- * @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
- */
- function deleteMissions(missionIds: Array): Promise;
- function deleteMissions(missionIds: Array, callback: AsyncCallback): void;
-}
-
-export default abilityManager;
diff --git a/api/@ohos.application.Ability.d.ts b/api/@ohos.application.Ability.d.ts
index 65963be527b5e0901076ed6d413728e4407f4a79..8a19baf2bb13055826e0af9c1a01c0435d6de2b0 100755
--- a/api/@ohos.application.Ability.d.ts
+++ b/api/@ohos.application.Ability.d.ts
@@ -20,21 +20,51 @@ 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
+ * @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
+ * @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
- * @devices phone, tablet, tv, wearable, car
+ * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @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 +73,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 +85,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 +95,43 @@ 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
- * @devices phone, tablet, tv, wearable, car
+ * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @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;
@@ -104,7 +141,7 @@ import rpc from '/@ohos.rpc';
* The class of an ability.
*
* @since 9
- * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore
+ * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @permission N/A
* @StageModelOnly
*/
@@ -113,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;
@@ -122,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;
@@ -131,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;
@@ -140,7 +177,7 @@ export default class Ability {
* Call Service Stub Object.
*
* @since 9
- * @sysCap AAFwk
+ * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @StageModelOnly
*/
callee: Callee;
@@ -149,7 +186,9 @@ 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
+ * @param want Indicates the want info of the created ability.
+ * @param param Indicates the launch param.
* @return -
* @StageModelOnly
*/
@@ -159,7 +198,8 @@ 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
+ * @param windowStage Indicates the created WindowStage.
* @return -
* @StageModelOnly
*/
@@ -169,17 +209,28 @@ 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
*/
onWindowStageDestroy(): void;
+ /**
+ * Called back when an ability window stage is restored.
+ *
+ * @since 9
+ * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
+ * @param windowStage window stage to restore
+ * @return -
+ * @StageModelOnly
+ */
+ onWindowStageRestore(windowStage: window.WindowStage): void;
+
/**
* Called back before an ability is destroyed.
*
* @since 9
- * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore
+ * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @return -
* @StageModelOnly
*/
@@ -189,7 +240,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
*/
@@ -199,7 +250,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
*/
@@ -209,7 +260,8 @@ export default class Ability {
* Called back when an ability prepares to migrate.
*
* @since 9
- * @sysCap SystemCapability.Ability.AbilityRuntime.AbilityCore
+ * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
+ * @param wantParam Indicates the want parameter.
* @return true if ability agrees to migrate and saves data successfully, otherwise false.
* @StageModelOnly
*/
@@ -219,9 +271,9 @@ 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 AAFwk
+ * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
+ * @param want Indicates the want info of ability.
* @return -
* @StageModelOnly
*/
@@ -230,9 +282,9 @@ export default class Ability {
/**
* Called when the system configuration is updated.
*
- * @devices phone, tablet, tv, wearable, car
* @since 9
- * @sysCap AAFwk
+ * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
+ * @param config Indicates the updated configuration.
* @return -
* @StageModelOnly
*/
diff --git a/api/@ohos.application.AbilityConstant.d.ts b/api/@ohos.application.AbilityConstant.d.ts
index d2691c2e98cdb1048738e380ceffe927876e5dfb..e43db61c8a1c4d1ab277e8b228cae536fcb11eb4 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 7d1762c145c62798083d80e1da61e1aae9809520..ae3a53612f466a5b9de20467dde06bd0733cb572 100644
--- a/api/@ohos.application.AbilityStage.d.ts
+++ b/api/@ohos.application.AbilityStage.d.ts
@@ -48,10 +48,12 @@ export default class AbilityStage {
/**
* Called back when start specified ability.
*
- * @devices phone, tablet, tv, wearable, car
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
- * @return -
+ * @param want Indicates the want info of startd ability.
+ * @return The user returns an ability string ID. If the ability of this ID has been started before,
+ * do not create a new instance and pull it back to the top of the stack.
+ * Otherwise, create a new instance and start it.
* @StageModelOnly
*/
onAcceptWant(want: Want): string;
@@ -61,6 +63,7 @@ export default class AbilityStage {
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
+ * @param config Indicates the updated configuration.
* @return -
* @StageModelOnly
*/
diff --git a/api/@ohos.application.Configuration.d.ts b/api/@ohos.application.Configuration.d.ts
index 9acbda4fa5ba669522f1ead499705f9fb036064e..f00b528ddf7fa6039c6e630a6571f830b40793a0 100644
--- a/api/@ohos.application.Configuration.d.ts
+++ b/api/@ohos.application.Configuration.d.ts
@@ -43,7 +43,7 @@ export interface Configuration {
/**
* Indicates the screen direction of the current device.
*
- * @since 8
+ * @since 9
* @syscap SystemCapability.Ability.AbilityBase
*/
direction: ConfigurationConstant.Direction;
@@ -51,7 +51,7 @@ export interface Configuration {
/**
* Indicates the screen density of the current device.
*
- * @since 8
+ * @since 9
* @syscap SystemCapability.Ability.AbilityBase
*/
screenDensity: ConfigurationConstant.ScreenDensity;
@@ -59,7 +59,7 @@ export interface Configuration {
/**
* Indicates the displayId of the current device.
*
- * @since 8
+ * @since 9
* @syscap SystemCapability.Ability.AbilityBase
*/
displayId: number;
diff --git a/api/@ohos.application.ConfigurationConstant.d.ts b/api/@ohos.application.ConfigurationConstant.d.ts
index b9ed5f3e19e620af0b740b26577a639825afa721..cdf3b32724869aa6705e85d53a58b7dddbff196f 100644
--- a/api/@ohos.application.ConfigurationConstant.d.ts
+++ b/api/@ohos.application.ConfigurationConstant.d.ts
@@ -35,7 +35,7 @@
/**
* @name Direction
- * @since 8
+ * @since 9
* @syscap SystemCapability.Ability.AbilityBase
* @permission N/A
*/
@@ -47,7 +47,7 @@
/**
* @name ScreenDensity
- * @since 8
+ * @since 9
* @syscap SystemCapability.Ability.AbilityBase
* @permission N/A
*/
diff --git a/api/@ohos.application.DataShareExtensionAbility.d.ts b/api/@ohos.application.DataShareExtensionAbility.d.ts
index dce6c206a8ff9926c35894233dfb8fa8da70de1d..495ac85091bc5345c5e121f2de3f95345f4b063e 100644
--- a/api/@ohos.application.DataShareExtensionAbility.d.ts
+++ b/api/@ohos.application.DataShareExtensionAbility.d.ts
@@ -62,7 +62,7 @@ export default class DataShareExtensionAbility {
* @systemapi Hide this for inner system use.
* @return Returns the MIME type of the matched files; returns null if there is no type that matches the Data
*/
- getFileTypes?(uri: string, mimeTypeFilter: string): Array;
+ getFileTypes?(uri: string, mimeTypeFilter: string, callback: AsyncCallback>): void;
/**
* Inserts a data record into the database. This method should be implemented by a data share.
@@ -74,7 +74,7 @@ export default class DataShareExtensionAbility {
* @systemapi Hide this for inner system use.
* @return Returns the index of the newly inserted data record.
*/
- insert?(uri: string, valueBucket: rdb.ValuesBucket): number;
+ insert?(uri: string, valueBucket: rdb.ValuesBucket, callback: AsyncCallback): void;
/**
* Updates one or more data records in the database. This method should be implemented by a data share.
@@ -88,7 +88,8 @@ export default class DataShareExtensionAbility {
* @systemapi Hide this for inner system use.
* @return Returns the number of data records updated.
*/
- update?(uri: string, valueBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates): number;
+ update?(uri: string, valueBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates,
+ callback: AsyncCallback): void;
/**
* Deletes one or more data records. This method should be implemented by a data share.
@@ -101,7 +102,7 @@ export default class DataShareExtensionAbility {
* @systemapi Hide this for inner system use.
* @return Returns the number of data records deleted.
*/
- delete?(uri: string, predicates: dataAbility.DataAbilityPredicates): number;
+ delete?(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback): void;
/**
* Queries one or more data records in the database. This method should be implemented by a data share.
@@ -116,7 +117,8 @@ export default class DataShareExtensionAbility {
* @systemapi Hide this for inner system use.
* @return Returns the queried data.
*/
- query?(uri: string, columns: Array, predicates: dataAbility.DataAbilityPredicates): ResultSet;
+ query?(uri: string, columns: Array, predicates: dataAbility.DataAbilityPredicates,
+ callback: AsyncCallback): void;
/**
* Obtains the MIME type matching the data specified by the URI of the data share. This method should be
@@ -130,7 +132,7 @@ export default class DataShareExtensionAbility {
* @systemapi Hide this for inner system use.
* @return Returns the MIME type that matches the data specified by {@code uri}.
*/
- getType?(uri: string): string;
+ getType?(uri: string, callback: AsyncCallback): void;
/**
* Inserts multiple data records into the database. This method should be implemented by a data share.
@@ -142,7 +144,7 @@ export default class DataShareExtensionAbility {
* @systemapi Hide this for inner system use.
* @return Returns the number of data records inserted.
*/
- batchInsert?(uri: string, valueBuckets: Array): number;
+ batchInsert?(uri: string, valueBuckets: Array, callback: AsyncCallback): void;
/**
* Converts the given {@code uri} that refer to the data share into a normalized URI. A normalized URI can be
@@ -155,7 +157,7 @@ export default class DataShareExtensionAbility {
* @systemapi Hide this for inner system use.
* @return Returns the normalized uri if the data share supports URI normalization;
*/
- normalizeUri?(uri: string): string;
+ normalizeUri?(uri: string, callback: AsyncCallback): void;
/**
* Converts the given normalized {@code uri} generated by {@link #normalizeUri(uri)} into a denormalized one.
@@ -169,5 +171,5 @@ export default class DataShareExtensionAbility {
* {@code uri} passed to this method if there is nothing to do; returns {@code null} if the data identified by
* the original {@code uri} cannot be found in the current environment.
*/
- denormalizeUri?(uri: string): string;
+ denormalizeUri?(uri: string, callback: AsyncCallback): void;
}
\ No newline at end of file
diff --git a/api/@ohos.application.FormExtension.d.ts b/api/@ohos.application.FormExtension.d.ts
index 63862c0c221b5e3524fc49735c6fe848bad82b3f..166674ad6086c4989d89385e42d80839c3e322ca 100644
--- a/api/@ohos.application.FormExtension.d.ts
+++ b/api/@ohos.application.FormExtension.d.ts
@@ -118,6 +118,7 @@ export default class FormExtension {
*
* @since 9
* @syscap SystemCapability.Ability.Form
+ * @param system configuration, such as language and color mode.
* @return -
* @StageModelOnly
*/
diff --git a/api/@ohos.application.ServiceExtension.d.ts b/api/@ohos.application.ServiceExtension.d.ts
index 002684069a63fda834df098140a46b339d008254..8ef9102c89638a0bb3a484ca64d1b2c43c1df24d 100644
--- a/api/@ohos.application.ServiceExtension.d.ts
+++ b/api/@ohos.application.ServiceExtension.d.ts
@@ -42,6 +42,7 @@ export default class ServiceExtension {
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
+ * @param want Indicates the want of created service extension.
* @systemapi hide for inner use.
* @return -
* @StageModelOnly
@@ -116,6 +117,7 @@ export default class ServiceExtension {
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
+ * @param config Indicates the updated configuration.
* @return -
* @StageModelOnly
*/
diff --git a/api/@ohos.application.ServiceExtAbility.d.ts b/api/@ohos.application.ServiceExtensionAbility.d.ts
similarity index 72%
rename from api/@ohos.application.ServiceExtAbility.d.ts
rename to api/@ohos.application.ServiceExtensionAbility.d.ts
index 57a549082fc195e6c9f0ce9c98d039428b4dfdab..d4d06bc4049ed66d3da2a102513a14cb640bc907 100644
--- a/api/@ohos.application.ServiceExtAbility.d.ts
+++ b/api/@ohos.application.ServiceExtensionAbility.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
@@ -14,35 +14,35 @@
*/
import rpc from "./@ohos.rpc";
-import ServiceExtAbilityContext from "./application/ServiceExtAbilityContext";
+import ServiceExtensionContext from "./application/ServiceExtensionContext";
import Want from './@ohos.application.Want';
+import { Configuration } from './@ohos.application.Configuration';
/**
* 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
*/
-export default class ServiceExtAbility {
+export default class ServiceExtensionAbility {
/**
* Indicates service extension ability context.
*
* @since 9
- * @sysCap AAFwk
+ * @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi hide for inner use.
* @StageModelOnly
*/
- context: ServiceExtAbilityContext;
+ context: ServiceExtensionContext;
/**
* 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
+ * @param want Indicates the want of created service extension.
* @systemapi hide for inner use.
* @return -
* @StageModelOnly
@@ -52,9 +52,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 +63,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 +78,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 +90,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,14 +103,24 @@ 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 -
* @StageModelOnly
*/
onReconnect(want: Want): void;
+
+ /**
+ * Called when the system configuration is updated.
+ *
+ * @since 9
+ * @syscap SystemCapability.Ability.AbilityRuntime.Core
+ * @param config Indicates the updated configuration.
+ * @return -
+ * @StageModelOnly
+ */
+ onConfigurationUpdated(config: Configuration): void;
}
diff --git a/api/@ohos.application.StartOptions.d.ts b/api/@ohos.application.StartOptions.d.ts
index 5c0b9e7d041e9e27f562824297483e010cc21b6e..b4cd41bbceab5748d8c933e5331f968ec393817e 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.StaticSubscriberExtensionAbility.d.ts b/api/@ohos.application.StaticSubscriberExtensionAbility.d.ts
new file mode 100644
index 0000000000000000000000000000000000000000..ebd6484ac6fee62f5cfe1c91699ec6a662c9de96
--- /dev/null
+++ b/api/@ohos.application.StaticSubscriberExtensionAbility.d.ts
@@ -0,0 +1,37 @@
+/*
+ * 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
+ *
+ * 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 CommonEventData from "./commonEvent/commonEventData";
+
+/**
+ * class of static subscriber extension ability.
+ *
+ * @since 9
+ * @syscap SystemCapability.Ability.AbilityRuntime.Core
+ * @systemapi hide for inner use.
+ * @StageModelOnly
+ */
+export default class StaticSubscriberExtensionAbility {
+ /**
+ * Called back when a specific common event is published.
+ *
+ * @since 9
+ * @syscap SystemCapability.Ability.AbilityRuntime.Core
+ * @systemapi hide for inner use.
+ * @return -
+ * @StageModelOnly
+ */
+ onReceiveEvent(event: CommonEventData): void;
+}
\ No newline at end of file
diff --git a/api/@ohos.application.Want.d.ts b/api/@ohos.application.Want.d.ts
index 337e376ae1577c1a1cedb04d5fed5b48fc7d4f4e..6b2c2b0ae671dc0d0f36a7f79506d7801fa7e39d 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.abilityDelegatorRegistry.d.ts b/api/@ohos.application.abilityDelegatorRegistry.d.ts
new file mode 100644
index 0000000000000000000000000000000000000000..c21a8cc64ede0a8d5e28226ba6dc2087d3b8ff97
--- /dev/null
+++ b/api/@ohos.application.abilityDelegatorRegistry.d.ts
@@ -0,0 +1,62 @@
+/*
+ * 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 { AbilityDelegator } from './application/abilityDelegator'
+import { AbilityDelegatorArgs } from './application/abilityDelegatorArgs'
+
+/**
+ * A global register used to store the AbilityDelegator and AbilityDelegatorArgs objects registered
+ * during application startup.
+ *
+ * @since 9
+ * @syscap SystemCapability.Ability.AbilityRuntime.Core
+ * @import import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'
+ * @permission N/A
+ */
+declare namespace abilityDelegatorRegistry {
+ /**
+ * Get the AbilityDelegator object of the application.
+ *
+ * @since 9
+ * @syscap SystemCapability.Ability.AbilityRuntime.Core
+ * @return the AbilityDelegator object initialized when the application is started.
+ */
+ function getAbilityDelegator(): AbilityDelegator;
+
+ /**
+ * Get unit test parameters stored in the AbilityDelegatorArgs object.
+ *
+ * @since 9
+ * @syscap SystemCapability.Ability.AbilityRuntime.Core
+ * @return the previously registered AbilityDelegatorArgs object.
+ */
+ function getArguments(): AbilityDelegatorArgs;
+
+ /**
+ * Describes all lifecycle states of an ability.
+ *
+ * @since 9
+ * @syscap SystemCapability.Ability.AbilityRuntime.Core
+ */
+ export enum AbilityLifecycleState {
+ UNINITIALIZED,
+ CREATE,
+ FOREGROUND,
+ BACKGROUND,
+ DESTROY,
+ }
+}
+
+export default abilityDelegatorRegistry;
\ No newline at end of file
diff --git a/api/@ohos.application.abilityManager.d.ts b/api/@ohos.application.abilityManager.d.ts
index ff2426a5e7bc9e4598d977d2e6bd62e604fb6fba..5221fc08a0d6a920ccbb6bd401a8b2387372b4ad 100644
--- a/api/@ohos.application.abilityManager.d.ts
+++ b/api/@ohos.application.abilityManager.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
@@ -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,10 +45,11 @@ 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 -
+ * @permission ohos.permission.UPDATE_CONFIGURATION
*/
function updateConfiguration(config: Configuration, callback: AsyncCallback): void;
function updateConfiguration(config: Configuration): Promise;
@@ -57,21 +58,23 @@ 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 -
+ * @return Returns the array of {@link AbilityRunningInfo}.
+ * @permission ohos.permission.GET_RUNNING_INFO
*/
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 -
+ * @return Returns the array of {@link ExtensionRunningInfo}.
+ * @permission ohos.permission.GET_RUNNING_INFO
*/
function getExtensionRunningInfos(upperLimit: number): Promise>;
function getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback>): void;
diff --git a/api/@ohos.application.appManager.d.ts b/api/@ohos.application.appManager.d.ts
index dcb6dca86ab862ac726dd65add9cc4c67820639f..eb086aec2838d5ac416242f732b174a7fde2c75e 100644
--- a/api/@ohos.application.appManager.d.ts
+++ b/api/@ohos.application.appManager.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
@@ -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,10 +32,11 @@ 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.
+ * @permission ohos.permission.RUNNING_STATE_OBSERVER
*/
function registerApplicationStateObserver(observer: ApplicationStateObserver): number;
@@ -43,10 +44,11 @@ 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 -
+ * @permission ohos.permission.RUNNING_STATE_OBSERVER
*/
function unregisterApplicationStateObserver(observerId: number, callback: AsyncCallback): void;
function unregisterApplicationStateObserver(observerId: number): Promise;
@@ -55,9 +57,10 @@ 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.
+ * @permission ohos.permission.GET_RUNNING_INFO
*/
function getForegroundApplications(callback: AsyncCallback>): void;
function getForegroundApplications(): Promise>;
@@ -66,11 +69,12 @@ 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
* @return -
+ * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES
*/
function killProcessWithAccount(bundleName: string, accountId: number): Promise;
function killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCallback): void;
@@ -79,7 +83,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,9 +93,10 @@ 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 -
+ * @return Returns the array of {@link ProcessRunningInfo}.
+ * @permission ohos.permission.GET_RUNNING_INFO
*/
function getProcessRunningInfos(): Promise>;
function getProcessRunningInfos(callback: AsyncCallback>): void;
@@ -99,11 +104,10 @@ 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
+ * @permission ohos.permission.CLEAN_BACKGROUND_PROCESSES
*/
function killProcessesByBundleName(bundleName: string): Promise;
function killProcessesByBundleName(bundleName: string, callback: AsyncCallback);
@@ -111,14 +115,31 @@ 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
+ * @permission ohos.permission.CLEAN_APPLICATION_DATA
*/
function clearUpApplicationData(bundleName: string): Promise;
function clearUpApplicationData(bundleName: string, callback: AsyncCallback);
+
+ /**
+ * Is it a ram-constrained device
+ * @since 7
+ * @syscap SystemCapability.Ability.AbilityRuntime.Core
+ * @return whether a ram-constrained device.
+ */
+ function isRamConstrainedDevice(): Promise;
+ function isRamConstrainedDevice(callback: AsyncCallback): void;
+
+ /**
+ * Get the memory size of the application
+ * @since 7
+ * @syscap SystemCapability.Ability.AbilityRuntime.Core
+ * @return application memory size.
+ */
+ function getAppMemorySize(): Promise;
+ function getAppMemorySize(callback: AsyncCallback): void;
}
export default appManager;
diff --git a/api/@ohos.application.formBindingData.d.ts b/api/@ohos.application.formBindingData.d.ts
index ad398765917917ecc7774d2e0ff1cda7225c41e0..f961244748da0e4ed4a16aaff2012a08081f3737 100644
--- a/api/@ohos.application.formBindingData.d.ts
+++ b/api/@ohos.application.formBindingData.d.ts
@@ -18,19 +18,24 @@
*
* @name formBindingData
* @since 8
- * @sysCap SystemCapability.Ability.AbilityRuntime.Core
+ * @syscap SystemCapability.Ability.Form
*/
declare namespace formBindingData {
/**
* Create an FormBindingData instance.
*
* @since 8
- * @sysCap SystemCapability.Ability.AbilityRuntime.Core
+ * @syscap SystemCapability.Ability.Form
* @param obj Indicates the FormBindingData instance data.
* @return Returns the {@link FormBindingData} instance.
*/
function createFormBindingData(obj?: Object | string): FormBindingData;
+ /**
+ * Defines the createFormBindingData result interface.
+ * @syscap SystemCapability.Ability.Form
+ * @since 8
+ */
interface FormBindingData {
data: Object
}
diff --git a/api/@ohos.application.missionManager.d.ts b/api/@ohos.application.missionManager.d.ts
index 94f172f8e5fc096eaf834b759b95bc4de2195a7c..dc6a871c31938cc604ca2c107fa0cf98cf7731fd 100644
--- a/api/@ohos.application.missionManager.d.ts
+++ b/api/@ohos.application.missionManager.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
@@ -24,8 +24,8 @@ import StartOptions from "./@ohos.application.StartOptions";
*
* @name missionManager
* @since 8
- * @sysCap SystemCapability.Ability.AbilityRuntime.Mission
- * @permission N/A
+ * @syscap SystemCapability.Ability.AbilityRuntime.Mission
+ * @permission ohos.permission.MANAGE_MISSIONS
* @systemapi hide for inner use.
*/
declare namespace missionManager {
@@ -33,7 +33,8 @@ declare namespace missionManager {
* Register the missionListener to ams.
*
* @since 8
- * @sysCap SystemCapability.Ability.AbilityRuntime.Mission
+ * @syscap SystemCapability.Ability.AbilityRuntime.Mission
+ * @param listener Indicates the MissionListener to be registered.
* @return The index number of the MissionListener.
*/
function registerMissionListener(listener: MissionListener): number;
@@ -42,7 +43,8 @@ declare namespace missionManager {
* Unrgister the missionListener to ams.
*
* @since 8
- * @sysCap SystemCapability.Ability.AbilityRuntime.Mission
+ * @syscap SystemCapability.Ability.AbilityRuntime.Mission
+ * @param listenerId Indicates the listener id to be unregistered.
* @return -
*/
function unregisterMissionListener(listenerId: number, callback: AsyncCallback): void;
@@ -52,7 +54,9 @@ declare namespace missionManager {
* Get the missionInfo with the given missionId.
*
* @since 8
- * @sysCap SystemCapability.Ability.AbilityRuntime.Mission
+ * @syscap SystemCapability.Ability.AbilityRuntime.Mission
+ * @param deviceId Indicates the device to be queried.
+ * @param missionId Indicates mission id to be queried.
* @return the {@link MissionInfo} of the given id.
*/
function getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback): void;
@@ -62,7 +66,9 @@ declare namespace missionManager {
* Get the missionInfo with the given missionId.
*
* @since 8
- * @sysCap SystemCapability.Ability.AbilityRuntime.Mission
+ * @syscap SystemCapability.Ability.AbilityRuntime.Mission
+ * @param deviceId Indicates the device to be queried.
+ * @param numMax Indicates the maximum number of returned missions.
* @return The array of the {@link MissionInfo}.
*/
function getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback>): void;
@@ -72,7 +78,9 @@ declare namespace missionManager {
* Get the mission snapshot with the given missionId.
*
* @since 8
- * @sysCap SystemCapability.Ability.AbilityRuntime.Mission
+ * @syscap SystemCapability.Ability.AbilityRuntime.Mission
+ * @param deviceId Indicates the device to be queried.
+ * @param missionId Indicates mission id to be queried.
* @return The {@link MissionSnapshot} of the given id.
*/
function getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback): void;
@@ -82,7 +90,8 @@ declare namespace missionManager {
* Lock the mission.
*
* @since 8
- * @sysCap SystemCapability.Ability.AbilityRuntime.Mission
+ * @syscap SystemCapability.Ability.AbilityRuntime.Mission
+ * @param missionId Indicates mission id to be locked.
* @return -
*/
function lockMission(missionId: number, callback: AsyncCallback): void;
@@ -92,7 +101,8 @@ declare namespace missionManager {
* Unlock the mission.
*
* @since 8
- * @sysCap SystemCapability.Ability.AbilityRuntime.Mission
+ * @syscap SystemCapability.Ability.AbilityRuntime.Mission
+ * @param missionId Indicates mission id to be unlocked.
* @return -
*/
function unlockMission(missionId: number, callback: AsyncCallback): void;
@@ -102,7 +112,8 @@ declare namespace missionManager {
* Clear the given mission in the ability manager service.
*
* @since 8
- * @sysCap SystemCapability.Ability.AbilityRuntime.Mission
+ * @syscap SystemCapability.Ability.AbilityRuntime.Mission
+ * @param missionId Indicates mission id to be cleared.
* @return -
*/
function clearMission(missionId: number, callback: AsyncCallback): void;
@@ -112,7 +123,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 +133,9 @@ declare namespace missionManager {
* Schedule the given mission to foreground.
*
* @since 8
- * @sysCap SystemCapability.Ability.AbilityRuntime.Mission
+ * @syscap SystemCapability.Ability.AbilityRuntime.Mission
+ * @param missionId Indicates mission id to be moved to foreground.
+ * @param options Indicates the start options.
* @return -
*/
function moveMissionToFront(missionId: number, callback: AsyncCallback): void;
diff --git a/api/ability/continueAbilityOptions.d.ts b/api/@ohos.application.testRunner.d.ts
old mode 100755
new mode 100644
similarity index 47%
rename from api/ability/continueAbilityOptions.d.ts
rename to api/@ohos.application.testRunner.d.ts
index 32c09d141425de7df7c76477511658ea6505d8c6..58593017d019b48e98981fd1e5218d61cc7e77c8
--- a/api/ability/continueAbilityOptions.d.ts
+++ b/api/@ohos.application.testRunner.d.ts
@@ -13,30 +13,31 @@
* limitations under the License.
*/
- /**
- * @since 7
- * @sysCap SystemCapability.Ability.AbilityRuntime.Core
+/**
+ * Base class for the test framework.
+ * If you want to implement your own unit test framework, you must inherit this class and overrides all its methods.
+ *
+ * @since 9
+ * @syscap SystemCapability.Ability.AbilityRuntime.Core
+ * @import import TestRunner from '@ohos.application.testRunner'
* @permission N/A
*/
-export interface ContinueAbilityOptions {
- /**
- * Indicates the ID of the target device where this ability will be migrated to.
- *
- * @default -
- * @since 7
- * @sysCap SystemCapability.Ability.AbilityRuntime.Core
- * @FAModelOnly
- */
- deviceId: string;
+export interface TestRunner {
+ /**
+ * Prepare the unit testing environment for running test cases.
+ *
+ * @since 9
+ * @syscap SystemCapability.Ability.AbilityRuntime.Core
+ */
+ onPrepare(): void;
+
+ /**
+ * Run all test cases.
+ *
+ * @since 9
+ * @syscap SystemCapability.Ability.AbilityRuntime.Core
+ */
+ onRun(): void;
+}
- /**
- * Indicates whether the ability to be migrated back to the local device through
- * This is a reserved field.
- *
- * @default -
- * @since 7
- * @sysCap SystemCapability.Ability.AbilityRuntime.Core
- * @FAModelOnly
- */
- reversible?: boolean;
-}
\ No newline at end of file
+export default TestRunner;
\ No newline at end of file
diff --git a/api/@ohos.application.UriPermissionManager.d.ts b/api/@ohos.application.uriPermissionManager.d.ts
similarity index 72%
rename from api/@ohos.application.UriPermissionManager.d.ts
rename to api/@ohos.application.uriPermissionManager.d.ts
index f79c74100803bf19b1987cf5a266b915bff2f50b..37cd85441c8e8f9653759a09967c58e6a360c5be 100644
--- a/api/@ohos.application.UriPermissionManager.d.ts
+++ b/api/@ohos.application.uriPermissionManager.d.ts
@@ -20,20 +20,22 @@ 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
*/
-export default class UriPermissionManager {
+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.
* @return Returns 0 if the verification is successful, otherwise returns -1.
*/
- verifyUriPermission(uri: string, flag: wantConstant.Flags, accessTokenId: number, callback: AsyncCallback): void;
- verifyUriPermission(uri: string, flag: wantConstant.Flags, accessTokenId: number): Promise;
+ function verifyUriPermission(uri: string, flag: wantConstant.Flags, accessTokenId: number, callback: AsyncCallback): void;
+ function verifyUriPermission(uri: string, flag: wantConstant.Flags, accessTokenId: number): Promise;
}
+
+export default uriPermissionManager;
\ No newline at end of file
diff --git a/api/@ohos.batteryinfo.d.ts b/api/@ohos.batteryinfo.d.ts
index a139929f6d85cb3fb8640a99e1fc7d45eabf1762..05b49542cab99d5f5d03e94aee99683880b67428 100644
--- a/api/@ohos.batteryinfo.d.ts
+++ b/api/@ohos.batteryinfo.d.ts
@@ -19,7 +19,7 @@
* Battery information includes the remaining battery power,
* voltage, temperature, model, and charger type.
*
- * @sysCap SystemCapability.PowerManager.BatteryManage.Core
+ * @syscap SystemCapability.PowerManager.BatteryManager.Core
* @since 6
*/
declare namespace batteryInfo {
@@ -74,7 +74,7 @@ declare namespace batteryInfo {
/**
* Indicates the charger type of a device.
*
- * @sysCap SystemCapability.PowerManager.BatteryManage.Core
+ * @syscap SystemCapability.PowerManager.BatteryManager.Core
* @since 6
*/
export enum BatteryPluggedType {
@@ -103,7 +103,7 @@ declare namespace batteryInfo {
/**
* Indicates the battery charging status of a device.
*
- * @sysCap SystemCapability.PowerManager.BatteryManage.Core
+ * @syscap SystemCapability.PowerManager.BatteryManager.Core
* @since 6
*/
export enum BatteryChargeState {
@@ -132,7 +132,7 @@ declare namespace batteryInfo {
/**
* Indicates the battery health status of a device.
*
- * @sysCap SystemCapability.PowerManager.BatteryManage.Core
+ * @syscap SystemCapability.PowerManager.BatteryManager.Core
* @since 6
*/
export enum BatteryHealthState {
diff --git a/api/@ohos.bluetooth.d.ts b/api/@ohos.bluetooth.d.ts
index 155520f1577dba21ce71d391fa7fe83da1f8805c..b3dde1d0f94f8727c4ddc8530bf3bf44bc8dfdf8 100644
--- a/api/@ohos.bluetooth.d.ts
+++ b/api/@ohos.bluetooth.d.ts
@@ -121,6 +121,16 @@ declare namespace bluetooth {
*/
function getPairedDevices(): Array;
+ /**
+ * Obtains the connection state of profile.
+ *
+ * @param profileId The profile id.
+ * @return Returns the connection state.
+ * @since 8
+ * @permission ohos.permission.USE_BLUETOOTH
+ */
+ function getProfileConnState(profileId: ProfileId): ProfileConnectionState;
+
/**
* Sets the confirmation of pairing with a certain device.
*
@@ -336,6 +346,202 @@ declare namespace bluetooth {
*/
function off(type: "sppRead", clientSocket: number, callback?: Callback): void;
+ /**
+ * Obtains the instance of profile.
+ *
+ * @param profileId The profile id..
+ * @return Returns instance of profile.
+ * @since 8
+ */
+ function getProfile(profileId: ProfileId): A2dpSourceProfile | HandsFreeAudioGatewayProfile;
+
+ /**
+ * Base interface of profile.
+ */
+ interface BaseProfile {
+ /**
+ * Obtains the connected devices list of profile.
+ *
+ * @return Returns the address of connected devices list.
+ * @since 8
+ * @permission ohos.permission.USE_BLUETOOTH
+ */
+ getConnectionDevices(): Array;
+
+ /**
+ * Obtains the profile state of device.
+ *
+ * @param device The address of bluetooth device.
+ * @return Returns {@link ProfileConnectionState} of device.
+ * @since 8
+ * @permission ohos.permission.USE_BLUETOOTH
+ */
+ getDeviceState(device: string): ProfileConnectionState;
+ }
+
+ /**
+ * Manager a2dp source profile.
+ */
+ interface A2dpSourceProfile extends BaseProfile {
+ /**
+ * Connect to device with a2dp.
+ *
+ * @param device The address of the remote device to connect.
+ * @return Returns {@code true} if the connect is in process; returns {@code false} otherwise.
+ * @since 8
+ * @permission permission ohos.permission.DISCOVER_BLUETOOTH
+ */
+ connect(device: string): boolean;
+
+ /**
+ * Disconnect to device with a2dp.
+ *
+ * @param device The address of the remote device to disconnect.
+ * @return Returns {@code true} if the disconnect is in process; returns {@code false} otherwise.
+ * @since 8
+ * @permission permission ohos.permission.DISCOVER_BLUETOOTH
+ */
+ disconnect(device: string): boolean;
+
+ /**
+ * Subscribe the event reported when the profile connection state changes .
+ *
+ * @param type Type of the profile connection state changes event to listen for .
+ * @param callback Callback used to listen for event.
+ * @since 8
+ */
+ on(type: "connectionStateChange", callback: Callback): void;
+
+ /**
+ * Unsubscribe the event reported when the profile connection state changes .
+ *
+ * @param type Type of the profile connection state changes event to listen for .
+ * @param callback Callback used to listen for event.
+ * @since 8
+ */
+ off(type: "connectionStateChange", callback?: Callback): void;
+
+ /**
+ * Obtains the playing state of device.
+ *
+ * @param device The address of the remote device.
+ * @return Returns {@link PlayingState} of the remote device.
+ *
+ */
+ getPlayingState(device: string): PlayingState;
+ }
+
+ /**
+ * Manager handsfree AG profile.
+ */
+ interface HandsFreeAudioGatewayProfile extends BaseProfile {
+ /**
+ * Connect to device with hfp.
+ *
+ * @param device The address of the remote device to connect.
+ * @return Returns {@code true} if the connect is in process; returns {@code false} otherwise.
+ * @since 8
+ * @permission permission ohos.permission.DISCOVER_BLUETOOTH
+ */
+ connect(device: string): boolean;
+
+ /**
+ * Disconnect to device with hfp.
+ *
+ * @param device The address of the remote device to disconnect.
+ * @return Returns {@code true} if the disconnect is in process; returns {@code false} otherwise.
+ * @since 8
+ * @permission permission ohos.permission.DISCOVER_BLUETOOTH
+ */
+ disconnect(device: string): boolean;
+
+ /**
+ * Obtains the sco state of device.
+ *
+ * @param device The address of the remote device.
+ * @return Returns {@code true} if the disconnect is in process; returns {@code false} otherwise.
+ * @since 8
+ * @permission permission ohos.permission.USE_BLUETOOTH
+ */
+ getScoState(device: string): number;
+
+ /**
+ * Create audio channel.
+ *
+ * @param device The address of the remote device.
+ * @return Returns {@code true} if the request is in process; returns {@code false} otherwise.
+ * @since 8
+ * @permission permission ohos.permission.DISCOVER_BLUETOOTH
+ */
+ connectSco(device: string): boolean;
+
+ /**
+ * Close audio channel.
+ *
+ * @param device The address of the remote device.
+ * @return Returns {@code true} if the request is in process; returns {@code false} otherwise.
+ * @since 8
+ * @permission permission ohos.permission.DISCOVER_BLUETOOTH
+ */
+ disconnectSco(device: string): boolean;
+
+ /**
+ * Subscribe the event reported when the profile connection state changes .
+ *
+ * @param type Type of the profile connection state changes event to listen for .
+ * @param callback Callback used to listen for event.
+ * @since 8
+ */
+ on(type: "connectionStateChange", callback: Callback): void;
+
+ /**
+ * Unsubscribe the event reported when the profile connection state changes .
+ *
+ * @param type Type of the profile connection state changes event to listen for .
+ * @param callback Callback used to listen for event.
+ * @since 8
+ */
+ off(type: "connectionStateChange", callback?: Callback): void;
+
+ /**
+ * Subscribe the event reported when the sco state changes .
+ *
+ * @param type Type of the profile connection state changes event to listen for .
+ * @param callback Callback used to listen for event.
+ * @since 8
+ */
+ on(type: "scoStateChange", callback: Callback): void;
+
+ /**
+ * Unsubscribe the event reported when the sco state changes .
+ *
+ * @param type Type of the profile connection state changes event to listen for .
+ * @param callback Callback used to listen for event.
+ * @since 8
+ */
+ off(type: "scoStateChange", callback?: Callback): void;
+
+ /**
+ * Open voice recognition function.
+ *
+ * @param device The address of the remote device to disconnect.
+ * @return Returns {@code true} if success; returns {@code false} otherwise.
+ * @since 8
+ * @permission permission ohos.permission.DISCOVER_BLUETOOTH
+ */
+ openVoiceRecognition(device: string): boolean;
+
+ /**
+ * Close voice recognition function.
+ *
+ * @param device The address of the remote device to disconnect.
+ * @return Returns {@code true} if success; returns {@code false} otherwise.
+ * @since 8
+ * @permission permission ohos.permission.DISCOVER_BLUETOOTH
+ */
+ closeVoiceRecognition(device: string): boolean;
+ }
+
namespace BLE {
/**
* create a JavaScript Gatt server instance.
@@ -1306,6 +1512,64 @@ declare namespace bluetooth {
HEALTH_GENERIC_HEALTH_MANAGER = 0x0938,
HEALTH_PERSONAL_MOBILITY_DEVICE = 0x093C,
}
+
+ /**
+ * Profile state change parameters.
+ *
+ * @since 8
+ */
+ interface StateChangeParam {
+ /** The address of device */
+ deviceId: string;
+
+ /** Profile state value */
+ state: ProfileConnectionState;
+ }
+
+ /**
+ * Sco state change parameters.
+ *
+ * @since 8
+ */
+ Interface ScoStateParam {
+ /** The address of device */
+ deviceId: string,
+
+ /** Sco state value */
+ state: ScoState
+ }
+
+ /**
+ * The enum of a2dp playing state.
+ *
+ * @since 8
+ */
+ enum PlayingState {
+ STATE_NOT_PLAYING,
+ STATE_PLAYING,
+ }
+
+ /**
+ * The enum of sco audio state.
+ *
+ * @since 8
+ */
+ enum ScoState {
+ SCO_DISCONNECTED,
+ SCO_CONNECTING,
+ SCO_DISCONNECTING,
+ SCO_CONNECTED
+ }
+
+ /**
+ * The enum of profile id.
+ *
+ * @since 8
+ */
+ enum ProfileId {
+ PROFILE_A2DP_SOURCE = 1,
+ PROFILE_HANDS_FREE_AUDIO_GATEWAY = 4,
+ }
}
export default bluetooth;
diff --git a/api/@ohos.brightness.d.ts b/api/@ohos.brightness.d.ts
index f12bc7a706745b47aa73eda3fb6a1c0ad3745153..bb8b0988049e37d66b524897ad8c45d672ee5326 100644
--- a/api/@ohos.brightness.d.ts
+++ b/api/@ohos.brightness.d.ts
@@ -18,7 +18,7 @@ import { AsyncCallback } from './basic';
/**
* Provides interfaces to control the power of display.
*
- * @sysCap SystemCapability.PowerManager.DisplayPowerManager
+ * @syscap SystemCapability.PowerManager.DisplayPowerManager
* @since 7
*/
declare namespace brightness {
@@ -26,7 +26,6 @@ declare namespace brightness {
* Sets the screen brightness.
*
* @param value Brightness value, ranging from 0 to 255.
- * @sysCap SystemCapability.PowerManager.DisplayPowerManager
* @systemapi
* @since 7
*/
diff --git a/api/@ohos.bundle.d.ts b/api/@ohos.bundle.d.ts
index 8d2be229f4907e7bfdafb13592a25f9d9f47a9b2..efe17b4b64240357af10d9f8d189a60dea3bbdfe 100644
--- a/api/@ohos.bundle.d.ts
+++ b/api/@ohos.bundle.d.ts
@@ -20,9 +20,9 @@ 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';
+import image from './@ohos.multimedia.image';
/**
* bundle.
@@ -384,6 +384,19 @@ declare namespace bundle {
*/
function getBundleInstaller(callback: AsyncCallback): void;
function getBundleInstaller(): Promise;
+
+ /**
+ * Obtains information about the current ability.
+ *
+ * @since 7
+ * @syscap SystemCapability.BundleManager.BundleFramework
+ * @param bundleName Indicates the application bundle name to be queried.
+ * @param abilityName Indicates the ability name.
+ * @return Returns the AbilityInfo object for the current ability.
+ * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED, ohos.permission.GET_BUNDLE_INFO
+ */
+ function getAbilityInfo(bundleName: string, abilityName: string, callback: AsyncCallback): void;
+ function getAbilityInfo(bundleName: string, abilityName: string): Promise;
/**
* Obtains based on a given bundle name.
@@ -393,12 +406,13 @@ declare namespace bundle {
* @param bundleName Indicates the application bundle name to be queried.
* @param bundleFlags Indicates the flag used to specify information contained in the ApplicationInfo object
* that will be returned.
- * @param userId Indicates the user ID.
+ * @param userId Indicates the user ID or do not pass user ID.
* @return Returns the ApplicationInfo object.
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED, ohos.permission.GET_BUNDLE_INFO
*/
function getApplicationInfo(bundleName: string, bundleFlags: number, userId: number, callback: AsyncCallback) : void;
- function getApplicationInfo(bundleName: string, bundleFlags: number, userId: number) : Promise;
+ function getApplicationInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback) : void;
+ function getApplicationInfo(bundleName: string, bundleFlags: number, userId?: number) : Promise;
/**
* Query the AbilityInfo by the given Want.
@@ -439,12 +453,13 @@ declare namespace bundle {
* @syscap SystemCapability.BundleManager.BundleFramework
* @param bundleFlags Indicates the flag used to specify information contained in the ApplicationInfo objects
* that will be returned.
- * @param userId Indicates the user ID.
+ * @param userId Indicates the user ID or do not pass user ID.
* @return Returns a list of ApplicationInfo objects.
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
*/
function getAllApplicationInfo(bundleFlags: number, userId: number, callback: AsyncCallback>) : void;
- function getAllApplicationInfo(bundleFlags: number, userId: number) : Promise>;
+ function getAllApplicationInfo(bundleFlags: number, callback: AsyncCallback>) : void;
+ function getAllApplicationInfo(bundleFlags: number, userId?: number) : Promise>;
/**
* Obtains bundle name by the given uid.
@@ -467,12 +482,11 @@ declare namespace bundle {
* @param bundleFlags Indicates the flag used to specify information contained in the BundleInfo object to be
* returned.
* @return Returns the BundleInfo object.
+ * @systemapi Hide this for inner system use
*/
function getBundleArchiveInfo(hapFilePath: string, bundleFlags: number, callback: AsyncCallback) : void
function getBundleArchiveInfo(hapFilePath: string, bundleFlags: number) : Promise;
- /**
-
/**
* Obtains the Want for starting the main ability of an application based on the
* given bundle name. The main ability of an application is the ability that has the
@@ -489,18 +503,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.
*
@@ -582,6 +584,54 @@ declare namespace bundle {
*/
function getPermissionDef(permissionName: string, callback: AsyncCallback): void;
function getPermissionDef(permissionName: string): Promise;
+
+ /**
+ * Obtains the label of a specified ability.
+ *
+ * @since 8
+ * @syscap SystemCapability.BundleManager.BundleFramework
+ * @param bundleName Indicates the bundle name of the application to which the ability belongs.
+ * @param abilityName Indicates the ability name.
+ * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
+ * @return Returns the label representing the label of the specified ability.
+ */
+ function getAbilityLabel(bundleName: string, abilityName: string, callback: AsyncCallback): void;
+ function getAbilityLabel(bundleName: string, abilityName: string): Promise;
+
+ /**
+ * Obtains the icon of a specified ability.
+ *
+ * @since 8
+ * @syscap SystemCapability.BundleManager.BundleFramework
+ * @param bundleName Indicates the bundle name of the application to which the ability belongs.
+ * @param abilityName Indicates the ability name.
+ * @return Returns the PixelMap object representing the icon of the specified ability.
+ * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
+ */
+ function getAbilityIcon(bundleName: string, abilityName: string, callback: AsyncCallback): void;
+ function getAbilityIcon(bundleName: string, abilityName: string): Promise;
+
+ /**
+ * Checks whether a specified ability is enabled.
+ *
+ * @since 8
+ * @syscap SystemCapability.BundleManager.BundleFramework
+ * @param info Indicates information about the ability to check.
+ * @returns Returns true if the ability is enabled; returns false otherwise.
+ */
+ function isAbilityEnabled(info: AbilityInfo, callback: AsyncCallback): void;
+ function isAbilityEnabled(info: AbilityInfo): Promise;
+
+ /**
+ * Checks whether a specified application is enabled.
+ *
+ * @since 8
+ * @syscap SystemCapability.BundleManager.BundleFramework
+ * @param bundleName Indicates the bundle name of the application.
+ * @returns Returns true if the application is enabled; returns false otherwise.
+ */
+ function isApplicationEnabled(bundleName: string, callback: AsyncCallback): void;
+ function isApplicationEnabled(bundleName: string): Promise;
}
export default bundle;
diff --git a/api/@ohos.bundleState.d.ts b/api/@ohos.bundleState.d.ts
new file mode 100644
index 0000000000000000000000000000000000000000..0734372b77c45a6e0346c9da414c196ed23e4d51
--- /dev/null
+++ b/api/@ohos.bundleState.d.ts
@@ -0,0 +1,249 @@
+/*
+ * 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
+ *
+ * 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';
+
+/**
+ * Provides methods for managing bundle usage statistics,
+ * including the methods for querying bundle usage information and state data.
+ *
+ * You can use the methods defined in this class to query
+ * the usage history and states of bundles in a specified period.
+ * The system stores the query result in a {@link BundleStateInfo} or {@link BundleActiveState} instance and
+ * then returns it to you.
+ *
+ * @since 7
+ */
+declare namespace bundleState {
+
+ /**
+ * @since 7
+ * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
+ */
+ interface BundleStateInfo {
+ /**
+ * the identifier of BundleStateInfo.
+ */
+ id: number;
+ /**
+ * the total duration, in milliseconds.
+ */
+ abilityInFgTotalTime?: number;
+ /**
+ * the last time when the application was accessed, in milliseconds.
+ */
+ abilityPrevAccessTime?: number;
+ /**
+ * the last time when the application was visible in the foreground, in milliseconds.
+ */
+ abilityPrevSeenTime?: number;
+ /**
+ * the total duration, in milliseconds.
+ */
+ abilitySeenTotalTime?: number;
+ /**
+ * the bundle name of the application.
+ */
+ bundleName?: string;
+ /**
+ * the total duration, in milliseconds.
+ */
+ fgAbilityAccessTotalTime?: number;
+ /**
+ * the last time when the foreground application was accessed, in milliseconds.
+ */
+ fgAbilityPrevAccessTime?: number;
+ /**
+ * the time of the first bundle usage record in this {@code BundleActiveInfo} object,
+ * in milliseconds.
+ */
+ infosBeginTime?: number;
+ /**
+ * the time of the last bundle usage record in this {@code BundleActiveInfo} object,
+ * in milliseconds.
+ */
+ infosEndTime?: number;
+
+ /**
+ * Merges a specified {@link BundleActiveInfo} object with this {@link BundleActiveInfo} object.
+ * The bundle name of both objects must be the same.
+ *
+ * @since 7
+ * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
+ * @param toMerge Indicates the {@link BundleActiveInfo} object to merge.
+ * if the bundle names of the two {@link BundleActiveInfo} objects are different.
+ */
+ merge(toMerge: BundleStateInfo): void;
+ }
+
+ /**
+ * @since 7
+ * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
+ */
+ interface BundleActiveState {
+ /**
+ * the usage priority group of the application.
+ */
+ appUsagePriorityGroup?: number;
+ /**
+ * the bundle name.
+ */
+ bundleName?: string;
+ /**
+ * the shortcut ID.
+ */
+ indexOfLink?: string;
+ /**
+ * the class name.
+ */
+ nameOfClass?: string;
+ /**
+ * the time when this state occurred, in milliseconds.
+ */
+ stateOccurredTime?: number;
+ /**
+ * the state type.
+ */
+ stateType?: number;
+ }
+
+ /**
+ * Checks whether the application with a specified bundle name is in the idle state.
+ *
+ * @since 7
+ * @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
+ * @param bundleName Indicates the bundle name of the application to query.
+ * @return Returns {@code true} if the application is idle in a particular period;
+ * returns {@code false} otherwise. The time range of the particular period is defined by the system,
+ * which may be hours or days.
+ */
+ function isIdleState(bundleName: string, callback: AsyncCallback): void;
+ function isIdleState(bundleName: string): Promise;
+
+ /**
+ * Queries the usage priority group of the calling application.
+ *
+ * The priority defined in a priority group restricts the resource usage of an application,
+ * for example, restricting the running of background tasks.
+ *
+ * @since 7
+ * @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
+ * @return Returns the usage priority group of the calling application.
+ */
+ function queryAppUsagePriorityGroup(callback: AsyncCallback): void;
+ function queryAppUsagePriorityGroup(): Promise;
+
+ /**
+ * @since 7
+ * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
+ */
+ interface BundleActiveInfoResponse {
+ [key: string]: BundleStateInfo;
+ }
+
+ /**
+ * Queries usage information about each bundle within a specified period.
+ *
+ * This method queries usage information at the {@link #BY_OPTIMIZED} interval by default.
+ *
+ * @since 7
+ * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
+ * @permission ohos.permission.BUNDLE_ACTIVE_INFO
+ * @systemapi Hide this for inner system use.
+ * @param begin Indicates the start time of the query period, in milliseconds.
+ * @param end Indicates the end time of the query period, in milliseconds.
+ * @return Returns the {@link BundleActiveInfoResponse} objects containing the usage information about each bundle.
+ */
+ function queryBundleStateInfos(begin: number, end: number, callback: AsyncCallback): void;
+ function queryBundleStateInfos(begin: number, end: number): Promise;
+
+ /**
+ * Declares interval type.
+ *
+ * @since 7
+ * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
+ */
+ export enum IntervalType {
+ /**
+ * Indicates the interval type that will determine the optimal interval based on the start and end time.
+ */
+ BY_OPTIMIZED = 0,
+
+ /**
+ * Indicates the daily interval.
+ */
+ BY_DAILY = 1,
+
+ /**
+ * Indicates the weekly interval.
+ */
+ BY_WEEKLY = 2,
+
+ /**
+ * Indicates the monthly interval.
+ */
+ BY_MONTHLY = 3,
+
+ /**
+ * Indicates the annually interval.
+ */
+ BY_ANNUALLY = 4
+ }
+
+ /**
+ * Queries usage information about each bundle within a specified period at a specified interval.
+ *
+ * @since 7
+ * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
+ * @permission ohos.permission.BUNDLE_ACTIVE_INFO
+ * @systemapi Hide this for inner system use.
+ * @param byInterval Indicates the interval at which the usage statistics are queried.
+ * The value can be {@link #BY_OPTIMIZED}, {@link #BY_DAILY},
+ * {@link #BY_WEEKLY}, {@link #BY_MONTHLY}, or {@link #BY_ANNUALLY}.
+ * @param begin Indicates the start time of the query period, in milliseconds.
+ * @param end Indicates the end time of the query period, in milliseconds.
+ * @return Returns the list of {@link BundleStateInfo} objects containing the usage information about each bundle.
+ */
+ function queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: number, callback: AsyncCallback>): void;
+ function queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: number): Promise>;
+
+ /**
+ * Queries state data of all bundles within a specified period identified by the start and end time.
+ *
+ * @since 7
+ * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
+ * @permission ohos.permission.BUNDLE_ACTIVE_INFO
+ * @systemapi Hide this for inner system use.
+ * @param begin Indicates the start time of the query period, in milliseconds.
+ * @param end Indicates the end time of the query period, in milliseconds.
+ * @return Returns the list of {@link BundleActiveState} objects containing the state data of all bundles.
+ */
+ function queryBundleActiveStates(begin: number, end: number, callback: AsyncCallback>): void;
+ function queryBundleActiveStates(begin: number, end: number): Promise>;
+
+ /**
+ * Queries state data of the current bundle within a specified period.
+ *
+ * @since 7
+ * @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
+ * @param begin Indicates the start time of the query period, in milliseconds.
+ * @param end Indicates the end time of the query period, in milliseconds.
+ * @return Returns the {@link BundleActiveState} object Array containing the state data of the current bundle.
+ */
+ function queryCurrentBundleActiveStates(begin: number, end: number, callback: AsyncCallback>): void;
+ function queryCurrentBundleActiveStates(begin: number, end: number): Promise>;
+}
+
+export default bundleState;
\ No newline at end of file
diff --git a/api/@ohos.commonEvent.d.ts b/api/@ohos.commonEvent.d.ts
index e9b04424dc98e1dddef6814796df654253435606..f6a59b218ee165e505f7d5d10e5377df6ffa9614 100644
--- a/api/@ohos.commonEvent.d.ts
+++ b/api/@ohos.commonEvent.d.ts
@@ -170,6 +170,12 @@ declare namespace commonEvent {
*/
COMMON_EVENT_SCREEN_ON = "usual.event.SCREEN_ON",
+ /**
+ * this commonEvent means when the thermal state level change
+ * @since 8
+ */
+ COMMON_EVENT_THERMAL_LEVEL_CHANGED = "usual.event.THERMAL_LEVEL_CHANGED",
+
/**
* this commonEvent means when the user is present after the device waked up.
*/
@@ -890,35 +896,35 @@ declare namespace commonEvent {
/**
* The external storage was removed.
* This is a protected common event that can only be sent by system.
- * @since 8
+ * @since 9
*/
COMMON_EVENT_VOLUME_REMOVED = "usual.event.data.VOLUME_REMOVED",
/**
* The external storage was unmounted.
* This is a protected common event that can only be sent by system.
- * @since 8
+ * @since 9
*/
COMMON_EVENT_VOLUME_UNMOUNTED = "usual.event.data.VOLUME_UNMOUNTED",
/**
* The external storage was mounted.
* This is a protected common event that can only be sent by system.
- * @since 8
+ * @since 9
*/
COMMON_EVENT_VOLUME_MOUNTED = "usual.event.data.VOLUME_MOUNTED",
/**
* The external storage was bad removal.
* This is a protected common event that can only be sent by system.
- * @since 8
+ * @since 9
*/
COMMON_EVENT_VOLUME_BAD_REMOVAL = "usual.event.data.VOLUME_BAD_REMOVAL",
/**
* The external storage was eject.
* This is a protected common event that can only be sent by system.
- * @since 8
+ * @since 9
*/
COMMON_EVENT_VOLUME_EJECT = "usual.event.data.VOLUME_EJECT",
diff --git a/api/@ohos.configPolicy.d.ts b/api/@ohos.configPolicy.d.ts
index 32ef672ca08824e798623f0eccb68857b4f4b5f3..d12690c30faca84069c5fedcbef457ed789f20f1 100644
--- a/api/@ohos.configPolicy.d.ts
+++ b/api/@ohos.configPolicy.d.ts
@@ -19,7 +19,7 @@ import {AsyncCallback} from "./basic";
* Provides file path related APIS.
*
* @since 8
- * @sysCap SystemCapability.Customization.ConfigPolicy
+ * @syscap SystemCapability.Customization.ConfigPolicy
*/
declare namespace configPolicy {
/**
@@ -27,7 +27,7 @@ declare namespace configPolicy {
*
* @since 8
* @systemapi Hide this for inner system use.
- * @sysCap SystemCapability.Customization.ConfigPolicy
+ * @syscap SystemCapability.Customization.ConfigPolicy
* @param relPath the relative path of the config file.
* @return Returns the path of the highest priority config file.
*/
@@ -39,7 +39,7 @@ declare namespace configPolicy {
*
* @since 8
* @systemapi Hide this for inner system use.
- * @sysCap SystemCapability.Customization.ConfigPolicy
+ * @syscap SystemCapability.Customization.ConfigPolicy
* @param relPath the relative path of the config file.
* @return Returns paths of config files.
*/
@@ -51,7 +51,7 @@ declare namespace configPolicy {
*
* @since 8
* @systemapi Hide this for inner system use.
- * @sysCap SystemCapability.Customization.ConfigPolicy
+ * @syscap SystemCapability.Customization.ConfigPolicy
* @return Returns paths of config directories.
*/
function getCfgDirList(callback: AsyncCallback>);
diff --git a/api/ohos.contact.d.ts b/api/@ohos.contact.d.ts
similarity index 100%
rename from api/ohos.contact.d.ts
rename to api/@ohos.contact.d.ts
diff --git a/api/@ohos.curves.d.ts b/api/@ohos.curves.d.ts
index 1ffd9819ad5008827d0a5ed60c7d78f796165608..e3a377d6cea5acb289960fa17e9223cf55a1d2f8 100644
--- a/api/@ohos.curves.d.ts
+++ b/api/@ohos.curves.d.ts
@@ -16,13 +16,12 @@
/**
* Contains interpolator functions such as initialization, third-order Bezier curves, and spring curves.
* @import import Curves from '@ohos.curves'
- * @devices phone, tablet, tv, wearable
+ * @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
declare namespace curves {
/**
* enum Curve.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
enum Curve {
@@ -43,28 +42,24 @@ declare namespace curves {
/**
* Initializes the interpolator curve when called.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
function init(curve?: Curve): string;
/**
* Constructs a step curve when called.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
function steps(count: number, end: boolean): string;
/**
* Constructs a third-order Bezier curve when called.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
function cubicBezier(x1: number, y1: number, x2: number, y2: number): string;
/**
* Constructs a spring curve when called.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
function spring(velocity: number, mass: number, stiffness: number, damping: number): string;
diff --git a/api/@ohos.data.preferences.d.ts b/api/@ohos.data.preferences.d.ts
new file mode 100644
index 0000000000000000000000000000000000000000..000599ed5d287eb42bd8ea5e9894562ac7905021
--- /dev/null
+++ b/api/@ohos.data.preferences.d.ts
@@ -0,0 +1,199 @@
+/*
+* 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
+*
+* 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';
+import Context from "./application/Context";
+
+/**
+ * Provides interfaces to obtain and modify preferences data.
+ *
+ * @name preferences
+ * @since 9
+ * @syscap SystemCapability.DistributedDataManager.Preferences.Core
+ *
+ */
+declare namespace preferences {
+ /**
+ * Obtains a {@link Preferences} instance matching a specified preferences file name.
+ *
+ * The {@link references} instance loads all data of the preferences file and
+ * resides in the memory. You can use removePreferencesFromCache to remove the instance from the memory.
+ *
+ * @param context Indicates the context of application or capability.
+ * @param name Indicates the preferences file name.
+ * @return Returns the {@link Preferences} instance matching the specified preferences file name.
+ * @throws BusinessError if invoked failed
+ * @since 9
+ */
+ function getPreferences(context: Context, name: string, callback: AsyncCallback): void;
+ function getPreferences(context: Context, name: string): Promise;
+
+ /**
+ * Deletes a {@link Preferences} instance matching a specified preferences file name
+ * from the cache which is performed by removePreferencesFromCache and deletes the
+ * preferences file.
+ *
+ * When deleting the {@link Preferences} instance, you must release all references
+ * of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
+ * will occur.
+ *
+ * @param context Indicates the context of application or capability.
+ * @param name Indicates the preferences file name.
+ * @throws BusinessError if invoked failed
+ * @since 9
+ */
+ function deletePreferences(context: Context, name: string, callback: AsyncCallback): void;
+ function deletePreferences(context: Context, name: string): Promise;
+
+ /**
+ * Deletes a {@link Preferences} instance matching a specified preferences file name
+ * from the cache.
+ *
+ * When deleting the {@link Preferences} instance, you must release all references
+ * of the instance. In addition, do not use the instance to perform data operations. Otherwise, data inconsistency
+ * will occur.
+ *
+ * @param context Indicates the context of application or capability.
+ * @param name Indicates the preferences file name.
+ * @throws BusinessError if invoked failed
+ * @since 9
+ */
+ function removePreferencesFromCache(context: Context, name: string, callback: AsyncCallback): void;
+ function removePreferencesFromCache(context: Context, name: string): Promise;
+
+ /**
+ * Provides interfaces to obtain and modify preferences data.
+ *
+ * The preferences data is stored in a file, which matches only one {@link Preferences} instance in the memory.
+ * You can use getPreferences to obtain the {@link Preferences} instance matching
+ * the file that stores preferences data, and use emovePreferencesFromCache
+ * to remove the {@link Preferences} instance from the memory.
+ *
+ * @syscap SystemCapability.DistributedDataManager.Preferences.Core
+ *
+ * @since 9
+ */
+ interface Preferences {
+ /**
+ * Obtains the value of a preferences in the int format.
+ *
+ *
If the value is {@code null} or not in the int format, the default value is returned.
+ *
+ * @param key Indicates the key of the preferences. It cannot be {@code null} or empty.
+ * @param defValue Indicates the default value to return.
+ * @return Returns the value matching the specified key if it is found; returns the default value otherwise.
+ * @throws BusinessError if invoked failed
+ * @since 9
+ */
+ get(key: string, defValue: ValueType, callback: AsyncCallback): void;
+ get(key: string, defValue: ValueType): Promise;
+
+ /**
+ * Checks whether the {@link Preferences} object contains a preferences matching a specified key.
+ *
+ * @param key Indicates the key of the preferences to check for.
+ * @return Returns {@code true} if the {@link Preferences} object contains a preferences with the specified key;
+ * returns {@code false} otherwise.
+ * @throws BusinessError if invoked failed
+ * @since 9
+ */
+ has(key: string, callback: AsyncCallback): boolean;
+ has(key: string): Promise;
+
+ /**
+ * Sets an int value for the key in the {@link Preferences} object.
+ *
+ * You can call the {@link #flush} method to save the {@link Preferences} object to the
+ * file.
+ *
+ * @param key Indicates the key of the preferences to modify. It cannot be {@code null} or empty.
+ * @param value Indicates the value of the preferences.
+ * MAX_KEY_LENGTH.
+ * @throws BusinessError if invoked failed
+ * @since 9
+ */
+ put(key: string, value: ValueType, callback: AsyncCallback): void;
+ put(key: string, value: ValueType): Promise;
+
+ /**
+ * Deletes the preferences with a specified key from the {@link Preferences} object.
+ *
+ * You can call the {@link #flush} method to save the {@link Preferences} object to the
+ * file.
+ *
+ * @param key Indicates the key of the preferences to delete. It cannot be {@code null} or empty.
+ * MAX_KEY_LENGTH.
+ * @throws BusinessError if invoked failed
+ * @since 9
+ */
+ delete(key: string, callback: AsyncCallback): void;
+ delete(key: string): Promise;
+
+ /**
+ * Clears all preferences from the {@link Preferences} object.
+ *
+ * You can call the {@link #flush} method to save the {@link Preferences} object to the
+ * file.
+ *
+ * @throws BusinessError if invoked failed
+ * @since 9
+ */
+ clear(callback: AsyncCallback): void;
+ clear(): Promise;
+
+ /**
+ * Asynchronously saves the {@link Preferences} object to the file.
+ *
+ * @throws BusinessError if invoked failed
+ * @since 9
+ */
+ flush(callback: AsyncCallback): void;
+ flush(): Promise;
+
+ /**
+ * Registers an observer to listen for the change of a {@link Preferences} object.
+ *
+ * @param callback Indicates the callback when preferences changes.
+ * @throws BusinessError if invoked failed
+ * @since 9
+ */
+ on(type: 'change', callback: Callback<{ key: string }>): void;
+
+ /**
+ * Unregisters an existing observer.
+ *
+ * @param callback Indicates the registered callback.
+ * @throws BusinessError if invoked failed
+ * @since 9
+ */
+ off(type: 'change', callback: Callback<{ key: string }>): void;
+ }
+
+ /**
+ * Indicates possible value types
+ */
+ type ValueType = number | string | boolean;
+
+ /**
+ * Indicates the maximum length of a key (80 characters).
+ */
+ const MAX_KEY_LENGTH: 80;
+
+ /**
+ * Indicates the maximum length of a string (8192 characters).
+ */
+ const MAX_VALUE_LENGTH: 8192;
+}
+
+export default preferences;
diff --git a/api/@ohos.data.rdb.d.ts b/api/@ohos.data.rdb.d.ts
index 4ddeecdf177a887cb10cf35f5aa131096f819ea4..e2317b1d94dc98aa1d913bd02426d9f652662a84 100644
--- a/api/@ohos.data.rdb.d.ts
+++ b/api/@ohos.data.rdb.d.ts
@@ -32,7 +32,7 @@ declare namespace rdb {
* to obtain a rdb store.
*
* @note N/A
- * @since 8
+ * @since 7
* @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
* @param context Indicates the context of application or capability.
* @param config Indicates the configuration of the database related to this RDB store. The configurations include
@@ -47,7 +47,7 @@ declare namespace rdb {
* Deletes the database with a specified name.
*
* @note N/A
- * @since 8
+ * @since 7
* @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
* @param context Indicates the context of application or capability.
* @param name Indicates the database name.
@@ -240,7 +240,7 @@ declare namespace rdb {
* @param device Indicates the remote device.
* @param table Indicates the local table name.
* @return the distributed table name.
-
+
*/
obtainDistributedTableName(device: string, table: string, callback: AsyncCallback): void;
obtainDistributedTableName(device: string, table: string): Promise;
@@ -254,7 +254,7 @@ declare namespace rdb {
* @param mode Indicates the synchronization mode. The value can be PUSH, PULL.
* @param predicates Constraint synchronized data and devices.
* @param callback Indicates the callback used to send the synchronization result to the caller.
-
+
*/
sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback>): void;
sync(mode: SyncMode, predicates: RdbPredicates): Promise>;
diff --git a/api/@ohos.data.storage.d.ts b/api/@ohos.data.storage.d.ts
index 10190d3808fe2cdc1d4ab1e511c6181f537527a5..e0d4107e06d10319817f9d4e264863eb28240f50 100644
--- a/api/@ohos.data.storage.d.ts
+++ b/api/@ohos.data.storage.d.ts
@@ -18,9 +18,10 @@ import { AsyncCallback, Callback } from './basic';
* Provides interfaces to obtain and modify storage data.
*
* @name storage
- * @since 5
+ * @since 6
+ * @deprecated since 9, please use @ohos.data.preferences instead.
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
- *
+ *
*/
declare namespace storage {
/**
@@ -32,8 +33,10 @@ declare namespace storage {
* @param path Indicates the path of storage file stored.
* @return Returns the {@link Storage} instance matching the specified storage file name.
* @throws BusinessError if invoked failed
- * @since 5
+ * @since 6
+ * @deprecated since 9, please use @ohos.data.preferences instead.
*/
+
function getStorageSync(path: string): Storage;
function getStorage(path: string, callback: AsyncCallback): void;
function getStorage(path: string): Promise;
@@ -49,7 +52,8 @@ declare namespace storage {
*
* @param path Indicates the path of storage file
* @throws BusinessError if invoked failed
- * @since 5
+ * @since 6
+ * @deprecated since 9, please use @ohos.data.preferences instead.
*/
function deleteStorageSync(path: string): void;
function deleteStorage(path: string, callback: AsyncCallback): void;
@@ -65,7 +69,8 @@ declare namespace storage {
*
* @param path Indicates the path of storage file.
* @throws BusinessError if invoked failed
- * @since 5
+ * @since 6
+ * @deprecated since 9, please use @ohos.data.preferences instead.
*/
function removeStorageFromCacheSync(path: string): void;
function removeStorageFromCache(path: string, callback: AsyncCallback): void;
@@ -80,8 +85,9 @@ declare namespace storage {
* to remove the {@link Storage} instance from the memory.
*
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
- *
- * @since 5
+ *
+ * @since 6
+ * @deprecated since 9, please use @ohos.data.preferences instead.
*/
interface Storage {
/**
@@ -93,7 +99,8 @@ declare namespace storage {
* @param defValue Indicates the default value to return.
* @return Returns the value matching the specified key if it is found; returns the default value otherwise.
* @throws BusinessError if invoked failed
- * @since 5
+ * @since 6
+ * @deprecated since 9, please use @ohos.data.preferences instead.
*/
getSync(key: string, defValue: ValueType): ValueType;
get(key: string, defValue: ValueType, callback: AsyncCallback): void;
@@ -106,7 +113,8 @@ declare namespace storage {
* @return Returns {@code true} if the {@link Storage} object contains a storage with the specified key;
* returns {@code false} otherwise.
* @throws BusinessError if invoked failed
- * @since 5
+ * @since 6
+ * @deprecated since 9, please use @ohos.data.preferences instead.
*/
hasSync(key: string): boolean;
has(key: string, callback: AsyncCallback): boolean;
@@ -122,7 +130,8 @@ declare namespace storage {
* @param value Indicates the value of the storage.
* MAX_KEY_LENGTH.
* @throws BusinessError if invoked failed
- * @since 5
+ * @since 6
+ * @deprecated since 9, please use @ohos.data.preferences instead.
*/
putSync(key: string, value: ValueType): void;
put(key: string, value: ValueType, callback: AsyncCallback): void;
@@ -137,7 +146,8 @@ declare namespace storage {
* @param key Indicates the key of the storage to delete. It cannot be {@code null} or empty.
* MAX_KEY_LENGTH.
* @throws BusinessError if invoked failed
- * @since 5
+ * @since 6
+ * @deprecated since 9, please use @ohos.data.preferences instead.
*/
deleteSync(key: string): void;
delete(key: string, callback: AsyncCallback): void;
@@ -150,7 +160,8 @@ declare namespace storage {
* file.
*
* @throws BusinessError if invoked failed
- * @since 5
+ * @since 6
+ * @deprecated since 9, please use @ohos.data.preferences instead.
*/
clearSync(): void;
clear(callback: AsyncCallback): void;
@@ -160,7 +171,8 @@ declare namespace storage {
* Asynchronously saves the {@link Storage} object to the file.
*
* @throws BusinessError if invoked failed
- * @since 5
+ * @since 6
+ * @deprecated since 9, please use @ohos.data.preferences instead.
*/
flushSync(): void;
flush(callback: AsyncCallback): void;
@@ -171,7 +183,8 @@ declare namespace storage {
*
* @param callback Indicates the callback when storage changes.
* @throws BusinessError if invoked failed
- * @since 5
+ * @since 6
+ * @deprecated since 9, please use @ohos.data.preferences instead.
*/
on(type: 'change', callback: Callback): void;
@@ -180,7 +193,8 @@ declare namespace storage {
*
* @param callback Indicates the registered callback.
* @throws BusinessError if invoked failed
- * @since 5
+ * @since 6
+ * @deprecated since 9, please use @ohos.data.preferences instead.
*/
off(type: 'change', callback: Callback): void;
}
@@ -194,8 +208,9 @@ declare namespace storage {
* Define the change data information object.
*
* @syscap SystemCapability.DistributedDataManager.Preferences.Core
- *
- * @since 5
+ *
+ * @since 6
+ * @deprecated since 9, please use @ohos.data.preferences instead.
*/
interface StorageObserver {
/**
@@ -215,4 +230,4 @@ declare namespace storage {
const MAX_VALUE_LENGTH: 8192;
}
-export default storage;
\ No newline at end of file
+export default storage;
diff --git a/api/@ohos.deviceInfo.d.ts b/api/@ohos.deviceInfo.d.ts
index 18cca631741489f9a1ba67241cfafc5ef11ecdc4..8e91729a901cf1b776dfa7611728b7a507c71410 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.display.d.ts b/api/@ohos.display.d.ts
new file mode 100644
index 0000000000000000000000000000000000000000..024a10daef116b2e7106cb3ebb8439430354318b
--- /dev/null
+++ b/api/@ohos.display.d.ts
@@ -0,0 +1,171 @@
+/*
+* 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';
+
+/**
+ * interface of display manager
+ * @syscap SystemCapability.WindowManager.WindowManager.Core
+ * @since 7
+ */
+declare namespace display {
+ /**
+ * get the default display
+ * @since 7
+ */
+ function getDefaultDisplay(callback: AsyncCallback): void;
+
+ /**
+ * get the default display
+ * @since 7
+ */
+ function getDefaultDisplay(): Promise;
+
+ /**
+ * get all displays
+ * @since 7
+ */
+ function getAllDisplay(callback: AsyncCallback>): void;
+
+ /**
+ * get all displays
+ * @since 7
+ */
+ function getAllDisplay(): Promise>;
+
+ /**
+ * register the callback of display change
+ * @param type: type of callback
+ * @since 7
+ */
+ function on(type: 'add' | 'remove' | 'change', callback: Callback): void;
+
+ /**
+ * unregister the callback of display change
+ * @param type: type of callback
+ * @since 7
+ */
+ function off(type: 'add' | 'remove' | 'change', callback?: Callback): void;
+
+ /**
+ * the state of display
+ * @syscap SystemCapability.WindowManager.WindowManager.Core
+ * @since 7
+ */
+ enum DisplayState {
+ /**
+ * unknown
+ */
+ STATE_UNKNOWN = 0,
+ /**
+ * screen off
+ */
+ STATE_OFF,
+ /**
+ * screen on
+ */
+ STATE_ON,
+ /**
+ * doze, but it will update for some important system messages
+ */
+ STATE_DOZE,
+ /**
+ * doze and not update
+ */
+ STATE_DOZE_SUSPEND,
+ /**
+ * VR node
+ */
+ STATE_VR,
+ /**
+ * screen on and not update
+ */
+ STATE_ON_SUSPEND,
+ }
+
+ /**
+ * Properties of display, it couldn't update automatically
+ * @syscap SystemCapability.WindowManager.WindowManager.Core
+ * @since 7
+ */
+ interface Display {
+ /**
+ * display id
+ */
+ id: number;
+
+ /**
+ * display name
+ */
+ name: string;
+
+ /**
+ * the display is alive
+ */
+ alive: boolean;
+
+ /**
+ * the state of display
+ */
+ state: DisplayState;
+
+ /**
+ * refresh rate, unit: Hz
+ */
+ refreshRate: number;
+
+ /**
+ * the rotation degrees of the display
+ */
+ rotation: number;
+
+ /**
+ * the width of display, unit: pixel
+ */
+ width: number;
+
+ /**
+ * the height of display, unit: pixel
+ */
+ height: number;
+
+ /**
+ * indicates the display resolution.
+ */
+ densityDPI: number;
+
+ /**
+ * indicates the display density in pixels. The value of a low-resolution display is 1.0
+ */
+ densityPixels: number;
+
+ /**
+ * indicates the text scale density of a display.
+ */
+ scaledDensity: number;
+
+ /**
+ * the DPI on X-axis.
+ */
+ xDPI: number;
+
+ /**
+ * the DPI on Y-axis.
+ */
+ yDPI: number;
+ }
+}
+
+export default display;
\ No newline at end of file
diff --git a/api/@ohos.distributedBundle.d.ts b/api/@ohos.distributedBundle.d.ts
index 90aef0113a27acab1b229dbcdb05bfc4fa8bf73a..e9fea81850f660acc8f9a24d55b3d5006c313f54 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;
diff --git a/api/@ohos.fileManager.d.ts b/api/@ohos.fileManager.d.ts
index f6df405e7ed3a6456173db27dc557aa37e8ff197..5486431568c4f16b31bffd1884068eca9dc6e903 100644
--- a/api/@ohos.fileManager.d.ts
+++ b/api/@ohos.fileManager.d.ts
@@ -30,7 +30,7 @@ declare namespace filemanager {
*
* @note N/A
* @syscap SystemCapability.FileManagement.FileManagerService
- * @since 8
+ * @since 9
* @permission N/A
* @function listFile
* @param {string} path - path.
@@ -51,7 +51,7 @@ declare function listFile(path: string, type: string, options?: {dev?: DevInfo,
*
* @note N/A
* @syscap SystemCapability.FileManagement.FileManagerService
- * @since 8
+ * @since 9
* @permission N/A
* @function getRoot
* @param {Object} options - options
@@ -68,7 +68,7 @@ declare function getRoot(options?: {dev?: DevInfo}, callback: AsyncCallback) : void;
@@ -290,14 +290,14 @@ declare namespace geolocation {
* satellite status information
*
* @since 8
- * @SysCap SystemCapability.Location.Location.Gnss
+ * @syscap SystemCapability.Location.Location.Gnss
* @permission ohos.permission.LOCATION
*/
export interface SatelliteStatusInfo {
satellitesNumber: number;
satelliteIds: Array;
carrierToNoiseDensitys: Array;
- altitude: Array;
+ altitudes: Array;
azimuths: Array;
carrierFrequencies: Array;
}
@@ -306,7 +306,7 @@ declare namespace geolocation {
* parameters for requesting to report cache location information
*
* @since 8
- * @SysCap SystemCapability.Location.Location.Gnss
+ * @syscap SystemCapability.Location.Location.Gnss
* @permission ohos.permission.LOCATION
*/
export interface CachedGnssLoactionsRequest {
@@ -318,7 +318,7 @@ declare namespace geolocation {
* configuring parameters in geo fence requests
*
* @since 8
- * @SysCap SystemCapability.Location.Location.Geofence
+ * @syscap SystemCapability.Location.Location.Geofence
* @permission ohos.permission.LOCATION
*/
export interface GeofenceRequest {
@@ -331,7 +331,7 @@ declare namespace geolocation {
* configuring parameters in geo fence requests
*
* @since 8
- * @SysCap SystemCapability.Location.Location.Geofence
+ * @syscap SystemCapability.Location.Location.Geofence
* @permission ohos.permission.LOCATION
*/
export interface Geofence {
@@ -346,7 +346,7 @@ declare namespace geolocation {
*
* @since 8
* @systemapi
- * @SysCap SystemCapability.Location.Location.Core
+ * @syscap SystemCapability.Location.Location.Core
* @permission ohos.permission.LOCATION
* @param type indicates location privacy protocol type.
* @param callback indicates the callback for reporting the location privacy protocol confirmation status.
@@ -359,7 +359,7 @@ declare namespace geolocation {
*
* @since 8
* @systemapi
- * @SysCap SystemCapability.Location.Location.Core
+ * @syscap SystemCapability.Location.Location.Core
* @permission ohos.permission.LOCATION
* @param type indicates location privacy protocol type.
* @param isConfirmed indicates whether the location privacy protocol has been confirmed.
@@ -372,7 +372,7 @@ declare namespace geolocation {
* configuring parameters in reverse geocode requests
*
* @since 7
- * @SysCap SystemCapability.Location.Location.Geocoder
+ * @syscap SystemCapability.Location.Location.Geocoder
* @permission ohos.permission.LOCATION
*/
export interface ReverseGeoCodeRequest {
@@ -386,7 +386,7 @@ declare namespace geolocation {
* configuring parameters in geocode requests
*
* @since 7
- * @SysCap SystemCapability.Location.Location.Geocoder
+ * @syscap SystemCapability.Location.Location.Geocoder
* @permission ohos.permission.LOCATION
*/
export interface GeoCodeRequest {
@@ -403,7 +403,7 @@ declare namespace geolocation {
* data struct describes geographic locations.
*
* @since 7
- * @SysCap SystemCapability.Location.Location.Geocoder
+ * @syscap SystemCapability.Location.Location.Geocoder
* @permission ohos.permission.LOCATION
*/
export interface GeoAddress {
@@ -431,7 +431,7 @@ declare namespace geolocation {
* configuring parameters in location requests
*
* @since 7
- * @SysCap SystemCapability.Location.Location.Core
+ * @syscap SystemCapability.Location.Location.Core
* @permission ohos.permission.LOCATION
*/
export interface LocationRequest {
@@ -446,7 +446,7 @@ declare namespace geolocation {
* configuring parameters in current location requests
*
* @since 7
- * @SysCap SystemCapability.Location.Location.Core
+ * @syscap SystemCapability.Location.Location.Core
* @permission ohos.permission.LOCATION
*/
export interface CurrentLocationRequest {
@@ -460,7 +460,7 @@ declare namespace geolocation {
* provides information about geographic locations
*
* @since 7
- * @SysCap SystemCapability.Location.Location.Core
+ * @syscap SystemCapability.Location.Location.Core
* @permission ohos.permission.LOCATION
*/
export interface Location {
@@ -480,7 +480,7 @@ declare namespace geolocation {
* enum for location priority
*
* @since 7
- * @SysCap SystemCapability.Location.Location.Core
+ * @syscap SystemCapability.Location.Location.Core
* @permission ohos.permission.LOCATION
*/
export enum LocationRequestPriority {
@@ -494,7 +494,7 @@ declare namespace geolocation {
* enum for location scenario
*
* @since 7
- * @SysCap SystemCapability.Location.Location.Core
+ * @syscap SystemCapability.Location.Location.Core
* @permission ohos.permission.LOCATION
*/
export enum LocationRequestScenario {
@@ -510,7 +510,7 @@ declare namespace geolocation {
* enum for error code
*
* @since 7
- * @SysCap SystemCapability.Location.Location.Core
+ * @syscap SystemCapability.Location.Location.Core
* @permission ohos.permission.LOCATION
*/
export enum GeoLocationErrorCode {
@@ -527,7 +527,7 @@ declare namespace geolocation {
* enum for location privacy type
*
* @since 8
- * @SysCap SystemCapability.Location.Location.Core
+ * @syscap SystemCapability.Location.Location.Core
* @permission ohos.permission.LOCATION
*/
export enum LocationPrivacyType {
@@ -540,7 +540,7 @@ declare namespace geolocation {
* Location subsystem command structure
*
* @since 8
- * @SysCap SystemCapability.Location.Location.Core
+ * @syscap SystemCapability.Location.Location.Core
* @permission ohos.permission.LOCATION
*/
export interface LocationCommand {
diff --git a/api/@ohos.i18n.d.ts b/api/@ohos.i18n.d.ts
index cec604281101c1f0c31084b969968bd8370d1153..1a370d6351eba2a6c870d1f3fe6cd4cdb5e90a8e 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,9 +661,75 @@ 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
*/
export function getFirstPreferredLanguage(): string;
+
+/**
+ * Get the default TimeZone object or the TimeZone object corresponds to zoneID.
+ *
+ * @syscap SystemCapability.Global.I18n
+ * @param zoneID TimeZone ID used to create TimeZone Object.
+ * @return Returns a TimeZone object corresponds to zoneID.
+ * @since 8
+ */
+export function getTimeZone(zoneID?: string): TimeZone;
+
+/**
+ * Provides the API for accessing TimeZone name, rawOffset and offset information.
+ *
+ * @syscap SystemCapability.Global.I18n
+ * @since 8
+ */
+export class TimeZone {
+ /**
+ * Get the id of the TimeZone object.
+ *
+ * @syscap SystemCapability.Global.I18n
+ * @return Returns a string represents the timezone id.
+ * @since 8
+ */
+ getID(): string;
+
+ /**
+ * Get the displayName of the TimeZone Object under the default locale.
+ *
+ * @syscap SystemCapability.Global.I18n
+ * @return Returns a string represents the display name.
+ * @since 8
+ */
+ getDisplayName(): string;
+
+ /**
+ * Get the displayName of the TimeZone Object under the locale.
+ *
+ * @syscap SystemCapability.Global.I18n
+ * @param locale the locale tag use to display timezone object's name.
+ * @param isDST wether conside daylight saving time when display timezone object's name.
+ * @return Returns a string represents the display name.
+ * @since 8
+ */
+ getDisplayName(locale: string, isDST?: boolean): string;
+
+ /**
+ * Get the raw offset of the TimeZone object.
+ *
+ * @syscap SystemCapability.Global.I18n
+ * @return Returns a number represents the raw offset.
+ * @since 8
+ */
+ getRawOffset(): number;
+
+ /**
+ * Get the offset of the TimeZone object.
+ *
+ * @syscap SystemCapability.Global.I18n
+ * @date Indicates a date use to compute offset.
+ * @return Returns a number represents the offset with date.
+ * @since 8
+ */
+ getOffset(date: number): number;
+}
}
\ No newline at end of file
diff --git a/api/@ohos.intl.d.ts b/api/@ohos.intl.d.ts
index 2a1bcdda7275691cb16a09c5fef05809dce04de5..cf384e60714bb09a5b1c4c8cf74b696bd4338119 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,24 +73,33 @@ 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
+ * @since 6
+ */
+ constructor();
+
+ /**
+ * A constructor used to create a Locale object.
+ *
+ * @syscap SystemCapability.Global.I18n
* @param locale Indicates a character string containing the locale information, including
* the language and optionally the script and region.
+ * @param options Indicates Locale option object use to initialize the Locale object.
* @since 6
*/
- constructor(locale?: string, options?: LocaleOptions);
+ constructor(locale: string, options?: LocaleOptions);
/**
* Indicates the language of the locale.
*
- * @sysCap SystemCapability.Global.I18n
+ * @syscap SystemCapability.Global.I18n
* @since 6
*/
language: string
@@ -98,7 +107,7 @@ export class Locale {
/**
* Indicates the script of the locale.
*
- * @sysCap SystemCapability.Global.I18n
+ * @syscap SystemCapability.Global.I18n
* @since 6
*/
script: string
@@ -106,7 +115,7 @@ export class Locale {
/**
* Indicates the region of the locale.
*
- * @sysCap SystemCapability.Global.I18n
+ * @syscap SystemCapability.Global.I18n
* @since 6
*/
region: string
@@ -115,7 +124,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 +162,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 +170,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 +178,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 +187,7 @@ export class Locale {
/**
* Provides the options of date time format.
*
- * @sysCap SystemCapability.Global.I18n
+ * @syscap SystemCapability.Global.I18n
*/
export interface DateTimeOptions {
/**
@@ -280,14 +289,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 +304,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 +315,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 +325,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 +336,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 +346,7 @@ export class DateTimeFormat {
/**
* Provides the options of number format.
*
- * @sysCap SystemCapability.Global.I18n
+ * @syscap SystemCapability.Global.I18n
*/
export interface NumberOptions {
/**
@@ -439,13 +448,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 +462,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 +473,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 +483,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 +493,7 @@ export class NumberFormat {
/**
* Provides the options of Collator
*
- * @sysCap SystemCapability.Global.I18n
+ * @syscap SystemCapability.Global.I18n
* @since 8
*/
export interface CollatorOptions {
@@ -533,21 +542,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 +567,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 +582,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 +592,7 @@ export class Collator {
/**
* Provides the options of PluralRules
*
- * @sysCap SystemCapability.Global.I18n
+ * @syscap SystemCapability.Global.I18n
* @since 8
*/
export interface PluralRulesOptions {
@@ -633,14 +642,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 +657,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 +668,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 +680,7 @@ export class PluralRules {
/**
* Provides the input options of RelativeTimeFormat.
*
- * @sysCap SystemCapability.Intl
+ * @syscap SystemCapability.Global.I18n
* @since 8
*/
export interface RelativeTimeFormatInputOptions {
@@ -697,7 +706,7 @@ export class PluralRules {
/**
* Provides the resolved options of RelativeTimeFormat.
*
- * @sysCap SystemCapability.Intl
+ * @syscap SystemCapability.Global.I18n
* @since 8
*/
export interface RelativeTimeFormatResolvedOptions {
@@ -728,14 +737,14 @@ export interface RelativeTimeFormatResolvedOptions {
* Given a Time period length value and a unit, RelativeTimeFormat object enables
* language-sensitive relative time formatting.
*
- * @sysCap SystemCapability.Intl
+ * @syscap SystemCapability.Global.I18n
* @since 8
*/
export class RelativeTimeFormat {
/**
* A constructor used to create RelativeTimeFormat object.
*
- * @sysCap SystemCapability.Intl
+ * @syscap SystemCapability.Global.I18n
* @since 8
*/
constructor();
@@ -743,7 +752,7 @@ export class RelativeTimeFormat {
/**
* A constructor used to create RelativeTimeFormat object.
*
- * @sysCap SystemCapability.Intl
+ * @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 +763,7 @@ export class RelativeTimeFormat {
/**
* formats a value and unit according to the locale and formatting options of this object.
*
- * @sysCap SystemCapability.Intl
+ * @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 +776,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.Intl
+ * @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 +789,7 @@ export class RelativeTimeFormat {
* Returns a new object with properties reflecting the locale and formatting options computed during
* initialization of the object.
*
- * @sysCap SystemCapability.Intl
+ * @syscap SystemCapability.Global.I18n
* @returns RelativeTimeFormatOptions which reflecting the locale and formatting options of the object.
* @since 8
*/
diff --git a/api/@ohos.matrix4.d.ts b/api/@ohos.matrix4.d.ts
index 635a260179ca9879324b6c25558f6dd2759501a0..9f779cf3176abbfee0cd1df1608f02d20541aef6 100644
--- a/api/@ohos.matrix4.d.ts
+++ b/api/@ohos.matrix4.d.ts
@@ -16,33 +16,29 @@
/**
* Used to do matrix operations
* @import import Matrix4 from '@ohos.matrix4'
- * @devices phone, tablet, tv, wearable
+ * @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
declare namespace matrix4 {
/**
* Set translation parameters
- * @devices phone, tablet, tv, wearable
* @since 7
*/
interface TranslateOption {
/**
* Indicates the translation distance of the x-axis, in px.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
x?: number;
/**
* Indicates the translation distance of the y-axis, in px.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
y?: number;
/**
* Indicates the translation distance of the z-axis, in px.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
z?: number;
@@ -50,41 +46,35 @@ declare namespace matrix4 {
/**
* Set scaling parameters
- * @devices phone, tablet, tv, wearable
* @since 7
*/
interface ScaleOption {
/**
* Zoom factor of the x-axis.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
x?: number;
/**
* Zoom factor of the y-axis.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
y?: number;
/**
* Zoom factor of the z-axis.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
z?: number;
/**
* Transform the x-axis coordinate of the center point.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
centerX?: number;
/**
* Transform the y-axis coordinate of the center point.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
centerY?: number;
@@ -92,48 +82,41 @@ declare namespace matrix4 {
/**
* Set Rotation Parameters.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
interface RotateOption {
/**
* Axis of rotation vector x coordinate.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
x?: number;
/**
* Axis of rotation vector y coordinate.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
y?: number;
/**
* Axis of rotation vector z coordinate.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
z?: number;
/**
* Transform the x-axis coordinate of the center point.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
centerX?: number;
/**
* Transform the y-axis coordinate of the center point.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
centerY?: number;
/**
* Rotation angle.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
angle?: number;
@@ -141,14 +124,12 @@ declare namespace matrix4 {
/**
* Matrix4Transit.
- * @devices phone, tablet, tv, wearable
* @since 7
*/
interface Matrix4Transit {
/**
* Copy function of Matrix, which can copy a copy of the current matrix object.
* @since 7
- * @devices phone, tablet, tv, wearable
* @return Return to Matrix4Transit
*/
copy(): Matrix4Transit;
@@ -156,7 +137,6 @@ declare namespace matrix4 {
/**
* The inverse function of Matrix returns an inverse matrix of the current matrix object, that is, the effect is exactly the opposite.
* @since 7
- * @devices phone, tablet, tv, wearable
* @return Return to Matrix4Transit
*/
invert(): Matrix4Transit;
@@ -164,55 +144,68 @@ declare namespace matrix4 {
/**
* Matrix superposition function, which can superpose the effects of two matrices to generate a new matrix object.
* @since 7
- * @devices phone, tablet, tv, wearable
* @return Return to Matrix4Transit
*/
- combine(options:Matrix4Transit): Matrix4Transit;
+ combine(options: Matrix4Transit): Matrix4Transit;
/**
* Matrix translation function, which can add the x-axis, Y-axis, or Z-axis translation effect to the current matrix.
* @since 7
- * @devices phone, tablet, tv, wearable
* @return Return to Matrix4Transit
*/
- translate(options:TranslateOption): Matrix4Transit;
+ translate(options: TranslateOption): Matrix4Transit;
/**
* Scaling function of the Matrix, which can add the x-axis, Y-axis, or Z-axis scaling effect to the current matrix.
* @since 7
- * @devices phone, tablet, tv, wearable
* @return Return to Matrix4Transit
*/
- scale(options:ScaleOption): Matrix4Transit;
+ scale(options: ScaleOption): Matrix4Transit;
- /* Rotation function of the Matrix. You can add the x-axis, Y-axis, or Z-axis rotation effect to the current matrix.
+ /**
+ * Rotation function of the Matrix. You can add the x-axis, Y-axis, or Z-axis rotation effect to the current matrix.
* @since 7
- * @devices phone, tablet, tv, wearable
* @return Return to Matrix4Transit
*/
- rotate(options:RotateOption): Matrix4Transit;
+ rotate(options: RotateOption): Matrix4Transit;
/**
* Matrix coordinate point conversion function, which can apply the current transformation effect to a coordinate point.
* @since 7
- * @devices phone, tablet, tv, wearable
* @return Return to Matrix4Transit
*/
- transformPoint(options:[number,number]): [number,number];
+ transformPoint(options: [number, number]): [number, number];
}
/**
* Constructor of Matrix, which can create a fourth-order matrix based on the input parameters. The matrix is column-first.
* @since 7
- * @devices phone, tablet, tv, wearable
* @return Return to Matrix4Transit
*/
- function init(options: [number,number,number,number,number,number,number,number,number,number,number,number,number,number,number,number]): Matrix4Transit;
+ function init(
+ options: [
+ number,
+ number,
+ number,
+ number,
+ number,
+ number,
+ number,
+ number,
+ number,
+ number,
+ number,
+ number,
+ number,
+ number,
+ number,
+ number,
+ ],
+ ): Matrix4Transit;
/**
* Matrix initialization function, which can return an identity matrix object.
* @since 7
- * @devices phone, tablet, tv, wearable
* @return Return to Matrix4Transit
*/
function identity(): Matrix4Transit;
@@ -220,7 +213,6 @@ declare namespace matrix4 {
/**
* Copy function of Matrix, which can copy a copy of the current matrix object.
* @since 7
- * @devices phone, tablet, tv, wearable
* @return Return to Matrix4Transit
*/
function copy(): Matrix4Transit;
@@ -228,7 +220,6 @@ declare namespace matrix4 {
/**
* The inverse function of Matrix returns an inverse matrix of the current matrix object, that is, the effect is exactly the opposite.
* @since 7
- * @devices phone, tablet, tv, wearable
* @return Return to Matrix4Transit
*/
function invert(): Matrix4Transit;
@@ -236,42 +227,37 @@ declare namespace matrix4 {
/**
* Matrix superposition function, which can superpose the effects of two matrices to generate a new matrix object.
* @since 7
- * @devices phone, tablet, tv, wearable
* @return Return to Matrix4Transit
*/
- function combine(options:Matrix4Transit): Matrix4Transit;
+ function combine(options: Matrix4Transit): Matrix4Transit;
/**
* Matrix translation function, which can add the x-axis, Y-axis, or Z-axis translation effect to the current matrix.
* @since 7
- * @devices phone, tablet, tv, wearable
* @return Return to Matrix4Transit
*/
- function translate(options:TranslateOption): Matrix4Transit;
+ function translate(options: TranslateOption): Matrix4Transit;
/**
* Scaling function of the Matrix, which can add the x-axis, Y-axis, or Z-axis scaling effect to the current matrix.
* @since 7
- * @devices phone, tablet, tv, wearable
* @return Return to Matrix4Transit
*/
- function scale(options:ScaleOption): Matrix4Transit;
+ function scale(options: ScaleOption): Matrix4Transit;
/**
* Rotation function of the Matrix. You can add the x-axis, Y-axis, or Z-axis rotation effect to the current matrix.
* @since 7
- * @devices phone, tablet, tv, wearable
* @return Return to Matrix4Transit
*/
- function rotate(options:RotateOption): Matrix4Transit;
+ function rotate(options: RotateOption): Matrix4Transit;
/**
* Matrix coordinate point conversion function, which can apply the current transformation effect to a coordinate point.
* @since 7
- * @devices phone, tablet, tv, wearable
* @return Return to Matrix4Transit
*/
- function transformPoint(options:[number,number]): [number,number];
+ function transformPoint(options: [number, number]): [number, number];
}
-export default matrix4;
\ No newline at end of file
+export default matrix4;
diff --git a/api/@ohos.mediaquery.d.ts b/api/@ohos.mediaquery.d.ts
index fe889218bf4c2fbc32eb5beb197e38dc4c4db719..475e5974cd70a91d1ae956835138c4bf9b61e2c9 100644
--- a/api/@ohos.mediaquery.d.ts
+++ b/api/@ohos.mediaquery.d.ts
@@ -15,6 +15,12 @@
import {Callback} from './basic';
+/**
+ * Used to do mediaquery operations.
+ * @import import mediaquery from '@ohos.mediaquery'
+ * @syscap SystemCapability.ArkUI.ArkUI.Full
+ * @since 7
+ */
declare namespace mediaquery {
interface MediaQueryResult {
@@ -22,14 +28,14 @@ declare namespace mediaquery {
/**
* Whether the match condition is met.
* This parameter is read-only.
- * @since 8
+ * @since 7
*/
readonly matches: boolean;
/**
* Matching condition of a media event.
* This parameter is read-only.
- * @since 8
+ * @since 7
*/
readonly media: string;
}
@@ -39,21 +45,21 @@ declare namespace mediaquery {
/**
* Registers a callback with the corresponding query condition by using the handle.
* This callback is triggered when the media attributes change.
- * @since 8
+ * @since 7
*/
on(type: 'change', callback: Callback): void;
/**
* Deregisters a callback with the corresponding query condition by using the handle.
* This callback is not triggered when the media attributes chang.
- * @since 8
+ * @since 7
*/
off(type: 'change', callback?: Callback): void;
}
/**
* Sets the media query criteria and returns the corresponding listening handle
- * @since 8
+ * @since 7
*/
function matchMediaSync(condition: string): MediaQueryListener;
}
diff --git a/api/@ohos.multimedia.audio.d.ts b/api/@ohos.multimedia.audio.d.ts
index 9970a64dabd8d1d6632dcfc0ce5793c0aacf190f..d406fe07df4da9a2e7d98b393c56d75e1c1d23b0 100644
--- a/api/@ohos.multimedia.audio.d.ts
+++ b/api/@ohos.multimedia.audio.d.ts
@@ -276,13 +276,13 @@ declare namespace audio {
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Communication
*/
- RINGER_MODE_VIBRATE,
+ RINGER_MODE_VIBRATE = 1,
/**
* Normal mode
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Communication
*/
- RINGER_MODE_NORMAL,
+ RINGER_MODE_NORMAL = 2,
}
/**
@@ -510,7 +510,7 @@ declare namespace audio {
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Core
*/
- STREAM_USAGE_NOTIFICATION_RINGTONE = 3
+ STREAM_USAGE_NOTIFICATION_RINGTONE = 6
}
/**
@@ -690,6 +690,7 @@ declare namespace audio {
* Interrupt force type.
* @since 8
* @syscap SystemCapability.Multimedia.Audio.Renderer
+ * @systemapi
*/
enum InterruptForceType {
/**
@@ -782,7 +783,7 @@ declare namespace audio {
* Enumerates audio scenes.
* @since 8
* @syscap SystemCapability.Multimedia.Audio.Communication
- */
+ */
enum AudioScene {
/**
* Default audio scene
@@ -822,50 +823,52 @@ declare namespace audio {
* Sets volume for a stream. This method uses an asynchronous callback to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Volume
+ * @permission ohos.permission.ACCESS_NOTIFICATION_POLICY
*/
- setVolume(audioType: AudioVolumeType, volume: number, callback: AsyncCallback): void;
+ setVolume(volumeType: AudioVolumeType, volume: number, callback: AsyncCallback): void;
/**
* Sets volume for a stream. This method uses a promise to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Volume
+ * @permission ohos.permission.ACCESS_NOTIFICATION_POLICY
*/
- setVolume(audioType: AudioVolumeType, volume: number): Promise;
+ setVolume(volumeType: AudioVolumeType, volume: number): Promise;
/**
* Obtains volume of a stream. This method uses an asynchronous callback to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Volume
*/
- getVolume(audioType: AudioVolumeType, callback: AsyncCallback): void;
+ getVolume(volumeType: AudioVolumeType, callback: AsyncCallback): void;
/**
* Obtains the volume of a stream. This method uses a promise to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Volume
*/
- getVolume(audioType: AudioVolumeType): Promise;
+ getVolume(volumeType: AudioVolumeType): Promise;
/**
* Obtains the minimum volume allowed for a stream. This method uses an asynchronous callback to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Volume
*/
- getMinVolume(audioType: AudioVolumeType, callback: AsyncCallback): void;
+ getMinVolume(volumeType: AudioVolumeType, callback: AsyncCallback): void;
/**
* Obtains the minimum volume allowed for a stream. This method uses a promise to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Volume
*/
- getMinVolume(audioType: AudioVolumeType): Promise;
+ getMinVolume(volumeType: AudioVolumeType): Promise;
/**
* Obtains the maximum volume allowed for a stream. This method uses an asynchronous callback to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Volume
*/
- getMaxVolume(audioType: AudioVolumeType, callback: AsyncCallback): void;
+ getMaxVolume(volumeType: AudioVolumeType, callback: AsyncCallback): void;
/**
* Obtains the maximum volume allowed for a stream. This method uses a promise to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Volume
*/
- getMaxVolume(audioType: AudioVolumeType): Promise;
+ getMaxVolume(volumeType: AudioVolumeType): Promise;
/**
* Obtains the audio devices of a specified flag. This method uses an asynchronous callback to return the execution result.
* @since 7
@@ -883,71 +886,77 @@ declare namespace audio {
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Volume
*/
- mute(audioType: AudioVolumeType, mute: boolean, callback: AsyncCallback): void;
+ mute(volumeType: AudioVolumeType, mute: boolean, callback: AsyncCallback): void;
/**
* Sets the stream to mute. This method uses a promise to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Volume
*/
- mute(audioType: AudioVolumeType, mute: boolean): Promise;
+ mute(volumeType: AudioVolumeType, mute: boolean): Promise;
/**
* Checks whether the stream is muted. This method uses an asynchronous callback to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Volume
*/
- isMute(audioType: AudioVolumeType, callback: AsyncCallback): void;
+ isMute(volumeType: AudioVolumeType, callback: AsyncCallback): void;
/**
* Checks whether the stream is muted. This method uses a promise to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Volume
*/
- isMute(audioType: AudioVolumeType): Promise;
+ isMute(volumeType: AudioVolumeType): Promise;
/**
* Checks whether the stream is active. This method uses an asynchronous callback to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Volume
*/
- isActive(audioType: AudioVolumeType, callback: AsyncCallback): void;
+ isActive(volumeType: AudioVolumeType, callback: AsyncCallback): void;
/**
* Checks whether the stream is active. This method uses a promise to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Volume
*/
- isActive(audioType: AudioVolumeType): Promise;
+ isActive(volumeType: AudioVolumeType): Promise;
/**
* Mute/Unmutes the microphone. This method uses an asynchronous callback to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Device
+ * @permission ohos.permission.MICROPHONE
*/
setMicrophoneMute(mute: boolean, callback: AsyncCallback): void;
/**
* Mute/Unmutes the microphone. This method uses a promise to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Device
+ * @permission ohos.permission.MICROPHONE
*/
setMicrophoneMute(mute: boolean): Promise;
/**
* Checks whether the microphone is muted. This method uses an asynchronous callback to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Device
+ * @permission ohos.permission.MICROPHONE
*/
isMicrophoneMute(callback: AsyncCallback): void;
/**
* Checks whether the microphone is muted. This method uses a promise to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Device
+ * @permission ohos.permission.MICROPHONE
*/
isMicrophoneMute(): Promise;
/**
* Sets the ringer mode. This method uses an asynchronous callback to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Communication
+ * @permission ohos.permission.ACCESS_NOTIFICATION_POLICY
*/
setRingerMode(mode: AudioRingMode, callback: AsyncCallback): void;
/**
* Sets the ringer mode. This method uses a promise to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Communication
+ * @permission ohos.permission.ACCESS_NOTIFICATION_POLICY
*/
setRingerMode(mode: AudioRingMode): Promise;
/**
@@ -966,12 +975,14 @@ declare namespace audio {
* Sets the audio parameter. This method uses an asynchronous callback to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Core
+ * @permission ohos.permission.MODIFY_AUDIO_SETTINGS
*/
setAudioParameter(key: string, value: string, callback: AsyncCallback): void;
/**
* Sets the audio parameter. This method uses a promise to return the execution result.
* @since 7
* @syscap SystemCapability.Multimedia.Audio.Core
+ * @permission ohos.permission.MODIFY_AUDIO_SETTINGS
*/
setAudioParameter(key: string, value: string): Promise;
/**
@@ -1030,12 +1041,14 @@ declare namespace audio {
* This method uses an asynchronous callback to return the execution result.
* @since 8
* @syscap SystemCapability.Multimedia.Audio.Communication
+ * @systemapi
*/
setAudioScene(scene: AudioScene, callback: AsyncCallback ): void;
/**
* Sets the audio scene mode to change audio strategy. This method uses a promise to return the execution result.
* @since 8
* @syscap SystemCapability.Multimedia.Audio.Communication
+ * @systemapi
*/
setAudioScene(scene: AudioScene): Promise;
/**
@@ -1043,7 +1056,7 @@ declare namespace audio {
* @since 8
* @syscap SystemCapability.Multimedia.Audio.Communication
*/
- getAudioScene(callback: AsyncCallback ): void;
+ getAudioScene(callback: AsyncCallback): void;
/**
* Obtains the system audio scene mode. This method uses a promise to return the execution result.
* @since 8
@@ -1051,12 +1064,19 @@ declare namespace audio {
*/
getAudioScene(): Promise;
/**
- * Monitors device changes
- * @since 7
- * @syscap SystemCapability.Multimedia.Audio.Device
- */
+ * Monitors device changes
+ * @since 7
+ * @syscap SystemCapability.Multimedia.Audio.Device
+ */
on(type: 'deviceChange', callback: Callback): void;
+ /**
+ * Cancels the listening of device change events.
+ * @since 7
+ * @syscap SystemCapability.Multimedia.Audio.Device
+ */
+ off(type: 'deviceChange', callback?: Callback): void;
+
/**
* Listens for audio interruption events. When the audio of an application is interrupted by another application,
* the callback is invoked to notify the former application.
@@ -1391,6 +1411,7 @@ declare namespace audio {
* @return InterruptEvent callback.
* @since 8
* @syscap SystemCapability.Multimedia.Audio.Renderer
+ * @systemapi
*/
on(type: 'interrupt', callback: Callback): void;
/**
@@ -1456,7 +1477,13 @@ declare namespace audio {
* @since 8
* @syscap SystemCapability.Multimedia.Audio.Core
*/
- SOURCE_TYPE_MIC
+ SOURCE_TYPE_MIC = 0,
+ /**
+ * Voice communication source.
+ * @since 8
+ * @syscap SystemCapability.Multimedia.Audio.Core
+ */
+ SOURCE_TYPE_VOICE_COMMUNICATION = 7
}
/**
diff --git a/api/@ohos.multimedia.camera.d.ts b/api/@ohos.multimedia.camera.d.ts
index 001206f1315d16ad23193752b9de4b00418a1a71..5acbd7dcff0dfe27d0a35509b1f110fd16b082c6 100644
--- a/api/@ohos.multimedia.camera.d.ts
+++ b/api/@ohos.multimedia.camera.d.ts
@@ -267,25 +267,6 @@ declare namespace camera {
width: number;
}
- /**
- * Enum for camera data format. Align to pixel format and image format value.
- * @since 8
- * @syscap SystemCapability.Multimedia.Camera.Core
- */
- enum CameraFormat {
- /**
- * YCRCb 420 SP format.
- * @since 8
- */
- CAMERA_FORMAT_YCRCb_420_SP = 1003,
-
- /**
- * JPEG format.
- * @since 8
- */
- CAMERA_FORMAT_JPEG = 2000,
- }
-
/**
* Camera input object.
* @since 8
@@ -301,28 +282,6 @@ declare namespace camera {
getCameraId(callback: AsyncCallback): void;
getCameraId(): Promise;
- /**
- * Gets all supported sizes for current camera input.
- * @return Supported size array.
- * @since 8
- * @syscap SystemCapability.Multimedia.Camera.Core
- */
- getSupportedSizes(format: CameraFormat, callback: AsyncCallback>): void;
- getSupportedSizes(format: CameraFormat): Promise>;
-
- /**
- * Gets all supported formats for current camera input.
- * @return Supported format array.
- * @since 8
- * @syscap SystemCapability.Multimedia.Camera.Core
- */
- getSupportedPreviewFormats(callback: AsyncCallback>): void;
- getSupportedPreviewFormats(): Promise