interface_sdk-js/api/@ohos.ability.featureAbility.d.ts

/*
 * Copyright (c) 2021-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';
import { Callback } from './@ohos.base';
import Want from './@ohos.app.ability.Want';
import { StartAbilityParameter } from './ability/startAbilityParameter';
import { AbilityResult } from './ability/abilityResult';
import { AppVersionInfo as _AppVersionInfo } from './app/appVersionInfo';
import { Context as _Context } from './app/context';
import { DataAbilityHelper } from './ability/dataAbilityHelper';
import { ConnectOptions } from './ability/connectOptions';
import { ProcessInfo as _ProcessInfo } from './app/processInfo';
import window from './@ohos.window';

/**
 * A Feature Ability represents an ability with a UI and is designed to interact with users.
 * @name featureAbility
 * @since 6
 * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
 * @permission N/A
 * @FAModelOnly
 */
declare namespace featureAbility {
  /**
   * Obtain the want sent from the source ability.
   *
   * @since 6
   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
   * @param parameter Indicates the ability to start.
   * @returns -
   * @FAModelOnly
   */
  function getWant(callback: AsyncCallback<Want>): void;
  function getWant(): Promise<Want>;

  /**
   * Starts a new ability.
   *
   * @since 6
   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
   * @param parameter Indicates the ability to start.
   * @returns -
   * @FAModelOnly
   */
  function startAbility(parameter: StartAbilityParameter, callback: AsyncCallback<number>): void;
  function startAbility(parameter: StartAbilityParameter): Promise<number>;

  /**
   * Obtains the application context.
   *
   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
   * @returns Returns the application context.
   * @since 6
   * @FAModelOnly
   */
  function getContext(): Context;

  /**
   * Starts an ability and returns the execution result when the ability is destroyed.
   *
   * @since 7
   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
   * @param parameter Indicates the ability to start.
   * @returns Returns the {@link AbilityResult}.
   * @FAModelOnly
   */
  function startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback<AbilityResult>): void;
  function startAbilityForResult(parameter: StartAbilityParameter): Promise<AbilityResult>;

  /**
   * Sets the result code and data to be returned by this Page ability to the caller
   * and destroys this Page ability.
   *
   * @since 7
   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
   * @param parameter Indicates the result to return.
   * @returns -
   * @FAModelOnly
   */
  function terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<void>): void;
  function terminateSelfWithResult(parameter: AbilityResult): Promise<void>;

  /**
   * Destroys this Page ability.
   *
   * @since 7
   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
   * @returns -
   * @FAModelOnly
   */
  function terminateSelf(callback: AsyncCallback<void>): void;
  function terminateSelf(): Promise<void>;

  /**
   * Obtains the dataAbilityHelper.
   *
   * @since 7
   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
   * @param uri Indicates the path of the file to open.
   * @returns Returns the dataAbilityHelper.
   * @FAModelOnly
   */
  function acquireDataAbilityHelper(uri: string): DataAbilityHelper;

  /**
   * Checks whether the main window of this ability has window focus.
   *
   * @since 7
   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
   * @returns Returns {@code true} if this ability currently has window focus; returns {@code false} otherwise.
   * @FAModelOnly
   */
  function hasWindowFocus(callback: AsyncCallback<boolean>): void;
  function hasWindowFocus(): Promise<boolean>;

  /**
   * Connects the current ability to an ability using the AbilityInfo.AbilityType.SERVICE template.
   * @default -
   * @since 7
   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
   * @param request The element name of the service ability
   * @param options The remote object instance
   * @returns Returns the number code of the ability connected
   * @FAModelOnly
   */
  function connectAbility(request: Want, options: ConnectOptions): number;

  /**
  * The callback interface was connect successfully.
  * @default -
  * @since 7
  * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
  * @param connection The number code of the ability connected
  * @FAModelOnly
  */
  function disconnectAbility(connection: number, callback: AsyncCallback<void>): void;
  function disconnectAbility(connection: number): Promise<void>;

  /**
   * Obtains the window corresponding to the current ability.
   *
   * @since 7
   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
   * @returns Returns the window corresponding to the current ability.
   * @FAModelOnly
   */
  function getWindow(callback: AsyncCallback<window.Window>): void;
  function getWindow(): Promise<window.Window>;

  /**
   * Obtain the window configuration.
   * 
   * @since 7
   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
   * @FAModelOnly
   */
  export enum AbilityWindowConfiguration {
    WINDOW_MODE_UNDEFINED = 0,
    WINDOW_MODE_FULLSCREEN = 1,
    WINDOW_MODE_SPLIT_PRIMARY = 100,
    WINDOW_MODE_SPLIT_SECONDARY = 101,
    WINDOW_MODE_FLOATING = 102
  }

  /**
   * Obtain the window properties.
   * 
   * @since 7
   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
   * @FAModelOnly
   */
  export enum AbilityStartSetting {
    BOUNDS_KEY = "abilityBounds",
    WINDOW_MODE_KEY = "windowMode",
    DISPLAY_ID_KEY = "displayId"
  }

  /**
   * Obtain the errorCode.
   * 
   * @since 7
   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
   * @FAModelOnly
   */
  export enum ErrorCode {
    NO_ERROR = 0,
    INVALID_PARAMETER = -1,
    ABILITY_NOT_FOUND = -2,
    PERMISSION_DENY = -3
  }

  /**
   * Indicates the operation type of data.
   * 
   * @since 7
   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
   * @FAModelOnly
   */
  export enum DataAbilityOperationType {
    TYPE_INSERT = 1,
    TYPE_UPDATE = 2,
    TYPE_DELETE = 3,
    TYPE_ASSERT = 4,
  }

  /**
   * The context of an ability or an application.  It allows access to
   * application-specific resources, request and verification permissions.
   * Can only be obtained through the ability.
   *
   * @since 9
   * @syscap SystemCapability.Ability.AbilityRuntime.Core
   * @FAModelOnly
   */
  export type Context = _Context

  /**
   * Defines an AppVersionInfo object.
   * @since 9
   * @syscap SystemCapability.Ability.AbilityRuntime.Core
   */
  export type AppVersionInfo = _AppVersionInfo

  /**
   * @name This class saves process information about an application
   * @since 9
   * @syscap SystemCapability.Ability.AbilityRuntime.Core
   */
  export type ProcessInfo = _ProcessInfo
}
export default featureAbility;