xref: /interface/sdk-js/api/@ohos.app.ability.dataUriUtils.d.ts

/*
 * Copyright (c) 2022-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 AbilityKit
 */

/**
 * Utility class used for handling objects that use the DataAbilityHelper scheme.
 *
 * @namespace dataUriUtils
 * @syscap SystemCapability.Ability.AbilityRuntime.Core
 * @since 9
 */
declare namespace dataUriUtils {
  /**
   * Obtains the ID attached to the end of the path component of the given uri.
   *
   * @param { string } uri - Indicates the uri object from which the ID is to be obtained.
   * @returns { number } Returns the ID attached to the end of the path component;
   * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
   * 2. Incorrect parameter types; 3. Parameter verification failed.
   * @syscap SystemCapability.Ability.AbilityRuntime.Core
   * @since 9
   */
  function getId(uri: string): number;

  /**
   * Attaches the given ID to the end of the path component of the given uri.
   *
   * @param { string } uri - Indicates the uri string from which the ID is to be obtained.
   * @param { number } id - Indicates the ID to attach.
   * @returns { string } Returns the uri object with the given ID attached.
   * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
   * 2. Incorrect parameter types; 3. Parameter verification failed.
   * @syscap SystemCapability.Ability.AbilityRuntime.Core
   * @since 9
   */
  function attachId(uri: string, id: number): string;

  /**
   * Deletes the ID from the end of the path component of the given uri.
   *
   * @param { string } uri - Indicates the uri object from which the ID is to be deleted.
   * @returns { string } Returns the uri object with the ID deleted.
   * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
   * 2. Incorrect parameter types; 3. Parameter verification failed.
   * @syscap SystemCapability.Ability.AbilityRuntime.Core
   * @since 9
   */
  function deleteId(uri: string): string;

  /**
   * Updates the ID in the specified uri
   *
   * @param { string } uri - Indicates the uri object to be updated.
   * @param { number } id - Indicates the new ID.
   * @returns { string } Returns the updated uri object.
   * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
   * 2. Incorrect parameter types; 3. Parameter verification failed.
   * @syscap SystemCapability.Ability.AbilityRuntime.Core
   * @since 9
   */
  function updateId(uri: string, id: number): string;
}
export default dataUriUtils;