mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 14:13:45 +00:00
JsDoc changes
Signed-off-by: xinking129 <xinxin13@huawei.com>
This commit is contained in:
parent
990e0ef4c5
commit
d4651f6cbf
2
api/@ohos.ability.featureAbility.d.ts
vendored
2
api/@ohos.ability.featureAbility.d.ts
vendored
@ -441,6 +441,7 @@ declare namespace featureAbility {
|
||||
* Defines an AppVersionInfo object.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @FAModelOnly
|
||||
* @since 9
|
||||
*/
|
||||
export type AppVersionInfo = _AppVersionInfo;
|
||||
@ -449,6 +450,7 @@ declare namespace featureAbility {
|
||||
* This process information about an application.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @FAModelOnly
|
||||
* @since 9
|
||||
*/
|
||||
export type ProcessInfo = _ProcessInfo;
|
||||
|
4
api/@ohos.notificationManager.d.ts
vendored
4
api/@ohos.notificationManager.d.ts
vendored
@ -1654,7 +1654,7 @@ declare namespace notificationManager {
|
||||
*
|
||||
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
|
||||
* @param { 'checkNotification' } type - Type of the callback to listen for.
|
||||
* @param { (checkInfo: NotificationCheckInfo) => NotificationCheckResult } callback - callback - The callback of check notifications.
|
||||
* @param { function } callback - callback - The callback of check notifications.
|
||||
* @throws { BusinessError } 202 - Not system application.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 1600001 - Internal error.
|
||||
@ -1669,7 +1669,7 @@ declare namespace notificationManager {
|
||||
*
|
||||
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
|
||||
* @param { 'checkNotification' } type - Type of the callback to listen for.
|
||||
* @param { (checkInfo: NotificationCheckInfo) => NotificationCheckResult } [callback] - callback - The callback
|
||||
* @param { function } [callback] - callback - The callback
|
||||
* of check notifications.
|
||||
* @throws { BusinessError } 202 - Not system application.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
|
2
api/ability/dataAbilityHelper.d.ts
vendored
2
api/ability/dataAbilityHelper.d.ts
vendored
@ -452,6 +452,7 @@ export interface DataAbilityHelper {
|
||||
* returning the result of each operation in the
|
||||
* DataAbilityResult array.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
|
||||
* @FAModelOnly
|
||||
* @since 7
|
||||
*/
|
||||
executeBatch(
|
||||
@ -469,6 +470,7 @@ export interface DataAbilityHelper {
|
||||
* @returns { Promise<Array<DataAbilityResult>> } Returns the result of each operation,
|
||||
* in array {@link DataAbilityResult}.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
|
||||
* @FAModelOnly
|
||||
* @since 7
|
||||
*/
|
||||
executeBatch(uri: string, operations: Array<DataAbilityOperation>): Promise<Array<DataAbilityResult>>;
|
||||
|
10
api/app/context.d.ts
vendored
10
api/app/context.d.ts
vendored
@ -182,6 +182,7 @@ export interface Context extends BaseContext {
|
||||
*
|
||||
* @param { AsyncCallback<bundle.DisplayOrientation> } callback - Indicates the realistic direction of the screen.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @FAModelOnly
|
||||
* @since 7
|
||||
*/
|
||||
getDisplayOrientation(callback: AsyncCallback<bundle.DisplayOrientation>): void;
|
||||
@ -191,6 +192,7 @@ export interface Context extends BaseContext {
|
||||
*
|
||||
* @returns { Promise<bundle.DisplayOrientation> } Indicates the screen display direction.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @FAModelOnly
|
||||
* @since 7
|
||||
*/
|
||||
getDisplayOrientation(): Promise<bundle.DisplayOrientation>;
|
||||
@ -200,6 +202,7 @@ export interface Context extends BaseContext {
|
||||
*
|
||||
* @param { AsyncCallback<string> } callback - Returns the absolute path of the application's cache directory.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @FAModelOnly
|
||||
* @since 6
|
||||
* @deprecated since 7
|
||||
*/
|
||||
@ -210,6 +213,7 @@ export interface Context extends BaseContext {
|
||||
*
|
||||
* @returns { Promise<string> } Return the cache directory of the application.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @FAModelOnly
|
||||
* @since 6
|
||||
* @deprecated since 7
|
||||
*/
|
||||
@ -221,6 +225,7 @@ export interface Context extends BaseContext {
|
||||
* @param { bundle.DisplayOrientation } orientation - Indicates the new orientation for the current ability.
|
||||
* @param { AsyncCallback<void> } callback - Indicates the realistic direction of the screen.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @FAModelOnly
|
||||
* @since 7
|
||||
*/
|
||||
setDisplayOrientation(orientation: bundle.DisplayOrientation, callback: AsyncCallback<void>): void;
|
||||
@ -231,6 +236,7 @@ export interface Context extends BaseContext {
|
||||
* @param { bundle.DisplayOrientation } orientation - Indicates the new orientation for the current ability.
|
||||
* @returns { Promise<void> } the promise returned by the function.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @FAModelOnly
|
||||
* @since 7
|
||||
*/
|
||||
setDisplayOrientation(orientation: bundle.DisplayOrientation): Promise<void>;
|
||||
@ -244,6 +250,7 @@ export interface Context extends BaseContext {
|
||||
* to show it on the lock screen, and the value false means not.
|
||||
* @param { AsyncCallback<void> } callback - Returns the callback result.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @FAModelOnly
|
||||
* @since 7
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.window/window.WindowStage#setShowOnLockScreen
|
||||
@ -259,6 +266,7 @@ export interface Context extends BaseContext {
|
||||
* show it on the lock screen, and the value false means not.
|
||||
* @returns { Promise<void> } the promise returned by the function.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @FAModelOnly
|
||||
* @since 7
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.window/window.WindowStage#setShowOnLockScreen
|
||||
@ -272,6 +280,7 @@ export interface Context extends BaseContext {
|
||||
* and the value false means not.
|
||||
* @param { AsyncCallback<void> } callback - Returns the callback result.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @FAModelOnly
|
||||
* @since 7
|
||||
*/
|
||||
setWakeUpScreen(wakeUp: boolean, callback: AsyncCallback<void>): void;
|
||||
@ -283,6 +292,7 @@ export interface Context extends BaseContext {
|
||||
* value false means not.
|
||||
* @returns { Promise<void> } the promise returned by the function.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @FAModelOnly
|
||||
* @since 7
|
||||
*/
|
||||
setWakeUpScreen(wakeUp: boolean): Promise<void>;
|
||||
|
Loading…
Reference in New Issue
Block a user