mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 14:13:45 +00:00
377 lines
18 KiB
TypeScript
377 lines
18 KiB
TypeScript
/*
|
|
* Copyright (c) 2022-2024 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 { BundleInfo } from './bundleManager/BundleInfo';
|
|
import { ElementName } from './bundleManager/ElementName';
|
|
|
|
/**
|
|
* Default application manager.
|
|
*
|
|
* @namespace defaultAppManager
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @since 9
|
|
*/
|
|
declare namespace defaultAppManager {
|
|
/**
|
|
* The constant for application type.
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @since 9
|
|
*/
|
|
export enum ApplicationType {
|
|
/**
|
|
* Default browser identifier.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @since 9
|
|
*/
|
|
BROWSER = 'Web Browser',
|
|
/**
|
|
* Default image identifier.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @since 9
|
|
*/
|
|
IMAGE = 'Image Gallery',
|
|
/**
|
|
* Default audio identifier.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @since 9
|
|
*/
|
|
AUDIO = 'Audio Player',
|
|
/**
|
|
* Default video identifier.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @since 9
|
|
*/
|
|
VIDEO = 'Video Player',
|
|
/**
|
|
* Default PDF identifier.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @since 9
|
|
*/
|
|
PDF = 'PDF Viewer',
|
|
/**
|
|
* Default word identifier.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @since 9
|
|
*/
|
|
WORD = 'Word Viewer',
|
|
/**
|
|
* Default excel identifier.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @since 9
|
|
*/
|
|
EXCEL = 'Excel Viewer',
|
|
/**
|
|
* Default PPT identifier.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @since 9
|
|
*/
|
|
PPT = 'PPT Viewer',
|
|
/**
|
|
* Default email identifier.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @since 12
|
|
*/
|
|
EMAIL = 'Email'
|
|
}
|
|
|
|
/**
|
|
* Query whether the caller is default application based on type.
|
|
*
|
|
* @param { string } type - Application type or a file type that conforms to media type format.
|
|
* @param { AsyncCallback<boolean> } callback - The callback of querying default application result.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @since 9
|
|
*/
|
|
function isDefaultApplication(type: string, callback: AsyncCallback<boolean>): void;
|
|
|
|
/**
|
|
* Query whether the caller is default application based on type.
|
|
*
|
|
* @param { string } type - Application type or a file type that conforms to media type format.
|
|
* @returns { Promise<boolean> } Return true if caller is default application; return false otherwise.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @since 9
|
|
*/
|
|
function isDefaultApplication(type: string): Promise<boolean>;
|
|
|
|
/**
|
|
* Query whether the caller is default application based on type.
|
|
*
|
|
* @param { string } type - Application type or a file type that conforms to media type format.
|
|
* @returns { boolean } Return true if caller is default application; return false otherwise.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @since 10
|
|
*/
|
|
function isDefaultApplicationSync(type: string): boolean;
|
|
|
|
/**
|
|
* Get default application based on type.
|
|
*
|
|
* @permission ohos.permission.GET_DEFAULT_APPLICATION
|
|
* @param { string } type - Application type or a file type that conforms to media type format.
|
|
* @param { number } userId - Indicates the id for the user.
|
|
* @param { AsyncCallback<BundleInfo> } callback - The callback of the BundleInfo object result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700023 - The specified default app does not exist.
|
|
* @throws { BusinessError } 17700025 - The specified type is invalid.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getDefaultApplication(type: string, userId: number, callback: AsyncCallback<BundleInfo>): void;
|
|
|
|
/**
|
|
* Get default application based on type.
|
|
*
|
|
* @permission ohos.permission.GET_DEFAULT_APPLICATION
|
|
* @param { string } type - Application type or a file type that conforms to media type format.
|
|
* @param { AsyncCallback<BundleInfo> } callback - The callback of the BundleInfo object result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @throws { BusinessError } 17700023 - The specified default app does not exist.
|
|
* @throws { BusinessError } 17700025 - The specified type is invalid.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getDefaultApplication(type: string, callback: AsyncCallback<BundleInfo>): void;
|
|
|
|
/**
|
|
* Get default application based on type.
|
|
*
|
|
* @permission ohos.permission.GET_DEFAULT_APPLICATION
|
|
* @param { string } type - Application type or a file type that conforms to media type format.
|
|
* @param { number } userId - Indicates the id for the user.
|
|
* @returns { Promise<BundleInfo> } Return the BundleInfo object.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700023 - The specified default app does not exist.
|
|
* @throws { BusinessError } 17700025 - The specified type is invalid.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getDefaultApplication(type: string, userId?: number): Promise<BundleInfo>;
|
|
|
|
/**
|
|
* Get default application based on type.
|
|
*
|
|
* @permission ohos.permission.GET_DEFAULT_APPLICATION
|
|
* @param { string } type - Application type or a file type that conforms to media type format.
|
|
* @param { number } userId - Indicates the id for the user.
|
|
* @returns { BundleInfo } Return the BundleInfo object.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700023 - The specified default app does not exist.
|
|
* @throws { BusinessError } 17700025 - The specified type is invalid.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getDefaultApplicationSync(type: string, userId?: number): BundleInfo;
|
|
|
|
/**
|
|
* Set default application based on type.
|
|
*
|
|
* @permission ohos.permission.SET_DEFAULT_APPLICATION
|
|
* @param { string } type - Application type or a file type that conforms to media type format.
|
|
* @param { ElementName } elementName - Uniquely identifies an ability or extensionAbility.
|
|
* @param { number } userId - Indicates the id for the user.
|
|
* @param { AsyncCallback<void> } callback - The callback of setting default application result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700025 - The specified type is invalid.
|
|
* @throws { BusinessError } 17700028 - The specified ability does not match the type.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function setDefaultApplication(type: string,
|
|
elementName: ElementName, userId: number, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Set default application based on type.
|
|
*
|
|
* @permission ohos.permission.SET_DEFAULT_APPLICATION
|
|
* @param { string } type - Application type or a file type that conforms to media type format.
|
|
* @param { ElementName } elementName - Uniquely identifies an ability or extensionAbility.
|
|
* @param { AsyncCallback<void> } callback - The callback of setting default application result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @throws { BusinessError } 17700025 - The specified type is invalid.
|
|
* @throws { BusinessError } 17700028 - The specified ability does not match the type.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function setDefaultApplication(type: string, elementName: ElementName, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Set default application based on type.
|
|
*
|
|
* @permission ohos.permission.SET_DEFAULT_APPLICATION
|
|
* @param { string } type - Application type or a file type that conforms to media type format.
|
|
* @param { ElementName } elementName - Uniquely identifies an ability or extensionAbility.
|
|
* @param { number } userId - Indicates the id for the user.
|
|
* @returns { Promise<void> } The result of setting default application.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700025 - The specified type is invalid.
|
|
* @throws { BusinessError } 17700028 - The specified ability does not match the type.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function setDefaultApplication(type: string, elementName: ElementName, userId?: number): Promise<void>;
|
|
|
|
/**
|
|
* Set default application based on type.
|
|
*
|
|
* @permission ohos.permission.SET_DEFAULT_APPLICATION
|
|
* @param { string } type - Application type or a file type that conforms to media type format.
|
|
* @param { ElementName } elementName - Uniquely identifies an ability or extensionAbility.
|
|
* @param { number } userId - Indicates the id for the user.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700025 - The specified type is invalid.
|
|
* @throws { BusinessError } 17700028 - The specified ability does not match the type.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function setDefaultApplicationSync(type: string, elementName: ElementName, userId?: number): void;
|
|
|
|
/**
|
|
* Reset default application based on type.
|
|
*
|
|
* @permission ohos.permission.SET_DEFAULT_APPLICATION
|
|
* @param { string } type - Application type or a file type that conforms to media type format.
|
|
* @param { number } userId - Indicates the id for the user.
|
|
* @param { AsyncCallback<void> } callback - The callback of resetting default application result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700025 - The specified type is invalid.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function resetDefaultApplication(type: string, userId: number, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Reset default application based on type.
|
|
*
|
|
* @permission ohos.permission.SET_DEFAULT_APPLICATION
|
|
* @param { string } type - Application type or a file type that conforms to media type format.
|
|
* @param { AsyncCallback<void> } callback - The callback of resetting default application result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @throws { BusinessError } 17700025 - The specified type is invalid.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function resetDefaultApplication(type: string, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Reset default application based on type.
|
|
*
|
|
* @permission ohos.permission.SET_DEFAULT_APPLICATION
|
|
* @param { string } type - Application type or a file type that conforms to media type format.
|
|
* @param { number } userId - Indicates the id for the user.
|
|
* @returns { Promise<void> } The result of resetting default application.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700025 - The specified type is invalid.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function resetDefaultApplication(type: string, userId?: number): Promise<void>;
|
|
|
|
/**
|
|
* Reset default application based on type.
|
|
*
|
|
* @permission ohos.permission.SET_DEFAULT_APPLICATION
|
|
* @param { string } type - Application type or a file type that conforms to media type format.
|
|
* @param { number } userId - Indicates the id for the user.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700025 - The specified type is invalid.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function resetDefaultApplicationSync(type: string, userId?: number): void;
|
|
}
|
|
|
|
export default defaultAppManager;
|