/*
 * Copyright (c) 2022 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 { AsyncCallback } from './@ohos.base';

/**
 * Provides file path related APIS.
 *
 * @namespace configPolicy
 * @syscap SystemCapability.Customization.ConfigPolicy
 * @systemapi
 * @since 8
 */
declare namespace configPolicy {
  /**
   * Get file from the highest priority config path which contains the given file name.
   *
   * @param { string } relPath the relative path of the config file.
   * @param { AsyncCallback<string> } callback contains the path of the highest priority config file.
   * @throws { BusinessError } 401 - invalid input parameter.
   * @syscap SystemCapability.Customization.ConfigPolicy
   * @systemapi Hide this for inner system use.
   * @since 8
   */
  function getOneCfgFile(relPath: string, callback: AsyncCallback<string>);

  /**
   * Get file from the highest priority config path which contains the given file name.
   *
   * @param { string } relPath the relative path of the config file.
   * @returns { Promise<string> } the promise returns the path of the highest priority config file.
   * @throws { BusinessError } 401 - invalid input parameter.
   * @syscap SystemCapability.Customization.ConfigPolicy
   * @systemapi Hide this for inner system use.
   * @since 8
   */
  function getOneCfgFile(relPath: string): Promise<string>;

  /**
   * Get config files in device architecture, ordered by priority from low to high.
   *
   * @param { string } relPath the relative path of the config file.
   * @param { AsyncCallback<Array<string>> } callback contains paths of config files.
   * @throws { BusinessError } 401 - invalid input parameter.
   * @syscap SystemCapability.Customization.ConfigPolicy
   * @systemapi Hide this for inner system use.
   * @since 8
   */
  function getCfgFiles(relPath: string, callback: AsyncCallback<Array<string>>);

  /**
   * Get config files in device architecture, ordered by priority from low to high.
   *
   * @param { string } relPath the relative path of the config file.
   * @returns { Promise<Array<string>> } the promise returns paths of config files.
   * @throws { BusinessError } 401 - invalid input parameter.
   * @syscap SystemCapability.Customization.ConfigPolicy
   * @systemapi Hide this for inner system use.
   * @since 8
   */
  function getCfgFiles(relPath: string): Promise<Array<string>>;

  /**
   * Get config directories in device architecture, ordered by priority from low to high.
   *
   * @param { AsyncCallback<Array<string>> } callback contains paths of config directories.
   * @throws { BusinessError } 401 - invalid input parameter.
   * @syscap SystemCapability.Customization.ConfigPolicy
   * @systemapi Hide this for inner system use.
   * @since 8
   */
  function getCfgDirList(callback: AsyncCallback<Array<string>>);

  /**
   * Get config directories in device architecture, ordered by priority from low to high.
   *
   * @returns { Promise<Array<string>> } the promise returns paths of config directories.
   * @throws { BusinessError } 401 - invalid input parameter.
   * @syscap SystemCapability.Customization.ConfigPolicy
   * @systemapi Hide this for inner system use.
   * @since 8
   */
  function getCfgDirList(): Promise<Array<string>>;
}

export default configPolicy;