AbilityInfo

java.lang.Object
- ohos.bundle.AbilityInfo

所有已实现的接口:

Sequenceable
```
public class AbilityInfo
extends Object
implements Sequenceable
```
Obtains configuration information about an ability.

从以下版本开始:

1

嵌套类概要

嵌套类
限定符和类型	类	说明
`static class`	`AbilityInfo.AbilitySubType`	Enumerates subtypes of templates that can be used by an ability.
`static class`	`AbilityInfo.AbilityType`	Enumerates types of templates that can be used by an ability.
`static class`	`AbilityInfo.DisplayOrientation`	Enumerates ability display orientations.
`static class`	`AbilityInfo.LaunchMode`	Enumerates ability launch modes.

从接口继承的嵌套类/接口 ohos.utils.Sequenceable
Sequenceable.Producer<T>

字段概要

字段
限定符和类型	字段	说明
`String`	`bundleName`	Indicates the name of the bundle containing the ability.
`String`	`className`	Indicates the class name of the ability.
`boolean`	`enabled`	Indicates whether or not this ability may be instantiated.
`String`	`label`	Indicates the label of the ability
`static Sequenceable.Producer<AbilityInfo>`	`PRODUCER`	Creates a `AbilityInfo` instance from a `Parcel`.

构造器概要

构造器
构造器	说明
`AbilityInfo()`	Default constructor used to create an `AbilityInfo` instance.
`AbilityInfo(AbilityInfo source)`	A constructor used to create an `AbilityInfo` instance by copying parameters from an existing one.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`void`	`dump(String prefix, PrintWriter writer)`	Prints the ability information into a specified target.
`ApplicationInfo`	`getApplicationInfo()`	Obtains information about the current application.
`int`	`getBackgroundModes()`	Obtains the `backgroundModes` tag of an ability.
`String`	`getBundleName()`	Obtains the name of the bundle containing the ability.
`String`	`getClassName()`	Obtains the class name of an ability.
`int`	`getDefaultFormHeight()`	Obtains the default height of an `AbilityForm`.
`int`	`getDefaultFormWidth()`	Obtains the default width of an `AbilityForm`.
`String`	`getDescription()`	Obtains the description of an ability.
`List<String>`	`getDeviceCapabilities()`	Obtains the device capabilities required for running an ability.
`List<String>`	`getDeviceTypes()`	Obtains the types of devices where an ability can run.
`boolean`	`getFormEnabled()`	Obtains the `formEnabled` tag of an ability.
`int`	`getFormEntity()`	Obtains the area where an `AbilityForm` can be displayed.
`String`	`getIconPath()`	Obtains the path where the icon resource file of an ability is saved.
`String`	`getLabel()`	Obtains the name of an ability that is visible to users or the resource index of the ability name.
`AbilityInfo.LaunchMode`	`getLaunchMode()`	Obtains the launch mode of an ability, either `singleton` or `standard`.
`int`	`getMinFormHeight()`	Obtains the minimum height of an `AbilityForm`.
`int`	`getMinFormWidth()`	Obtains the minimum width of an `AbilityForm`.
`String`	`getModuleName()`	Obtains the `module-name` tag of an ability.
`AbilityInfo.DisplayOrientation`	`getOrientation()`	Obtains the display orientation of an ability.
`String`	`getOriginalClassName()`	Obtains the original class name of an ability.
`List<String>`	`getPermissions()`	Obtains the permissions required for other abilities to call the current ability.
`String`	`getProcess()`	Obtains the name of the process where this ability should run.
`String`	`getReadPermission()`	Obtains the permission required for reading a data ability.
`String`	`getTargetAbility()`	Obtains the target ability that this ability points to.
`AbilityInfo.AbilityType`	`getType()`	Obtains the type of templates used by an ability.
`String`	`getURI()`	Obtains the Uniform Resource Identifier (URI) of an ability.
`String`	`getWritePermission()`	Obtains the permission required for writing a data ability.
`boolean`	`isDifferentName()`	Judge whether the ability is in harmony transition stage.
`boolean`	`isVisible()`	Checks whether an ability can be called by other abilities.
`boolean`	`marshalling(Parcel out)`	Marshals this `Sequenceable` object into a `Parcel`.
`String`	`toString()`	Provide name and hashCode of abilityInfo.
`boolean`	`unmarshalling(Parcel in)`	Unmarshals this `Sequenceable` object from a `Parcel`.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 ohos.utils.Sequenceable
hasFileDescriptor

- 字段详细资料
  - PRODUCER
