mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 06:03:30 +00:00
99 lines
5.4 KiB
TypeScript
99 lines
5.4 KiB
TypeScript
/*
|
|
* Copyright (c) 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 BasicServicesKit
|
|
*/
|
|
|
|
import { AsyncCallback } from './@ohos.base';
|
|
import Want from './@ohos.app.ability.Want';
|
|
import ExtensionContext from './application/ExtensionContext';
|
|
|
|
/**
|
|
* class of static subscriber extension context.
|
|
*
|
|
* @extends ExtensionContext
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
export default class StaticSubscriberExtensionContext extends ExtensionContext {
|
|
/**
|
|
* Starts a new ability. If the caller application is in foreground, you can use this method to start ability;
|
|
* If the caller application is in the background, you need to apply for permission:ohos.permission.START_ABILITIES_FROM_BACKGROUND.
|
|
* If the target ability is visible, you can start the target ability; If the target ability is invisible,
|
|
* you need to apply for permission:ohos.permission.START_INVISIBLE_ABILITY to start target invisible ability.
|
|
*
|
|
* @permission ohos.permission.START_ABILITIES_FROM_BACKGROUND
|
|
* @param { Want } want - Indicates the ability to start.
|
|
* @param { AsyncCallback<void> } callback - The callback of startAbility.
|
|
* @throws { BusinessError } 201 - The application does not have permission to call the interface.
|
|
* @throws { BusinessError } 202 - The application is not system-app, can not use system-api.
|
|
* @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
|
|
* @throws { BusinessError } 16000001 - The specified ability does not exist.
|
|
* @throws { BusinessError } 16000002 - Incorrect ability type.
|
|
* @throws { BusinessError } 16000004 - Can not start invisible component.
|
|
* @throws { BusinessError } 16000005 - The specified process does not have the permission.
|
|
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
|
|
* @throws { BusinessError } 16000008 - The crowdtesting application expires.
|
|
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
|
|
* @throws { BusinessError } 16000011 - The context does not exist.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @throws { BusinessError } 16000053 - The ability is not on the top of the UI.
|
|
* @throws { BusinessError } 16000055 - Installation-free timed out.
|
|
* @throws { BusinessError } 16200001 - The caller has been released.
|
|
* @throws { BusinessError } 16300003 - The target application is not self application.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
startAbility(want: Want, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Starts a new ability. If the caller application is in foreground, you can use this method to start ability;
|
|
* If the caller application is in the background, you need to apply for permission:ohos.permission.START_ABILITIES_FROM_BACKGROUND.
|
|
* If the target ability is visible, you can start the target ability; If the target ability is invisible,
|
|
* you need to apply for permission:ohos.permission.START_INVISIBLE_ABILITY to start target invisible ability.
|
|
*
|
|
* @permission ohos.permission.START_ABILITIES_FROM_BACKGROUND
|
|
* @param { Want } want - Indicates the ability to start.
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 201 - The application does not have permission to call the interface.
|
|
* @throws { BusinessError } 202 - The application is not system-app, can not use system-api.
|
|
* @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
|
|
* @throws { BusinessError } 16000001 - The specified ability does not exist.
|
|
* @throws { BusinessError } 16000002 - Incorrect ability type.
|
|
* @throws { BusinessError } 16000004 - Can not start invisible component.
|
|
* @throws { BusinessError } 16000005 - The specified process does not have the permission.
|
|
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
|
|
* @throws { BusinessError } 16000008 - The crowdtesting application expires.
|
|
* @throws { BusinessError } 16000009 - An ability cannot be started or stopped in Wukong mode.
|
|
* @throws { BusinessError } 16000011 - The context does not exist.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @throws { BusinessError } 16000053 - The ability is not on the top of the UI.
|
|
* @throws { BusinessError } 16000055 - Installation-free timed out.
|
|
* @throws { BusinessError } 16200001 - The caller has been released.
|
|
* @throws { BusinessError } 16300003 - The target application is not self application.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @StageModelOnly
|
|
* @since 10
|
|
*/
|
|
startAbility(want: Want): Promise<void>;
|
|
}
|