diff --git a/api/@ohos.bundle.installer.d.ts b/api/@ohos.bundle.installer.d.ts index 3140d7ab68dbdb13f9e71589b16a1c5231cf7de2..6f0fc7461faa38eb547fad67df3bd431f2bcaddb 100644 --- a/api/@ohos.bundle.installer.d.ts +++ b/api/@ohos.bundle.installer.d.ts @@ -650,7 +650,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE * @param { Array } hapFilePaths - Indicates the path where the hap of the application is stored. * @param { InstallParam } installParam - Indicates other parameters required for the installation. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE'. * @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. @@ -685,7 +685,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. * @param { InstallParam } installParam - Indicates other parameters required for the installation. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or * 'ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE'. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. @@ -725,7 +725,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. * @param { InstallParam } installParam - Indicates other parameters required for the installation. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or * 'ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE'. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. @@ -767,7 +767,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. * @param { InstallParam } [installParam] - Indicates other parameters required for the installation. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or * 'ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. @@ -810,7 +810,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. * @param { InstallParam } [installParam] - Indicates other parameters required for the installation. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or * 'ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. @@ -855,7 +855,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. * @param { InstallParam } [installParam] - Indicates other parameters required for the installation. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or * 'ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. @@ -901,7 +901,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. * @param { InstallParam } [installParam] - Indicates other parameters required for the installation. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or * 'ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. @@ -1085,7 +1085,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.UNINSTALL_BUNDLE * @param { string } bundleName - Indicates the bundle name of the application to be uninstalled. * @param { InstallParam } installParam - Indicates other parameters required for the uninstall. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.UNINSTALL_BUNDLE'. * @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. @@ -1104,7 +1104,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.UNINSTALL_BUNDLE * @param { string } bundleName - Indicates the bundle name of the application to be uninstalled. * @param { InstallParam } installParam - Indicates other parameters required for the uninstall. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. @@ -1124,7 +1124,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.UNINSTALL_BUNDLE * @param { string } bundleName - Indicates the bundle name of the application to be uninstalled. * @param { InstallParam } installParam - Indicates other parameters required for the uninstall. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. @@ -1145,7 +1145,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.UNINSTALL_BUNDLE * @param { string } bundleName - Indicates the bundle name of the application to be uninstalled. * @param { InstallParam } [installParam] - Indicates other parameters required for the uninstallation. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. @@ -1275,7 +1275,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.RECOVER_BUNDLE * @param { string } bundleName - Indicates the bundle name of the application to be recovered. * @param { InstallParam } installParam - Indicates other parameters required for the recover. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.RECOVER_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. @@ -1291,7 +1291,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.RECOVER_BUNDLE * @param { string } bundleName - Indicates the bundle name of the application to be recovered. * @param { InstallParam } installParam - Indicates other parameters required for the recover. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.RECOVER_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. @@ -1309,7 +1309,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.RECOVER_BUNDLE * @param { string } bundleName - Indicates the bundle name of the application to be recovered. * @param { InstallParam } installParam - Indicates other parameters required for the recover. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.RECOVER_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. @@ -1348,7 +1348,7 @@ declare namespace installer { * * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.UNINSTALL_BUNDLE * @param { UninstallParam } uninstallParam - Indicates parameters required for the uninstall. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. @@ -1503,7 +1503,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_SELF_BUNDLE * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. * @param { InstallParam } installParam - Indicates other parameters required for the installation. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_SELF_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; @@ -1538,7 +1538,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_SELF_BUNDLE * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. * @param { InstallParam } installParam - Indicates other parameters required for the installation. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_SELF_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; @@ -1575,7 +1575,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.UNINSTALL_BUNDLE * @param { string } bundleName - Indicates the bundle name of the application to be uninstalled updates. * @param { InstallParam } installParam - Indicates other parameters required for the uninstall. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. @@ -1592,7 +1592,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.UNINSTALL_BUNDLE * @param { string } bundleName - Indicates the bundle name of the application to be uninstalled updates. * @param { InstallParam } installParam - Indicates other parameters required for the uninstall. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. @@ -1672,7 +1672,7 @@ declare namespace installer { * @param { string } bundleName - Indicates the path where the HAP of the application is stored. * @param { number } appIndex - Indicates the clone application's index. * @param { number } [userId] - userId Indicates the user ID. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.UNINSTALL_CLONE_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. @@ -1692,7 +1692,7 @@ declare namespace installer { * @param { string } bundleName - Indicates the bundleName of clone app. * @param { number } appIndex - Indicates the clone application's index. * @param { DestroyAppCloneParam } [destroyAppCloneParam] - Indicates other parameters required for the uninstallation. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.UNINSTALL_CLONE_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. @@ -1712,7 +1712,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE * @param { string } bundleName - Indicates the bundle name of application. * @param { number } [userId] - userId Indicates the user ID. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. @@ -1729,7 +1729,7 @@ declare namespace installer { * @permission ohos.permission.INSTALL_BUNDLE * @param { string } bundleName - Indicates the bundle name of application. * @param { number } [userId] - userId Indicates the user ID. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. @@ -1751,7 +1751,7 @@ declare namespace installer { * @param { string } hostBundleName - Indicates the bundle name of host application. * @param { Array } pluginFilePaths - Indicates the file paths of plugin. * @param { PluginParam } [pluginParam] - Indicates parameters required for install plugin. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_PLUGIN_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 17700001 - The specified hostBundleName cannot be found or the bundle is not installed by the specified user. @@ -1784,7 +1784,7 @@ declare namespace installer { * @param { string } hostBundleName - Indicates the bundle name of host application. * @param { string } pluginBundleName - Indicates the bundle name of plugin application. * @param { PluginParam } [pluginParam] - Indicates parameters required for uninstall plugin. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.UNINSTALL_PLUGIN_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 17700001 - The specified bundle name is not found. diff --git a/api/@ohos.bundle.overlay.d.ts b/api/@ohos.bundle.overlay.d.ts index 2267ea00e5af3b67d9244f493ed8ce0b8c701309..56f0b171e9dfc5c821d63d75142d85d84d2d6bbc 100755 --- a/api/@ohos.bundle.overlay.d.ts +++ b/api/@ohos.bundle.overlay.d.ts @@ -48,7 +48,7 @@ declare namespace overlay { * * @param { string } moduleName - Indicates the module name of the overlay module to be set. * @param { boolean } isEnabled - The value true means to enable overlay feature, and the value false means to disable overlay feature. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700002 - The specified module name is not found. * @throws { BusinessError } 17700033 - The specified module is not an overlay module. @@ -86,7 +86,7 @@ declare namespace overlay { * @param { string } bundleName - Indicates the application bundle name of the overlay bundle to be set. * @param { string } moduleName - Indicates the module name of the overlay module to be set. * @param { boolean } isEnabled - The value true means to enable overlay feature, and the value false means to disable overlay feature. - * @returns { Promise } + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. @@ -118,7 +118,7 @@ declare namespace overlay { * Obtain the OverlayModuleInfo of current application based on moduleName. * * @param { string } moduleName - Indicates the module name of the overlay module to be queried. - * @returns { Promise } + * @returns { Promise } The result of getting OverlayModuleInfo object. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700002 - The specified module name is not found. * @throws { BusinessError } 17700032 - The specified bundle does not contain any overlay module. @@ -146,7 +146,7 @@ declare namespace overlay { * Obtain the OverlayModuleInfo of current application based on moduleName. * * @param { string } targetModuleName - Indicates the target module name of the target module to be queried. - * @returns { Promise> } + * @returns { Promise> } Returns a list of OverlayModuleInfo object. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700002 - The specified module name is not found. * @throws { BusinessError } 17700034 - The specified module is an overlay module.