```
public static final Sequenceable.Producer<AbilityInfo> PRODUCER
```
    Creates a AbilityInfo instance from a Parcel.
    
    从以下版本开始:
    
    4
  - bundleName
```
public String bundleName
```
    Indicates the name of the bundle containing the ability.
  - className
```
public String className
```
    Indicates the class name of the ability.
    The class name is formed by combining the bundle name and the value of the name tag of the ability.
  - enabled
```
public boolean enabled
```
    Indicates whether or not this ability may be instantiated.
  - label
```
public String label
```
    Indicates the label of the ability
- 构造器详细资料
  - AbilityInfo
```
public AbilityInfo()
```
    Default constructor used to create an AbilityInfo instance.
    
    从以下版本开始:
    
    1
  - AbilityInfo
```
public AbilityInfo(AbilityInfo source)
```
    A constructor used to create an AbilityInfo instance by copying parameters from an existing one.
    
    参数:
    
    source - Indicates the AbilityInfo object.
    
    从以下版本开始:
    
    1
- 方法详细资料
  - getLabel
```
public String getLabel()
```
    Obtains the name of an ability that is visible to users or the resource index of the ability name.
    You can configure the label tag in the configuration file. The default value is the value of the name tag, and you can retain the default value.
    
    返回:
    
    Returns the ability name visible to users.
    
    从以下版本开始:
    
    1
  - getDescription
```
public String getDescription()
```
    Obtains the description of an ability.
    The description of an ability can be a character string, or a resource index of the description. You can configure the description in the configuration file. The default value is an empty string, and you can retain the default value.
    
    返回:
    
    Returns the description of the ability.
    
    从以下版本开始:
    
    1
  - getIconPath
```
public String getIconPath()
```
    Obtains the path where the icon resource file of an ability is saved.
    You can configure the icon tag in the configuration file. The default value is an empty string, and you can retain the default value.
    
    返回:
    
    Returns the path storing the icon resource file of the ability.
    
    从以下版本开始:
    
    1
  - isVisible
```
public boolean isVisible()
```
    Checks whether an ability can be called by other abilities.
    You can configure the visible tag in the configuration file. The default value is false, and you can retain the default value.
    
    返回:
    
    Returns true if the ability can be called by other abilities; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getType
```
public AbilityInfo.AbilityType getType()
```
    Obtains the type of templates used by an ability.
    Ability has three types of templates: AbilityType#PAGE with a UI, AbilityType#SERVICE without a UI, and AbilityType#DATA that provides data access services. The type tag must be specified. You must have configured it in the configuration file.
    
    返回:
    
    Returns the type of templates used by the ability.
    
    从以下版本开始:
    
    1
  - getOrientation
```
public AbilityInfo.DisplayOrientation getOrientation()
```
    Obtains the display orientation of an ability.
    orientation is valid only for abilities using the Page template. It can be any of the following values:
    - DisplayOrientation#UNSPECIFIED: The system automatically determines the display orientation of an ability.
    - DisplayOrientation#LANDSCAPE: An ability is displayed in landscape orientation.
    - DisplayOrientation#PORTRAIT: An ability is displayed in portrait orientation.
    - DisplayOrientation#FOLLOWRECENT: An ability is displayed orientation same as the recent ability in stack.
    You can configure this tag in the configuration file. The default value is unspecified, and you can retain the default value.
    返回:
    
    Returns the display orientation of the ability.
    
    从以下版本开始:
    
    1
  - getLaunchMode
```
public AbilityInfo.LaunchMode getLaunchMode()
```
    Obtains the launch mode of an ability, either singleton or standard.
    In LaunchMode#STANDARD pattern, an ability can have multiple instances, while in LaunchMode#SINGLETON pattern, an ability has only a single instance. You can configure the launch-mode tag in the configuration file. The default value is singleton, and you can retain the default value.
    
    返回:
    
    Returns the launch mode of the ability.
    
    从以下版本开始:
    
    1
  - getBundleName
```
public String getBundleName()
```
    Obtains the name of the bundle containing the ability.
    
    返回:
    
    Returns the name of the bundle containing the ability.
    
    从以下版本开始:
    
    1
  - getClassName
```
public String getClassName()
```
    Obtains the class name of an ability.
    The class name is formed by combining the bundle name and the value of the name tag of the ability.
    
    返回:
    
    Returns the class name of the ability.
    
    从以下版本开始:
    
    1
  - getOriginalClassName
