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