mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 14:13:45 +00:00
81 lines
2.6 KiB
TypeScript
81 lines
2.6 KiB
TypeScript
/*
|
|
* Copyright (C) 2021-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.
|
|
*/
|
|
|
|
import type { AsyncCallback } from './@ohos.base';
|
|
|
|
/**
|
|
* Provides Environment APIs.
|
|
*
|
|
* @namespace Environment
|
|
* @syscap SystemCapability.FileManagement.File.Environment
|
|
* @systemapi
|
|
* @since 8
|
|
*/
|
|
declare namespace Environment {
|
|
/**
|
|
* Get the user data path.
|
|
*
|
|
* @returns { Promise<string> } return Promise
|
|
* @throws { BusinessError } 202 - The caller is not a system application
|
|
* @throws { BusinessError } 13900020 - Invalid argument
|
|
* @throws { BusinessError } 13900042 - Unknown error
|
|
* @syscap SystemCapability.FileManagement.File.Environment
|
|
* @systemapi
|
|
* @since 8
|
|
*/
|
|
function getStorageDataDir(): Promise<string>;
|
|
|
|
/**
|
|
* Get the user data path.
|
|
*
|
|
* @param { AsyncCallback<string> } [callback] - callback
|
|
* @throws { BusinessError } 202 - The caller is not a system application
|
|
* @throws { BusinessError } 13900020 - Invalid argument
|
|
* @throws { BusinessError } 13900042 - Unknown error
|
|
* @syscap SystemCapability.FileManagement.File.Environment
|
|
* @systemapi
|
|
* @since 8
|
|
*/
|
|
function getStorageDataDir(callback: AsyncCallback<string>): void;
|
|
|
|
/**
|
|
* Get the User storage path.
|
|
*
|
|
* @returns { Promise<string> } return Promise
|
|
* @throws { BusinessError } 202 - The caller is not a system application
|
|
* @throws { BusinessError } 13900020 - Invalid argument
|
|
* @throws { BusinessError } 13900042 - Unknown error
|
|
* @syscap SystemCapability.FileManagement.File.Environment
|
|
* @systemapi
|
|
* @since 8
|
|
*/
|
|
function getUserDataDir(): Promise<string>;
|
|
|
|
/**
|
|
* Get the User storage path.
|
|
*
|
|
* @param { AsyncCallback<string> } [callback] - callback
|
|
* @throws { BusinessError } 202 - The caller is not a system application
|
|
* @throws { BusinessError } 13900020 - Invalid argument
|
|
* @throws { BusinessError } 13900042 - Unknown error
|
|
* @syscap SystemCapability.FileManagement.File.Environment
|
|
* @systemapi
|
|
* @since 8
|
|
*/
|
|
function getUserDataDir(callback: AsyncCallback<string>): void;
|
|
}
|
|
|
|
export default Environment;
|