```
public String getOriginalClassName()
```
    Obtains the original class name of an ability.
    The shell class name is formed by combining the shell bundle name and the value of the name tag of the shell ability.
    
    返回:
    
    Returns the class name of the ability.
    
    从以下版本开始:
    
    1
  - getPermissions
```
public List<String> getPermissions()
```
    Obtains the permissions required for other abilities to call the current ability.
    Each permission must be a character string, which is usually a reverse domain name. You can specify either predefined permissions or permissions customized by the application. The name of a customized permission specified in this tag must be the same as the value of name of a permission defined in the def-permissions tag. You can configure the permissions tag in the configuration file. The default value is an empty list, and you can retain the default value.
    
    返回:
    
    Returns the list of permissions required for other abilities to call the current ability.
    
    从以下版本开始:
    
    1
  - getDeviceTypes
```
public List<String> getDeviceTypes()
```
    Obtains the types of devices where an ability can run.
    device-type specifies the types of devices running an ability. The predefined types are tv, pc, car, and watch. You can configure this tag in the configuration file.
    
    返回:
    
    Returns the list of device types that can run the ability.
    
    从以下版本开始:
    
    1
  - getDeviceCapabilities
```
public List<String> getDeviceCapabilities()
```
    Obtains the device capabilities required for running an ability.
    device-capability indicates the capabilities that a device should have for running an ability. The capabilities must be consistent with those described in the profile file of the device. You can configure this tag in the configuration file. The default value is an empty list, indicating that no device capabilities are required for running the ability, and you can retain the default value.
    
    返回:
    
    Returns the device capabilities required for running the ability.
    
    从以下版本开始:
    
    1
  - getURI
```
public String getURI()
```
    Obtains the Uniform Resource Identifier (URI) of an ability.
    
    返回:
    
    Returns the URI of the ability; returns an empty string if the URI is not configured.
    
    从以下版本开始:
    
    1
  - isDifferentName
```
public boolean isDifferentName()
```
    Judge whether the ability is in harmony transition stage.
    
    返回:
    
    Returns true if the ability is in harmony transition stage; returns false otherwise.
    
    从以下版本开始:
    
    4
  - getModuleName
```
public String getModuleName()
```
    Obtains the module-name tag of an ability.
    module-name indicates the name of the HAP file which the ability belongs to. This tag is automatically generated by the IDE.
    
    返回:
    
    Returns the name of the HAP file.
    
    从以下版本开始:
    
    1
  - getProcess
```
public String getProcess()
```
    Obtains the name of the process where this ability should run.
    The process name is set in the process attribute of this ability in the config.json file. If it is not set, the process attribute set for the application is used by default.
    
    返回:
    
    Returns the process name.
    
    从以下版本开始:
    
    3
  - getTargetAbility
```
public String getTargetAbility()
```
    Obtains the target ability that this ability points to.
    If you have set the targetAbility attribute for this ability in config.json, this ability is only an ability alias, and the ability specified by targetAbility is the real ability it points to. If the specified target ability cannot be found in the current bundle, config.json will fail to be parsed.
    
    返回:
    
    Returns the class name of the target ability.
    
    从以下版本开始:
    
    3
  - getFormEnabled
```
public boolean getFormEnabled()
```
    Obtains the formEnabled tag of an ability.
    formEnabled specifies whether AbilityForm is enabled for an ability using the Page template. Do not set this tag to true for abilities using any other template. The default value is false, and you can retain the default value.
    
    返回:
    
    Returns true if AbilityForm is enabled for the ability; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getBackgroundModes
```
public int getBackgroundModes()
```
    Obtains the backgroundModes tag of an ability.
    backgroundModes is dedicated to abilities using the Service template. You can use this tag to assign one or more background service modes to an ability. The available background modes and their respective tag values are as follows:
    - data-transfer: Service for downloading, backing up, sharing, or transferring data from the network or peer devices. The tag value is 0b00000001.
    - audio-playback: Audio output service. The tag value is 0b00000010.
    - audio-recording: Audio input service. The tag value is 0b00000010.
    - picture-in-picture: Picture-in-picture and small-window video playback services. The tag value is 0b00000010.
    - voip: Voice/video call and VoIP services. The tag value is 0b00000100.
    - Location: Location and navigation services. The tag value is 0b00001000.
    - bluetooth-interaction: Bluetooth-based scanning, connection, and transmission services (for wearable devices). The tag value is 0b00010000.
    - wifi-interaction: WLAN-based scanning, connection, and transmission services. The tag value is 0b00010000.
    - screen-fetch: Screen recording and screenshot services. The tag value is 0b00100000.
    The final tag value can be the sum of multiple preceding values. You need to use a single value, for example, 0b00000010 or 0b00010000, only once in this tag for your application to have all background modes corresponding to that value.
    返回:
    
    Returns an integer as the sum of all values set for the ability.
    
    从以下版本开始:
    
    1
  - getApplicationInfo
