1/* 2 * Copyright (c) 2021-2023 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"), 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16/** 17 * @file 18 */ 19 20import { AsyncCallback } from './@ohos.base'; 21import { MissionInfo } from './application/MissionInfo'; 22import { MissionListener } from './application/MissionListener'; 23import { MissionSnapshot } from './application/MissionSnapshot'; 24import StartOptions from './@ohos.app.ability.StartOptions'; 25 26/** 27 * This module provides the capability to manage abilities and obtaining system task information. 28 * 29 * @namespace missionManager 30 * @permission ohos.permission.MANAGE_MISSIONS 31 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 32 * @systemapi 33 * @since 8 34 * @deprecated since 9 35 * @useinstead ohos.app.ability.missionManager/missionManager 36 */ 37declare namespace missionManager { 38 /** 39 * Register the missionListener to ams. 40 * 41 * @permission ohos.permission.MANAGE_MISSIONS 42 * @param { MissionListener } listener - Indicates the MissionListener to be registered. 43 * @returns { number } The index number of the MissionListener. 44 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 45 * @systemapi 46 * @since 8 47 * @deprecated since 9 48 * @useinstead ohos.app.ability.missionManager/missionManager#on 49 */ 50 function registerMissionListener(listener: MissionListener): number; 51 52 /** 53 * Unregister the missionListener to ams. 54 * 55 * @permission ohos.permission.MANAGE_MISSIONS 56 * @param { number } listenerId - Indicates the listener id to be unregistered. 57 * @param { AsyncCallback<void> } callback - Execution result callback function. 58 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 59 * @systemapi 60 * @since 8 61 * @deprecated since 9 62 * @useinstead ohos.app.ability.missionManager/missionManager#off 63 */ 64 function unregisterMissionListener(listenerId: number, callback: AsyncCallback<void>): void; 65 66 /** 67 * Unregister the missionListener to ams. 68 * 69 * @permission ohos.permission.MANAGE_MISSIONS 70 * @param { number } listenerId - Indicates the listener id to be unregistered. 71 * @returns { Promise<void> } The promise returned by the function. 72 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 73 * @systemapi 74 * @since 8 75 * @deprecated since 9 76 * @useinstead ohos.app.ability.missionManager/missionManager#off 77 */ 78 function unregisterMissionListener(listenerId: number): Promise<void>; 79 80 /** 81 * Get the missionInfo with the given missionId. 82 * 83 * @permission ohos.permission.MANAGE_MISSIONS 84 * @param { string } deviceId - Indicates the device to be queried. 85 * @param { number } missionId - Indicates mission id to be queried. 86 * @param { AsyncCallback<MissionInfo> } callback - Execute the result callback function to return task information. 87 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 88 * @systemapi 89 * @since 8 90 * @deprecated since 9 91 * @useinstead ohos.app.ability.missionManager/missionManager#getMissionInfo 92 */ 93 function getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback<MissionInfo>): void; 94 95 /** 96 * Get the missionInfo with the given missionId. 97 * 98 * @permission ohos.permission.MANAGE_MISSIONS 99 * @param { string } deviceId - Indicates the device to be queried. 100 * @param { number } missionId - Indicates mission id to be queried. 101 * @returns { Promise<MissionInfo> } the {@link MissionInfo} of the given id. 102 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 103 * @systemapi 104 * @since 8 105 * @deprecated since 9 106 * @useinstead ohos.app.ability.missionManager/missionManager#getMissionInfo 107 */ 108 function getMissionInfo(deviceId: string, missionId: number): Promise<MissionInfo>; 109 110 /** 111 * Get the missionInfo with the given missionId. 112 * 113 * @permission ohos.permission.MANAGE_MISSIONS 114 * @param { string } deviceId - Indicates the device to be queried. 115 * @param { number } numMax - Indicates the maximum number of returned missions. 116 * @param { AsyncCallback<Array<MissionInfo>> } callback - Execute the result callback function to return an array of 117 * task information. 118 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 119 * @systemapi 120 * @since 8 121 * @deprecated since 9 122 * @useinstead ohos.app.ability.missionManager/missionManager#getMissionInfos 123 */ 124 function getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback<Array<MissionInfo>>): void; 125 126 /** 127 * Get the missionInfo with the given missionId. 128 * 129 * @permission ohos.permission.MANAGE_MISSIONS 130 * @param { string } deviceId - Indicates the device to be queried. 131 * @param { number } numMax - Indicates the maximum number of returned missions. 132 * @returns { Promise<Array<MissionInfo>> } The array of the {@link MissionInfo}. 133 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 134 * @systemapi 135 * @since 8 136 * @deprecated since 9 137 * @useinstead ohos.app.ability.missionManager/missionManager#getMissionInfos 138 */ 139 function getMissionInfos(deviceId: string, numMax: number): Promise<Array<MissionInfo>>; 140 141 /** 142 * Get the mission snapshot with the given missionId. 143 * 144 * @permission ohos.permission.MANAGE_MISSIONS 145 * @param { string } deviceId - Indicates the device to be queried. 146 * @param { number } missionId - Indicates mission id to be queried. 147 * @param { AsyncCallback<MissionSnapshot> } callback - Execute the result callback function to return task snapshot 148 * information. 149 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 150 * @systemapi 151 * @since 8 152 * @deprecated since 9 153 * @useinstead ohos.app.ability.missionManager/missionManager#getMissionSnapShot 154 */ 155 function getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback<MissionSnapshot>): void; 156 157 /** 158 * Get the mission snapshot with the given missionId. 159 * 160 * @permission ohos.permission.MANAGE_MISSIONS 161 * @param { string } deviceId - Indicates the device to be queried. 162 * @param { number } missionId - Indicates mission id to be queried. 163 * @returns { Promise<MissionSnapshot> } The {@link MissionSnapshot} of the given id. 164 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 165 * @systemapi 166 * @since 8 167 * @deprecated since 9 168 * @useinstead ohos.app.ability.missionManager/missionManager#getMissionSnapShot 169 */ 170 function getMissionSnapShot(deviceId: string, missionId: number): Promise<MissionSnapshot>; 171 172 /** 173 * Lock the mission. 174 * 175 * @permission ohos.permission.MANAGE_MISSIONS 176 * @param { number } missionId - Indicates mission id to be locked. 177 * @param { AsyncCallback<void> } callback - Execution result callback function. 178 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 179 * @systemapi 180 * @since 8 181 * @deprecated since 9 182 * @useinstead ohos.app.ability.missionManager/missionManager#lockMission 183 */ 184 function lockMission(missionId: number, callback: AsyncCallback<void>): void; 185 186 /** 187 * Lock the mission. 188 * 189 * @permission ohos.permission.MANAGE_MISSIONS 190 * @param { number } missionId - Indicates mission id to be locked. 191 * @returns { Promise<void> } The promise returned by the function. 192 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 193 * @systemapi 194 * @since 8 195 * @deprecated since 9 196 * @useinstead ohos.app.ability.missionManager/missionManager#lockMission 197 */ 198 function lockMission(missionId: number): Promise<void>; 199 200 /** 201 * Unlock the mission. 202 * 203 * @permission ohos.permission.MANAGE_MISSIONS 204 * @param { number } missionId - Indicates mission id to be unlocked. 205 * @param { AsyncCallback<void> } callback - Execution result callback function. 206 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 207 * @systemapi 208 * @since 8 209 * @deprecated since 9 210 * @useinstead ohos.app.ability.missionManager/missionManager#unlockMission 211 */ 212 function unlockMission(missionId: number, callback: AsyncCallback<void>): void; 213 214 /** 215 * Unlock the mission. 216 * 217 * @permission ohos.permission.MANAGE_MISSIONS 218 * @param { number } missionId - Indicates mission id to be unlocked. 219 * @returns { Promise<void> } The promise returned by the function. 220 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 221 * @systemapi 222 * @since 8 223 * @deprecated since 9 224 * @useinstead ohos.app.ability.missionManager/missionManager#unlockMission 225 */ 226 function unlockMission(missionId: number): Promise<void>; 227 228 /** 229 * Clear the given mission in the ability manager service. 230 * 231 * @permission ohos.permission.MANAGE_MISSIONS 232 * @param { number } missionId - Indicates mission id to be cleared. 233 * @param { AsyncCallback<void> } callback - Execution result callback function. 234 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 235 * @systemapi 236 * @since 8 237 * @deprecated since 9 238 * @useinstead ohos.app.ability.missionManager/missionManager#clearMission 239 */ 240 function clearMission(missionId: number, callback: AsyncCallback<void>): void; 241 242 /** 243 * Clear the given mission in the ability manager service. 244 * 245 * @permission ohos.permission.MANAGE_MISSIONS 246 * @param { number } missionId - Indicates mission id to be cleared. 247 * @returns { Promise<void> } The promise returned by the function. 248 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 249 * @systemapi 250 * @since 8 251 * @deprecated since 9 252 * @useinstead ohos.app.ability.missionManager/missionManager#clearMission 253 */ 254 function clearMission(missionId: number): Promise<void>; 255 256 /** 257 * Clear all missions in the ability manager service. 258 * 259 * @permission ohos.permission.MANAGE_MISSIONS 260 * @param { AsyncCallback<void> } callback - Returns the callback result in the form of a callback. 261 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 262 * @systemapi 263 * @since 8 264 * @deprecated since 9 265 * @useinstead ohos.app.ability.missionManager/missionManager#clearAllMissions 266 */ 267 function clearAllMissions(callback: AsyncCallback<void>): void; 268 269 /** 270 * Clear all missions in the ability manager service. 271 * 272 * @permission ohos.permission.MANAGE_MISSIONS 273 * @returns { Promise<void> } The promise returned by the function. 274 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 275 * @systemapi 276 * @since 8 277 * @deprecated since 9 278 * @useinstead ohos.app.ability.missionManager/missionManager#clearAllMissions 279 */ 280 function clearAllMissions(): Promise<void>; 281 282 /** 283 * Schedule the given mission to foreground. 284 * 285 * @permission ohos.permission.MANAGE_MISSIONS 286 * @param { number } missionId - Indicates mission id to be moved to foreground. 287 * @param { AsyncCallback<void> } callback - Execution result callback function. 288 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 289 * @systemapi 290 * @since 8 291 * @deprecated since 9 292 * @useinstead ohos.app.ability.missionManager/missionManager#moveMissionToFront 293 */ 294 function moveMissionToFront(missionId: number, callback: AsyncCallback<void>): void; 295 296 /** 297 * Schedule the given mission to foreground. 298 * 299 * @permission ohos.permission.MANAGE_MISSIONS 300 * @param { number } missionId - Indicates mission id to be moved to foreground. 301 * @param { StartOptions } options - Indicates the start options. 302 * @param { AsyncCallback<void> } callback - Execution result callback function. 303 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 304 * @systemapi 305 * @since 8 306 * @deprecated since 9 307 * @useinstead ohos.app.ability.missionManager/missionManager#moveMissionToFront 308 */ 309 function moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCallback<void>): void; 310 311 /** 312 * Schedule the given mission to foreground. 313 * 314 * @permission ohos.permission.MANAGE_MISSIONS 315 * @param { number } missionId - Indicates mission id to be moved to foreground. 316 * @param { StartOptions } [options] - Indicates the start options. 317 * @returns { Promise<void> } The promise returned by the function. 318 * @syscap SystemCapability.Ability.AbilityRuntime.Mission 319 * @systemapi 320 * @since 8 321 * @deprecated since 9 322 * @useinstead ohos.app.ability.missionManager/missionManager#moveMissionToFront 323 */ 324 function moveMissionToFront(missionId: number, options?: StartOptions): Promise<void>; 325} 326 327export default missionManager; 328