mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 06:03:30 +00:00
3719e23874
Signed-off-by: donglin <donglin9@huawei.com> Change-Id: Ifbd4ab009076cd0b7292d89a9f37f5a15999de72
531 lines
24 KiB
TypeScript
531 lines
24 KiB
TypeScript
/*
|
|
* Copyright (c) 2022-2023 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.
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* @kit AbilityKit
|
|
*/
|
|
|
|
import { AsyncCallback } from './@ohos.base';
|
|
import { MissionInfo as _MissionInfo } from './application/MissionInfo';
|
|
import { MissionListener as _MissionListener } from './application/MissionListener';
|
|
import { MissionSnapshot as _MissionSnapshot } from './application/MissionSnapshot';
|
|
import StartOptions from './@ohos.app.ability.StartOptions';
|
|
|
|
/**
|
|
* This module provides the capability to manage abilities and obtaining system task information.
|
|
*
|
|
* @namespace missionManager
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
declare namespace missionManager {
|
|
/**
|
|
* Register the missionListener to ams.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { 'mission' } type - mission.
|
|
* @param { MissionListener } listener - Indicates the MissionListener to be registered.
|
|
* @returns { number } Returns the index number of the MissionListener.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function on(type: 'mission', listener: MissionListener): number;
|
|
|
|
/**
|
|
* Unregister the missionListener to ams.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { 'mission' } type - mission.
|
|
* @param { number } listenerId - Indicates the listener id to be unregistered.
|
|
* @param { AsyncCallback<void> } callback - The callback of off.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16300002 - Input error. The specified mission listener does not exist.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function off(type: 'mission', listenerId: number, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Unregister the missionListener to ams.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { 'mission' } type - mission.
|
|
* @param { number } listenerId - Indicates the listener id to be unregistered.
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16300002 - Input error. The specified mission listener does not exist.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function off(type: 'mission', listenerId: number): Promise<void>;
|
|
|
|
/**
|
|
* Get the missionInfo with the given missionId.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { string } deviceId - Indicates the device to be queried.
|
|
* @param { number } missionId - Indicates mission id to be queried.
|
|
* @param { AsyncCallback<MissionInfo> } callback - The callback is used to return the MissionInfo of the given id.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback<MissionInfo>): void;
|
|
|
|
/**
|
|
* Get the missionInfo with the given missionId.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { string } deviceId - Indicates the device to be queried.
|
|
* @param { number } missionId - Indicates mission id to be queried.
|
|
* @returns { Promise<MissionInfo> } Returns the MissionInfo of the given id.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getMissionInfo(deviceId: string, missionId: number): Promise<MissionInfo>;
|
|
|
|
/**
|
|
* Get missionInfos in the given deviceId with maximum number of numMax.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { string } deviceId - Indicates the device to be queried.
|
|
* @param { number } numMax - Indicates the maximum number of returned missions.
|
|
* @param { AsyncCallback<Array<MissionInfo>> } callback - The callback is used to return the array of the MissionInfo.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback<Array<MissionInfo>>): void;
|
|
|
|
/**
|
|
* Get missionInfos in the given deviceId with maximum number of numMax.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { string } deviceId - Indicates the device to be queried.
|
|
* @param { number } numMax - Indicates the maximum number of returned missions.
|
|
* @returns { Promise<Array<MissionInfo>> } Returns the array of the MissionInfo.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getMissionInfos(deviceId: string, numMax: number): Promise<Array<MissionInfo>>;
|
|
|
|
/**
|
|
* Get the mission snapshot with the given missionId.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { string } deviceId - Indicates the device to be queried.
|
|
* @param { number } missionId - Indicates mission id to be queried.
|
|
* @param { AsyncCallback<MissionSnapshot> } callback - The callback is used to return the MissionSnapshot of
|
|
* the given id.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback<MissionSnapshot>): void;
|
|
|
|
/**
|
|
* Get the mission snapshot with the given missionId.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { string } deviceId - Indicates the device to be queried.
|
|
* @param { number } missionId - Indicates mission id to be queried.
|
|
* @returns { Promise<MissionSnapshot> } Returns the MissionSnapshot of the given id.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getMissionSnapShot(deviceId: string, missionId: number): Promise<MissionSnapshot>;
|
|
|
|
/**
|
|
* Get the mission low resolution snapshot with the given missionId.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { string } deviceId - Indicates the device to be queried.
|
|
* @param { number } missionId - Indicates mission id to be queried.
|
|
* @param { AsyncCallback<MissionSnapshot> } callback - The callback is used to return the MissionSnapshot of
|
|
* the given id.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getLowResolutionMissionSnapShot(
|
|
deviceId: string,
|
|
missionId: number,
|
|
callback: AsyncCallback<MissionSnapshot>
|
|
): void;
|
|
|
|
/**
|
|
* Get the mission low resolution snapshot with the given missionId.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { string } deviceId - Indicates the device to be queried.
|
|
* @param { number } missionId - Indicates mission id to be queried.
|
|
* @returns { Promise<MissionSnapshot> } Returns the MissionSnapshot of the given id.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getLowResolutionMissionSnapShot(deviceId: string, missionId: number): Promise<MissionSnapshot>;
|
|
|
|
/**
|
|
* Lock the mission.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { number } missionId - Indicates mission id to be locked.
|
|
* @param { AsyncCallback<void> } callback - The callback of lockMission.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16300001 - Mission not found.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function lockMission(missionId: number, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Lock the mission.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { number } missionId - Indicates mission id to be locked.
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16300001 - Mission not found.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function lockMission(missionId: number): Promise<void>;
|
|
|
|
/**
|
|
* Unlock the mission.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { number } missionId - Indicates mission id to be unlocked.
|
|
* @param { AsyncCallback<void> } callback - The callback of unlockMission.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16300001 - Mission not found.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function unlockMission(missionId: number, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Unlock the mission.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { number } missionId - Indicates mission id to be unlocked.
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16300001 - Mission not found.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function unlockMission(missionId: number): Promise<void>;
|
|
|
|
/**
|
|
* Clear the given mission in the ability manager service.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { number } missionId - Indicates mission id to be cleared.
|
|
* @param { AsyncCallback<void> } callback - The callback of clearMission.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function clearMission(missionId: number, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Clear the given mission in the ability manager service.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { number } missionId - Indicates mission id to be cleared.
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function clearMission(missionId: number): Promise<void>;
|
|
|
|
/**
|
|
* Clear all missions in the ability manager service.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { AsyncCallback<void> } callback - The callback of clearAllMissions.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function clearAllMissions(callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Clear all missions in the ability manager service.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function clearAllMissions(): Promise<void>;
|
|
|
|
/**
|
|
* Schedule the given mission to foreground.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { number } missionId - Indicates mission id to be moved to foreground.
|
|
* @param { AsyncCallback<void> } callback - The callback of moveMissionToFront.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function moveMissionToFront(missionId: number, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Schedule the given mission to foreground.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { number } missionId - Indicates mission id to be moved to foreground.
|
|
* @param { StartOptions } options - Indicates the start options.
|
|
* @param { AsyncCallback<void> } callback - The callback of moveMissionToFront.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Schedule the given mission to foreground.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { number } missionId - Indicates mission id to be moved to foreground.
|
|
* @param { StartOptions } [options] - Indicates the start options.
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function moveMissionToFront(missionId: number, options?: StartOptions): Promise<void>;
|
|
|
|
/**
|
|
* Schedule the given missions to foreground.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { Array<number> } missionIds - Indicates mission ids to be moved to foreground.
|
|
* @param { AsyncCallback<void> } callback - The callback of moveMissionsToForeground.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function moveMissionsToForeground(missionIds: Array<number>, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Schedule the given missions to foreground.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { Array<number> } missionIds - Indicates mission ids to be moved to foreground.
|
|
* @param { number } topMission - Indicates mission id to be moved to top.
|
|
* @param { AsyncCallback<void> } callback - The callback of moveMissionsToForeground.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function moveMissionsToForeground(missionIds: Array<number>, topMission: number, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Schedule the given missions to foreground.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { Array<number> } missionIds - Indicates mission ids to be moved to foreground.
|
|
* @param { number } topMission - Indicates mission id to be moved to top.
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function moveMissionsToForeground(missionIds: Array<number>, topMission?: number): Promise<void>;
|
|
|
|
/**
|
|
* Schedule the given missions to background.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { Array<number> } missionIds - Indicates mission ids will be moved to background
|
|
* @param { AsyncCallback<Array<number>> } callback - The callback of moveMissionsToForeground.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function moveMissionsToBackground(missionIds: Array<number>, callback: AsyncCallback<Array<number>>): void;
|
|
|
|
/**
|
|
* Schedule the given missions to background.
|
|
*
|
|
* @permission ohos.permission.MANAGE_MISSIONS
|
|
* @param { Array<number> } missionIds - Indicates mission ids will be moved to background
|
|
* @returns { Promise<Array<number>> } - The promise returned by the function.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function moveMissionsToBackground(missionIds: Array<number>): Promise<Array<number>>;
|
|
|
|
/**
|
|
* Mission information corresponding to ability.
|
|
*
|
|
* @typedef { _MissionInfo }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
export type MissionInfo = _MissionInfo;
|
|
|
|
/**
|
|
* MissionListener registered by app.
|
|
*
|
|
* @typedef { _MissionListener }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
export type MissionListener = _MissionListener;
|
|
|
|
/**
|
|
* Mission snapshot corresponding to mission.
|
|
*
|
|
* @typedef { _MissionSnapshot }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
export type MissionSnapshot = _MissionSnapshot;
|
|
}
|
|
|
|
export default missionManager;
|