```
public ApplicationInfo getApplicationInfo()
```
    Obtains information about the current application.
    
    返回:
    
    Returns the ApplicationInfo object for the current application.
    
    从以下版本开始:
    
    1
  - getFormEntity
```
public int getFormEntity()
```
    Obtains the area where an AbilityForm can be displayed.
    
    返回:
    
    Returns 1 if the AbilityForm can be displayed on the home screen; returns 2 if it can be displayed on the search interface; returns 3 if it can be displayed on both areas.
    
    从以下版本开始:
    
    1
  - getMinFormHeight
```
public int getMinFormHeight()
```
    Obtains the minimum height of an AbilityForm.
    The initial value is 0. If formEnabled is set to false, this method is invalid.
    
    返回:
    
    Returns the minimum height (in pixels) of the AbilityForm.
    
    从以下版本开始:
    
    1
  - getDefaultFormHeight
```
public int getDefaultFormHeight()
```
    Obtains the default height of an AbilityForm.
    The initial value is 0. If formEnabled is set to false, this method is invalid.
    
    返回:
    
    Returns the default height (in pixels) of the AbilityForm.
    
    从以下版本开始:
    
    1
  - getMinFormWidth
```
public int getMinFormWidth()
```
    Obtains the minimum width of an AbilityForm.
    The initial value is 0. If formEnabled is set to false, this method is invalid.
    
    返回:
    
    Returns the minimum width (in pixels) of the AbilityForm.
    
    从以下版本开始:
    
    1
  - getDefaultFormWidth
```
public int getDefaultFormWidth()
```
    Obtains the default width of an AbilityForm.
    The initial value is 0. If formEnabled is set to false, this method is invalid.
    
    返回:
    
    Returns the default width (in pixels) of the AbilityForm.
    
    从以下版本开始:
    
    1
  - getReadPermission
```
public String getReadPermission()
```
    Obtains the permission required for reading a data ability.
    
    返回:
    
    Returns the value of read permission.
    
    从以下版本开始:
    
    4
  - getWritePermission
```
public String getWritePermission()
```
    Obtains the permission required for writing a data ability.
    
    返回:
    
    Returns the write permission.
    
    从以下版本开始:
    
    4
  - marshalling
```
public boolean marshalling(Parcel out)
```
    从接口复制的说明: Sequenceable
    
    Marshals this Sequenceable object into a Parcel.
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    out - Indicates the Parcel object to which the Sequenceable object will be marshaled..
    
    返回:
    
    Returns true if the marshalling is successful; returns false otherwise.
    
    另请参阅:
    
    Sequenceable.marshalling(Parcel)
  - unmarshalling
```
public boolean unmarshalling(Parcel in)
```
    从接口复制的说明: Sequenceable
    
    Unmarshals this Sequenceable object from a Parcel.
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    in - Indicates the Parcel object into which the Sequenceable object has been marshaled.
    
    返回:
    
    Returns true if the unmarshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    Sequenceable.unmarshalling(Parcel)
  - dump
```
public void dump(String prefix,
                 PrintWriter writer)
          throws IllegalArgumentException
```
    Prints the ability information into a specified target.
    
    参数:
    
    prefix - Indicates the prefix of the attribute names contained in the printed information.
    
    writer - Indicates the target into which the information will be printed.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if an input parameter is illegal.
    
    从以下版本开始:
    
    4
  - toString
```
public String toString()
```
    Provide name and hashCode of abilityInfo.
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    Info in String format.

类 AbilityInfo

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 ohos.utils.Sequenceable

字段详细资料

PRODUCER

bundleName

className

enabled

label

构造器详细资料

AbilityInfo

AbilityInfo

方法详细资料

getLabel

getDescription

getIconPath

isVisible

getType

getOrientation

getLaunchMode

getBundleName

getClassName

getOriginalClassName

getPermissions

getDeviceTypes

getDeviceCapabilities

getURI

isDifferentName

getModuleName

getProcess

getTargetAbility

getFormEnabled

getBackgroundModes

getApplicationInfo

getFormEntity

getMinFormHeight

getDefaultFormHeight

getMinFormWidth

getDefaultFormWidth

getReadPermission

getWritePermission

marshalling

unmarshalling

dump

toString