AbilitySlice

java.lang.Object
- ohos.app.AbilityContext
- - ohos.aafwk.ability.AbilitySlice

所有已实现的接口:

ILifecycle, Context
```
public class AbilitySlice
extends AbilityContext
implements ILifecycle
```
As the fundamental unit of the Ability using the Page template, AbilitySlice provides an ability with a carrier for service logic and UI display.
An ability can have multiple ability slices. You must override the Ability#onStart(Intent) method to specify the default ability slice. This default route is specified by using Ability#setMainRoute(String) .

You can inherit the AbilitySlice class to implement your own ability slices and set their UI in the onStart(ohos.aafwk.content.Intent) method. The UI can be set by using setUIContent(ohos.agp.components.ComponentContainer) or setUIContent(int). Generally, in the entire lifecycle of an ability slice, the UI needs to be set only once. Example code:
```
 public class MyAbilitySlice extends AbilitySlice {
     protected void onStart(Intent intent) {
         super.onStart(intent);
         // setup UI content from a layout resource
         setUIContent(R.res.layout);
     }
 }
```
You can use the present(ohos.aafwk.ability.AbilitySlice,ohos.aafwk.content.Intent) method to present a new ability slice or use the startAbility(ohos.aafwk.content.Intent) method to start a new ability.

An ability slice must always be hosted in an ability, and its lifecycle changes along with that of the ability. An ability slice also has its independent lifecycle changes, which occur during the switching of ability slices.

Note: In most cases, you are responsible for creating and maintaining ability slice instances. However, the system creates instances in certain scenarios. For example, the system creates an ability slice instance during the first start of an ability. This requires that all AbilitySlice child classes have a default no-argument constructor. As defined in Java, the compiler provides a default no-argument constructor for the class only if you do not explicitly declare a parameterized constructor. Therefore, when overriding a AbilitySlice child class, you must explicitly declare a no-argument constructor if your implementation has a parameterized constructor.

Entry of an Ability Using the Page Template

You can specify multiple action entries and a default main entry for an ability. Each entry represents the capabilities and UI that the ability can provide. When an ability is started, the system matches the action field in the transferred Intent against the entries defined. If a specified ability slice is found, the system starts it. If the action field is not specified in the transferred Intent or the action field in the transferred Intent does not match any entry defined, the default ability slice is displayed.

The code below shows how to set the entry to an ability:
```
 public class MainAbility extends Ability {
     public void onStart(Intent intent) {
         super.onStart(intent);
         // set the main entry
         setMainRoute(MainSlice.class.getName());

         // add action for ability
         addActionRoute("action.pay", PaySlice.class.getName());
         addActionRoute("action.scan", ScanSlice.class.getName());
     }
 }
 
```
The preceding code defines only the entry route at runtime. To expose the ability's capabilities to other abilities, you must register the action field in the configuration file config.json. Example code:
```
 {
     "module":{
         ...
         "abilities":[
           {
               ...
               "description": "Main ability of hiworld",
               "name": ".MainAbility",
               "label": "main ability",
               "icon": "main-ability.png",
               "type": "page",
               "visible": true,
               "orientation": "unspecified",
               "launch-mode": "standard",
               "skills"[
                   {
                       "actions":[
                           "action.pay",
                           "action.scan"
                       ]
                   }
               ]
               ...
           }
         ]
         ...
     }
 }
 
```
After the supported actions are registered in the preceding way, other abilities can use your ability through the specified actions and directly open the corresponding ability slices. Example code:
```
     
     Intent intent = new Intent();
     Operation operation = new Intent.OperationBuilder()
             .withAction("action.pay")
             .withDeviceId("")
             .withBundleName("xxx")
             .withAbilityName("yyy")
             .build();
     intent.setOperation(operation);
     startAbility(intent);
     
 
```
AbilitySlice Lifecycle

An ability slice's lifecycle is bound to the ability that hosts it. An ability slice has the same lifecycle states and lifecycle callback methods as the host ability. Once the lifecycle state of an ability changes, its ability slices undergo the same change, and the same callback method is called. An ability slice can also have its independent lifecycle changes. This independent change occurs during the switching of the ability slices in the ability. However, such a switching does not affect the host ability's lifecycle.

An ability slice has the following four lifecycle states:
- INITIAL: The ability slice is loaded to the memory but is not running. It is the initial state of all ability slices.
- INACTIVE: The ability slice has been loaded and executed but is not interactive. Generally, it is an intermediate state before the ability slice changes to ACTIVE or BACKGROUND. The UI of an ability slice in this state may be visible but cannot receive input events.
- ACTIVE: The ability slice is visible and interactive. It is considered that the ability slice has focus.
- BACKGROUND: The ability slice is invisible. If the host ability is also in the background, the ability and ability slices are destroyed in the case of insufficient memory.
Similar to an ability, an ability slice provides the following lifecycle callback methods. You can override them.
```
 
  public class MainAbilitySlice extends AbilitySlice {
      protected void onStart(Intent intent);

      protected void onActive();

      protected void onInactive();

      protected void onForeground(Intent intent);

      protected void onBackground();

      protected void onStop();
  }
 
 
```
The figure below shows a complete lifecycle of an ability slice. An ability slice can be in only one state at any time. Not all states support direct transition.

Note: The onStart(ohos.aafwk.content.Intent) method can be called only once in the entire lifecycle.

The meaning of each lifecycle callback method and some best practice suggestions is provided below.
- onStart(ohos.aafwk.content.Intent): You must implement this method for UI initialization settings, for example, setUIContent(int). This method can be called only once in the entire lifecycle. The caller may carry some customized key-values by using Intent class, and obtain these parameters through the methods provided by intent.
- onActive(): This method is called back when an ability slice returns to the Active state. After the callback, the UI is interactive.
- onInactive(): This method is called back when an ability slice is completely or partially covered. After the callback, the UI is not interactive.
- onForeground(ohos.aafwk.content.Intent) ()}: This method is called back when an ability slice returns to the foreground. The interaction logic of the application can be restored or initialized in the callback. If a new customized parameter needs to be specified when the ability slice returns to the foreground, you can transfer a new intent parameter.
- onBackground(): This method is called back when an ability slice has entered the background. In this state, you cannot perform background tasks for a long time, since the system may stop the running of a background program at any time.
- onStop(): This method is called back to destroy an ability slice. You can use this method to reclaim resources.
Switching Between Ability Slices

You can use the present(ohos.aafwk.ability.AbilitySlice,ohos.aafwk.content.Intent) method to present a new ability slice, and transfer customized parameters using Intent. Example code:
```
 
     Button button = new Button(this);
     button.setClickedListener(listener -> {
         AbilitySlice targetSlice = new MyAbilitySlice();
         Intent intent = new Intent();
         intent.setParam("value", 10);
         present(targetSlice, intent);
     });
 
 
```
Note: A maximum of 1024 ability slices in an ability can be presented simultaneously. If you attempt to present the 1025th ability slice, the system will forcibly crash the ability. To avoid this situation, you must improve the code if a large number of ability slices need to be presented simultaneously.
从以下版本开始:

1

SystemCapability

SystemCapability.Aafwk#ABILITY

嵌套类概要

嵌套类
限定符和类型	类	说明
`static interface`	`AbilitySlice.FormCallback`	Provides callbacks that will be invoked when a `Form` instance is obtained or when the `Form` provider is uninstalled.

字段概要

字段
限定符和类型	字段	说明
`static String`	`PARAM_FORM_CUSTOMIZE_KEY`	Indicates the key used for passing custom data to the form provider when you call {@link #acquireForm(ohos.aafwk.content.Intent,ohos.aafwk.ability.AbilitySlice.FormCallback), which is represented as `intent.setParam(PARAM_FORM_CUSTOMIZE_KEY, intentParams)`.
`static String`	`PARAM_FORM_DIMENSION_KEY`	Indicates the key specifying the grid style of the form to be obtained, which is represented as `intent.setParam(PARAM_FORM_DIMENSION_KEY, 1)`.
`static String`	`PARAM_FORM_HEIGHT_KEY`	Indicates the key specifying the height of the form to be obtained, which is represented as `intent.setParam(PARAM_FORM_HEIGHT_KEY, 400)`.
`static String`	`PARAM_FORM_ID_KEY`	已过时。 This change is effective since API version 5. Replaced by `PARAM_FORM_IDENTITY_KEY`.
`static String`	`PARAM_FORM_IDENTITY_KEY`	Indicates the key specifying the ID of the form to be obtained, which is represented as `intent.setParam(PARAM_FORM_IDENTITY_KEY, 1L)`.
`static String`	`PARAM_FORM_NAME_KEY`	Indicates the key specifying the name of the form to be obtained, which is represented as `intent.setParam(PARAM_FORM_NAME_KEY, "formName")`.
`static String`	`PARAM_FORM_TEMPORARY_KEY`	Indicates the key specifying whether a form is temporary, which is represented as `intent.setParam(PARAM_FORM_TEMPORARY_KEY, true)`.
`static String`	`PARAM_FORM_WIDTH_KEY`	Indicates the key specifying the width of the form to be obtained, which is represented as `intent.setParam(PARAM_FORM_WIDTH_KEY, 800)`.
`static String`	`PARAM_MODULE_NAME_KEY`	Indicates the key specifying the name of the module to which the form to be obtained belongs, which is represented as `intent.setParam(PARAM_MODULE_NAME_KEY, "formEntry")`.

从接口继承的字段 ohos.app.Context
CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESOUCE_ONLY, CONTEXT_RESTRICTED, MODE_APPEND, MODE_PRIVATE

构造器概要

构造器
构造器说明

AbilitySlice()

构造器
构造器	说明
`AbilitySlice()`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法	说明
`boolean`	`acquireAbilityFormAsync(Intent intent, AbilityForm.OnAcquiredCallback acquiredCallback)`	Requests the `AbilityForm` instance provided by the target ability.
`boolean`	`acquireForm(Intent intent, AbilitySlice.FormCallback callback)`	Obtains a specified form that matches the application bundle name, module name, form name, form grid style, and other related information specified in the passed `Intent`.
`void`	`acquireFormState(Intent intent, AbilitySlice.FormCallback callback)`	Obtains the state of the form that matches the application bundle name, module name, form name, form grid style, and other related information specified in the passed `intent`.
`boolean`	`castTempForm(long formId)`	Converts a specified temporary form that has been obtained by the application into a normal form.
`int`	`checkAndDeleteInvalidForms(List<Long> persistedIds)`	Checks for and deletes invalid forms of the application in the Form Manager Service based on the list of valid form IDs passed.
`boolean`	`connectAbility(Intent intent, IAbilityConnection conn)`	Connects the host ability to an ability that uses the Service template.
`void`	`continueAbility()`	Migrates the host ability to another device on the same distributed network.
`void`	`continueAbility(String deviceId)`	Migrates the host ability to the given device on the same distributed network.
`void`	`continueAbilityReversibly()`	Migrates the host ability to another device on the same distributed network in a reversible way that allows the ability to be migrated back to the local device through `reverseContinueAbility()`.
`void`	`continueAbilityReversibly(String deviceId)`	Migrates the host ability to another device on the same distributed network in a reversible way that allows the ability to be migrated back to the local device through `reverseContinueAbility()`.
`boolean`	`deleteForm(int formId)`	已过时。 This change is effective since API version 5. Replaced by `deleteForm(long)`.
`boolean`	`deleteForm(long formId)`	Deletes an obtained form by its ID.
`void`	`disconnectAbility(IAbilityConnection conn)`	Disconnects the host ability from an ability that uses the Service template.
`<T extends Component> T`	`findComponentById(int resId)`	Finds a component in the XML file based on the resource ID.
`Ability`	`getAbility()`	Obtains the host ability of this `AbilitySlice`.
`List<FormInfo>`	`getAllForms()`	已过时。 This change is effective since API version 5. Replaced by `getAllFormsInfo()`.
`List<FormInfo>`	`getAllFormsInfo()`	Obtains the `FormInfo` objects provided by all applications on the device.
`IContinuationRegisterManager`	`getContinuationRegisterManager()`	Obtains an `IContinuationRegisterManager` object.
`ContinuationState`	`getContinuationState()`	Obtains the migration state of the host ability.
`List<FormInfo>`	`getFormsByApp(String bundleName)`	已过时。 This change is effective since API version 5. Replaced by `getFormsInfoByApp(java.lang.String)`.
`List<FormInfo>`	`getFormsByModule(String bundleName, String moduleName)`	已过时。 This change is effective since API version 5. Replaced by `getFormsInfoByModule(java.lang.String,java.lang.String)`.
`List<FormInfo>`	`getFormsInfoByApp(String bundleName)`	Obtains the `FormInfo` objects provided by a specified application on the device.
`List<FormInfo>`	`getFormsInfoByModule(String bundleName, String moduleName)`	Obtains the `FormInfo` objects provided by a specified application module on the device.
`WindowManager.LayoutConfig`	`getLayoutParams()`	Obtains window layout parameters of an ability.
`Lifecycle`	`getLifecycle()`	Obtains the `Lifecycle` object of the current ability slice.
`String`	`getOriginalDeviceId()`	Obtains the ID of the source device from which the host ability is migrated.
`AbilitySliceLifecycleExecutor.LifecycleState`	`getState()`	Obtains the lifecycle state of this ability slice.
`Window`	`getWindow()`	Obtains the window corresponding to the current ability.
`void`	`notifyInvisibleForms(List<Long> formIds)`	Sends a notification to the form framework to make the specified forms invisible.
`void`	`notifyVisibleForms(List<Long> formIds)`	Sends a notification to the form framework to make the specified forms visible.
`protected void`	`onAbilityResult(int requestCode, int resultCode, Intent resultData)`	Called when `startAbilityForResult(ohos.aafwk.content.Intent,int)` is called to start an ability and the result is returned.
`protected void`	`onActive()`	Called back when an ability slice enters the ACTIVE state.
`protected void`	`onBackground()`	Called back when an ability slice enters the BACKGROUND state.
`protected void`	`onBackPressed()`	Called back when the Back key is pressed.
`protected void`	`onForeground(Intent intent)`	Called back when the state of an ability slice changes from BACKGROUND to INACTIVE.
`boolean`	`onHotkeyTriggered(int keyCode, KeyEvent keyEvent)`	Called when a hotkey is pressed.
`protected void`	`onInactive()`	Called back when an ability slice enters the INACTIVE state.
`boolean`	`onKeyDown(int keyCode, KeyEvent keyEvent)`	Called when a key is pressed.
`boolean`	`onKeyPressAndHold(int keyCode, KeyEvent keyEvent)`	Called when a key is pressed and held.
`boolean`	`onKeyUp(int keyCode, KeyEvent keyEvent)`	Called when a key is released.
`protected void`	`onOrientationChanged(AbilityInfo.DisplayOrientation displayOrientation)`	Called back when the display orientation of a screen changes.
`protected void`	`onResult(int requestCode, Intent resultIntent)`	Called back when the result of the `presentForResult(ohos.aafwk.ability.AbilitySlice,ohos.aafwk.content.Intent,int)` method is returned.
`protected void`	`onStart(Intent intent)`	Called back when an ability slice is started.
`protected void`	`onStop()`	Called back before an ability slice is destroyed.
`void`	`postTask(Runnable task, long delayTime)`	Posts a scheduled `Runnable` task to a new non-UI thread.
`void`	`present(AbilitySlice targetSlice, Intent intent)`	Presents another ability slice, which can be an ability slice that is not started or an existing ability slice in the host ability.
`void`	`presentForResult(AbilitySlice targetSlice, Intent intent, int requestCode)`	Presents another ability slice and returns the result set by the target ability slice by calling `setResult(ohos.aafwk.content.Intent)`.
`void`	`releaseAbilityForm(AbilityForm abilityForm)`	Releases a specified `AbilityForm` instance of the host ability.
`boolean`	`releaseForm(int formId)`	已过时。 This change is effective since API version 5. Replaced by `releaseForm(long)`.
`boolean`	`releaseForm(long formId)`	Releases an obtained form by its ID.
`boolean`	`releaseForm(long formId, boolean isReleaseCache)`	Releases an obtained form by its ID.
`boolean`	`requestForm(int formId)`	已过时。 This change is effective since API version 5. Replaced by `requestForm(long)`.
`boolean`	`requestForm(long formId)`	Requests for form data update.
`boolean`	`requestForm(long formId, Intent intent)`	已过时。 This change is effective since API version 5. Replaced by `requestForm(long)`.
`boolean`	`reverseContinueAbility()`	Migrates the host ability from another device on the same distributed network back to the local device.
`void`	`setDisplayOrientation(AbilityInfo.DisplayOrientation requestedOrientation)`	Sets the display orientation of the host ability.
`void`	`setIsAmbientMode(boolean isEnabled)`	sets input AOD mode for window
`void`	`setLayoutParams(WindowManager.LayoutConfig params)`	Sets window layout parameters of an ability.
`void`	`setResult(Intent resultData)`	Sets the data to be returned when an ability slice is destroyed.
`void`	`setUIContent(int layoutRes)`	Inflates layout resources by using the layout resource ID.
`void`	`setUIContent(ComponentContainer componentContainer)`	Inflates UI controls by using `ComponentContainer`.
`void`	`startAbility(Intent intent)`	Starts a new ability.
`void`	`startAbility(Intent intent, AbilityStartSetting abilityStartSetting)`	Starts a new ability with specific start settings.
`void`	`startAbilityForResult(Intent intent, int requestCode)`	Starts an ability and returns the execution result when the ability is destroyed.
`void`	`startAbilityForResult(Intent intent, int requestCode, AbilityStartSetting abilityStartSetting)`	Starts an ability with specific start settings and returns the execution result when the ability is destroyed.
`boolean`	`stopAbility(Intent intent)`	Destroys an ability that uses the Service template.
`void`	`terminate()`	Destroys the current ability slice.
`void`	`terminateAbility()`	Destroys the host ability.
`String`	`toString()`	Provide impl and corresponding slice info for easy human reading traces.

从类继承的方法 ohos.app.AbilityContext
attachBaseContext, canRequestPermission, compelVerifyCallerPermission, compelVerifyCallerUriPermission, compelVerifyPermission, compelVerifyPermission, compelVerifyUriPermission, compelVerifyUriPermission, compelVerifyUriPermission, createBundleContext, createParallelTaskDispatcher, createSerialTaskDispatcher, deleteFile, displayUnlockMissionMessage, getAbilityInfo, getAbilityManager, getAbilityPackageContext, getApplicationContext, getApplicationInfo, getAppType, getBundleCodePath, getBundleManager, getBundleName, getBundleResourcePath, getCacheDir, getCaller, getCallingAbility, getCallingBundle, getClassloader, getCodeCacheDir, getColor, getColorMode, getContext, getDatabaseDir, getDataDir, getDir, getDisplayOrientation, getDistributedDir, getElementName, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getGlobalTaskDispatcher, getHapModuleInfo, getIntArray, getLastStoredDataWhenConfigChanged, getLocalClassName, getMainTaskDispatcher, getNoBackupFilesDir, getPattern, getPreferencesDir, getProcessInfo, getProcessName, getResourceManager, getResourceManager, getString, getString, getStringArray, getTheme, getThemeId, getUITaskDispatcher, init, isCredentialEncryptedStorage, isDeviceEncryptedStorage, isUpdatingConfigurations, lockMission, printDrawnCompleted, requestPermissionsFromUser, restart, setColorMode, setPattern, setShowOnLockScreen, setTheme, setTransitionAnimation, setWakeUpScreen, startAbilities, startAbility, startAbility, startAbility, switchToCredentialEncryptedStorageContext, switchToDeviceEncryptedStorageContext, terminateAbility, terminateAbilityResult, unlockMission, verifyCallingOrSelfPermission, verifyCallingPermission, verifyPermission, verifySelfPermission

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

- 字段详细资料
  - PARAM_FORM_CUSTOMIZE_KEY
```
public static final String PARAM_FORM_CUSTOMIZE_KEY
```
    Indicates the key used for passing custom data to the form provider when you call {@link #acquireForm(ohos.aafwk.content.Intent,ohos.aafwk.ability.AbilitySlice.FormCallback), which is represented as intent.setParam(PARAM_FORM_CUSTOMIZE_KEY, intentParams). You can put the custom data in an IntentParams object and then set this object to the Intent used as an input parameter of {@link #acquireForm(Intent, FormCallback). Currently, the following data types are available for setting custom data. If an unavailable data type is used, IllegalArgumentException is thrown.
    - boolean
    - byte
    - char
    - short
    - int
    - long
    - float
    - double
    - String
    - CharSequence
    - List
    - boolean[]
    - byte[]
    - char[]
    - short[]
    - int[]
    - long[]
    - float[]
    - double[]
    - String[]
    - CharSequence[]
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - PARAM_FORM_DIMENSION_KEY
```
public static final String PARAM_FORM_DIMENSION_KEY
```
    Indicates the key specifying the grid style of the form to be obtained, which is represented as intent.setParam(PARAM_FORM_DIMENSION_KEY, 1).
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - PARAM_FORM_HEIGHT_KEY
```
public static final String PARAM_FORM_HEIGHT_KEY
```
    Indicates the key specifying the height of the form to be obtained, which is represented as intent.setParam(PARAM_FORM_HEIGHT_KEY, 400).
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - PARAM_FORM_IDENTITY_KEY
```
public static final String PARAM_FORM_IDENTITY_KEY
```
    Indicates the key specifying the ID of the form to be obtained, which is represented as intent.setParam(PARAM_FORM_IDENTITY_KEY, 1L).
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - PARAM_FORM_ID_KEY
```
@Deprecated
public static final String PARAM_FORM_ID_KEY
```
    已过时。 This change is effective since API version 5. Replaced by PARAM_FORM_IDENTITY_KEY.
    
    Indicates the key specifying the ID of the form to be obtained, which is represented as intent.setParam(PARAM_FORM_ID_KEY, 1). Compatible with int form id.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - PARAM_FORM_NAME_KEY
```
public static final String PARAM_FORM_NAME_KEY
```
    Indicates the key specifying the name of the form to be obtained, which is represented as intent.setParam(PARAM_FORM_NAME_KEY, "formName").
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - PARAM_FORM_TEMPORARY_KEY
```
public static final String PARAM_FORM_TEMPORARY_KEY
```
    Indicates the key specifying whether a form is temporary, which is represented as intent.setParam(PARAM_FORM_TEMPORARY_KEY, true).
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - PARAM_FORM_WIDTH_KEY
```
public static final String PARAM_FORM_WIDTH_KEY
```
    Indicates the key specifying the width of the form to be obtained, which is represented as intent.setParam(PARAM_FORM_WIDTH_KEY, 800).
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - PARAM_MODULE_NAME_KEY
```
public static final String PARAM_MODULE_NAME_KEY
```
    Indicates the key specifying the name of the module to which the form to be obtained belongs, which is represented as intent.setParam(PARAM_MODULE_NAME_KEY, "formEntry"). This constant is mandatory.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - AbilitySlice
```
public AbilitySlice()
```
- 方法详细资料
  - onStart
```
protected void onStart(Intent intent)
```
    Called back when an ability slice is started. The startup information is transferred using the intent parameter.
    You must override this method for each ability slice, and use the setUIContent(int) or setUIContent(ohos.agp.components.ComponentContainer) method to set the UI.
    
    This method can be called only once in the entire lifecycle of an ability slice. Therefore, you are advised to use this method to implement initialization, for example, initializing a timer or defining a global object.
    
    参数:
    
    intent - Indicates information carried when the ability slice is started.
    
    从以下版本开始:
    
    1
  - onActive
```
protected void onActive()
```
    Called back when an ability slice enters the ACTIVE state.
    The UI of an ability slice in the ACTIVE state has gained focus and is interactive.
    
    从以下版本开始:
    
    1
  - onInactive
```
protected void onInactive()
```
    Called back when an ability slice enters the INACTIVE state.
    INACTIVE is an intermediate state and may immediately change to ACTIVE or BACKGROUND. The UI of an ability slice in this state may be visible but is not interactive. You are advised not to use this method to trigger complex service logic.
    
    从以下版本开始:
    
    1
  - onForeground
```
protected void onForeground(Intent intent)
```
    Called back when the state of an ability slice changes from BACKGROUND to INACTIVE.
    The ability slice returns to the foreground. You can use this method to implement reinitialization or adjust the UI by using the intent parameter.
    
    参数:
    
    intent - Indicates the information carried when the ability slice returns to the INACTIVE state.
    
    从以下版本开始:
    
    1
  - onBackground
```
protected void onBackground()
```
    Called back when an ability slice enters the BACKGROUND state.
    The UI of an ability slice in the BACKGROUND state is invisible and not interactive. You are advised to use this method to stop or release resources.
    
    从以下版本开始:
    
    1
  - onStop
```
protected void onStop()
```
    Called back before an ability slice is destroyed.
    This method is called back after an ability slice calls the terminate() method. You can use this method to reclaim resources.
    
    从以下版本开始:
    
    1
  - onAbilityResult
```
protected void onAbilityResult(int requestCode,
                               int resultCode,
                               Intent resultData)
```
    Called when startAbilityForResult(ohos.aafwk.content.Intent,int) is called to start an ability and the result is returned.
    This method provides the same function as the Ability#onAbilityResult(int, int, Intent) method of the ability.
    
    参数:
    
    requestCode - Indicates the request code returned after the ability is started. You can define the request code to identify the results returned by abilities. The value ranges from 0 to 65535.
    
    resultCode - Indicates the result code returned after the ability is started. You can define the result code to identify an error.
    
    resultData - Indicates the data returned after the ability is started. You can define the data returned. The value can be null.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    startAbilityForResult(Intent, int)
  - onResult
```
protected void onResult(int requestCode,
                        Intent resultIntent)
```
    Called back when the result of the presentForResult(ohos.aafwk.ability.AbilitySlice,ohos.aafwk.content.Intent,int) method is returned.
    When presentForResult(ohos.aafwk.ability.AbilitySlice,ohos.aafwk.content.Intent,int) is called to start a new ability slice, the execution result is returned when the ability slice is destroyed. You can override this method to process the result.
    
    参数:
    
    requestCode - Indicates the request code returned after the ability slice is started. You can define the request code to identify the results returned by ability slices. The value ranges from 0 to 65535.
    
    resultIntent - Indicates the data returned after the started ability slice is destroyed. This parameter can be null.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    presentForResult(AbilitySlice, Intent, int), setResult(Intent)
  - onOrientationChanged
```
protected void onOrientationChanged(AbilityInfo.DisplayOrientation displayOrientation)
```
    Called back when the display orientation of a screen changes.
    You can override this method to implement your logic when the display orientation changes. By default, no operation is performed when the display orientation changes.
    
    参数:
    
    displayOrientation - Indicates the new display orientation. The following values are supported: DisplayOrientation#LANDSCAPE, DisplayOrientation#PORTRAIT, DisplayOrientation#FOLLOWRECENT, and DisplayOrientation#UNSPECIFIED.
    
    从以下版本开始:
    
    1
  - onBackPressed
```
protected void onBackPressed()
```
    Called back when the Back key is pressed.
    The default implementation destroys the ability slice. You can override this method.
    
    从以下版本开始:
    
    1
  - onKeyDown
```
public boolean onKeyDown(int keyCode,
                         KeyEvent keyEvent)
```
    Called when a key is pressed. When any component in the AbilitySlice gains focus, the key-down event for the component will be handled first. This callback will not be invoked if the callback triggered for the key-down event of the component returns true. The default implementation of this callback does nothing and returns false.
    
    参数:
    
    keyCode - Indicates the code of the key pressed.
    
    keyEvent - Indicates the key-down event.
    
    返回:
    
    Returns true if this event is handled and will not be passed further; returns false if this event is not handled and should be passed to other handlers.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    onKeyUp(int, ohos.multimodalinput.event.KeyEvent)
  - onKeyUp
```
public boolean onKeyUp(int keyCode,
                       KeyEvent keyEvent)
```
    Called when a key is released. When any component in the AbilitySlice gains focus, the key-up event for the component will be handled first. This callback will not be invoked if the callback triggered for the key-up event of the component returns true. The default implementation of this callback does nothing and returns false.
    
    参数:
    
    keyCode - Indicates the code of the key released.
    
    keyEvent - Indicates the key-up event.
    
    返回:
    
    Returns true if this event is handled and will not be passed further; returns false if this event is not handled and should be passed to other handlers.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    onKeyDown(int, ohos.multimodalinput.event.KeyEvent)
  - postTask
```
public void postTask(Runnable task,
                     long delayTime)
```
    Posts a scheduled Runnable task to a new non-UI thread.
    The task posted via this method will be executed in a new thread, which allows you to perform certain time-consuming operations. To use this method, you must also override the Ability#supportHighPerformanceUI() method. Additionally, the usage of this method must comply with the following constraints:
    1. This method can only be used to initialize the component tree in parallel mode.
    2. The task can only be processed during system cold start.
    3. If the parallel loading mechanism is used, the component tree-related operations to be performed in onActive() and onStop() of the ability slice must also be added to the parallel thread.
    4. You must run setUIContent(ohos.agp.components.ComponentContainer) to unlock the UI thread and wait until the component tree is ready.
    5. Other time-consuming operations, such as I/O and network processing, cannot be added to the parallel task queue.
    参数:
    
    task - Indicates the Runnable task to post.
    
    delayTime - Indicates the number of milliseconds after which the task will be executed.
    
    从以下版本开始:
    
    4
  - onHotkeyTriggered
```
public boolean onHotkeyTriggered(int keyCode,
                                 KeyEvent keyEvent)
```
    Called when a hotkey is pressed.
    
    参数:
    
    keyCode - Indicates the key code.
    
    keyEvent - Indicates the triggered key event.
    
    返回:
    
    Returns true if the key event is handled in this callback; returns false otherwise.
    
    从以下版本开始:
    
    5
  - onKeyPressAndHold
```
public boolean onKeyPressAndHold(int keyCode,
                                 KeyEvent keyEvent)
```
    Called when a key is pressed and held.
    
    参数:
    
    keyCode - Indicates the key code.
    
    keyEvent - Indicates the triggered key event.
    
    返回:
    
    Returns true if the key event is handled in this callback; returns false otherwise.
    
    从以下版本开始:
    
    5
  - toString
```
public String toString()
```
    Provide impl and corresponding slice info for easy human reading traces.
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    Info in String format.
    
    从以下版本开始:
    
    1
  - getWindow
```
public Window getWindow()
```
    Obtains the window corresponding to the current ability.
    This method provides the same function as the Ability#getWindow() method.
    
    返回:
    
    Returns the window corresponding to the current ability.
    
    从以下版本开始:
    
    1
  - getLayoutParams
```
public WindowManager.LayoutConfig getLayoutParams()
```
    Obtains window layout parameters of an ability. Layout parameters must be set for windows of all abilities. These parameters are provided for the parent window to specify how to lay out the windows of the current ability.
    This method provides the same function as the Ability#getLayoutParams() method.
    
    返回:
    
    Returns window layout parameters of the ability; returns null if no layout parameter is set.
    
    从以下版本开始:
    
    1
  - setLayoutParams
```
public void setLayoutParams(WindowManager.LayoutConfig params)
```
    Sets window layout parameters of an ability. These parameters are provided for the parent window to specify how to lay out the windows of the current ability.
    This method provides the same function as the Ability#setLayoutParams(LayoutConfig) method.
    
    参数:
    
    params - Indicates the WindowManager.LayoutConfig object containing the layout parameters. This parameter cannot be null.
    
    从以下版本开始:
    
    1
  - setIsAmbientMode
```
public void setIsAmbientMode(boolean isEnabled)
```
    sets input AOD mode for window
    
    参数:
    
    isEnabled - indicates whether the AOD mode is enabled
    
    从以下版本开始:
    
    3
  - getContinuationRegisterManager
```
public IContinuationRegisterManager getContinuationRegisterManager()
```
    Obtains an IContinuationRegisterManager object.
    You can use the IContinuationRegisterManager object to interact with the hop task management service, including registering and unregistering the ability to migrate, updating the device connection state, and showing the list of devices that can be selected for ability migration.
    
    返回:
    
    Returns the IContinuationRegisterManager object.
    
    从以下版本开始:
    
    5
  - setUIContent
```
public final void setUIContent(int layoutRes)
```
    Inflates layout resources by using the layout resource ID.
    
    参数:
    
    layoutRes - Indicates the layout resource ID, which cannot be a negative number.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if layoutRes is invalid.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    setUIContent(ComponentContainer)
  - setUIContent
```
public void setUIContent(ComponentContainer componentContainer)
```
    Inflates UI controls by using ComponentContainer.
    You can create a ComponentContainer instance that contains multiple components.
    
    参数:
    
    componentContainer - Indicates a set of customized components.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if componentContainer is invalid.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    setUIContent(int)
  - findComponentById
```
public <T extends Component> T findComponentById(int resId)
```
    Finds a component in the XML file based on the resource ID.
    
    参数:
    
    resId - Indicates the resource ID of the component.
    
    返回:
    
    Returns the component corresponding to the ID if a record is found; returns null otherwise.
    
    从以下版本开始:
    
    1
  - present
```
public final void present(AbilitySlice targetSlice,
                          Intent intent)
```
    Presents another ability slice, which can be an ability slice that is not started or an existing ability slice in the host ability.
    You can use an Intent object to pass required information.
    
    This method can be called only in the following cases:
    - The host ability is in the ACTIVE state.
    - The target ability slice is not started or destroyed.
    - The number of ability slices in the host ability does not exceed 1024.
    参数:
    
    targetSlice - Indicates the target ability slice, which cannot be null.
    
    intent - Indicates information carried during the switching, which cannot be null.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if targetSlice is invalid.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    presentForResult(AbilitySlice, Intent, int)
  - presentForResult
```
public final void presentForResult(AbilitySlice targetSlice,
                                   Intent intent,
                                   int requestCode)
```
    Presents another ability slice and returns the result set by the target ability slice by calling setResult(ohos.aafwk.content.Intent).
    You can use an Intent object to pass required information.
    
    This method can be called only in the following cases:
    - The host ability of the current ability slice is in the ACTIVE state.
    - The target ability slice is not started or destroyed.
    - There are 1024 or less ability slices in the host ability.
    参数:
    
    targetSlice - Indicates the target ability slice. This parameter cannot be null.
    
    intent - Indicates information carried during the switching, which cannot be null.
    
    requestCode - Indicates the customized request code, which cannot be a negative number.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if targetSlice or requestCode is invalid.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    setResult(Intent), onResult(int, Intent)
  - setResult
```
public final void setResult(Intent resultData)
```
    Sets the data to be returned when an ability slice is destroyed.
    When the ability slice calls the terminate() method, the result data set by the current method is transferred to the caller.
    
    参数:
    
    resultData - Indicates the data returned after the ability slice is destroyed. You can define the data returned. The value can be null.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    presentForResult(AbilitySlice, Intent, int), onResult(int, Intent)
  - terminate
```
public final void terminate()
```
    Destroys the current ability slice.
    When the current ability slice calls this method to destroy itself, the result data set by setResult(ohos.aafwk.content.Intent) is returned to the caller. If the slice to be destroyed is the only slice of its host ability, the ability will also be destroyed. Otherwise, the ability will not be affected.
    
    从以下版本开始:
    
    1
  - startAbility
```
public void startAbility(Intent intent)
```
    Starts a new ability.
    An ability slice can also use this method to start a new ability. Similar to the function of the Ability#startAbility(Intent) method, the system locates the target ability from installed abilities based on the value of the intent parameter and then starts it.
    
    参数:
    
    intent - Indicates the ability to start.
    
    从以下版本开始:
    
    1
  - startAbility
```
public void startAbility(Intent intent,
                         AbilityStartSetting abilityStartSetting)
```
    Starts a new ability with specific start settings.
    An ability slice can also use this method to start a new ability. Similar to the function of the Ability#startAbility(Intent) method, the system locates the target ability from installed abilities based on the value of the intent parameter and then starts it.
    
    参数:
    
    intent - Indicates the ability to start.
    
    abilityStartSetting - Indicates the setting ability used to start.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if intent is invalid.
    
    从以下版本开始:
    
    4
  - startAbilityForResult
```
public void startAbilityForResult(Intent intent,
                                  int requestCode,
                                  AbilityStartSetting abilityStartSetting)
```
    Starts an ability with specific start settings and returns the execution result when the ability is destroyed.
    When the ability is destroyed, onAbilityResult(int,int,ohos.aafwk.content.Intent) is called and the returned requestCode is transferred to the current method. The given requestCode is customized and cannot be a negative number.
    
    参数:
    
    intent - Indicates the ability to start.
    
    requestCode - Indicates the request code returned after the ability is started. You can define the request code to identify the results returned by abilities. The value ranges from 0 to 65535.
    
    abilityStartSetting - Indicates the setting ability used to start.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if intent is invalid.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    onAbilityResult(int, int, Intent)
  - startAbilityForResult
```
public void startAbilityForResult(Intent intent,
                                  int requestCode)
```
    Starts an ability and returns the execution result when the ability is destroyed.
    This method provides the same function as the Ability#startAbilityForResult(Intent, int) method.
    
    参数:
    
    intent - Indicates the ability to start.
    
    requestCode - Indicates the request code returned after the ability is started. You can define the request code to identify the results returned by abilities. The value ranges from 0 to 65535.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    onAbilityResult(int, int, Intent)
  - getState
```
public final AbilitySliceLifecycleExecutor.LifecycleState getState()
```
    Obtains the lifecycle state of this ability slice.
    
    返回:
    
    Returns the lifecycle state of this ability slice.
    
    从以下版本开始:
    
    4
  - stopAbility
```
public final boolean stopAbility(Intent intent)
                          throws IllegalArgumentException,
                                 IllegalStateException
```
    Destroys an ability that uses the Service template.
    This method provides the same function as the Ability#stopAbility(Intent) method.
    
    指定者:
    
    stopAbility 在接口中 Context
    
    覆盖:
    
    stopAbility 在类中 AbilityContext
    
    参数:
    
    intent - Indicates the ability using the Service template.
    
    返回:
    
    Returns true if the ability using the Service template is successfully destroyed; returns false otherwise.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the input parameter is null.
    
    IllegalStateException - Throws this exception if the ability is not initialized.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    Context.stopAbility(Intent)
  - terminateAbility
```
public void terminateAbility()
```
    Destroys the host ability.
    This method provides the same function as the Ability#terminateAbility() method.
    
    指定者:
    
    terminateAbility 在接口中 Context
    
    覆盖:
    
    terminateAbility 在类中 AbilityContext
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    Context.terminateAbility()
  - connectAbility
```
public final boolean connectAbility(Intent intent,
                                    IAbilityConnection conn)
                             throws IllegalArgumentException,
                                    IllegalStateException
```
    Connects the host ability to an ability that uses the Service template.
    This method provides the same function as the Ability#connectAbility(Intent, IAbilityConnection) method.
    
    指定者:
    
    connectAbility 在接口中 Context
    
    覆盖:
    
    connectAbility 在类中 AbilityContext
    
    参数:
    
    intent - Indicates the ability using the Service template.
    
    conn - Indicates the transferred callback object when the ability slice is connected.
    
    返回:
    
    Returns true if the connection is successful; returns false otherwise.
    
    抛出:
    
    IllegalStateException - Throws this exception if the ability or ability slice is not initialized.
    
    IllegalArgumentException - Throws this exception if the input parameter is null.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    Context.connectAbility(Intent, IAbilityConnection)
  - disconnectAbility
```
public final void disconnectAbility(IAbilityConnection conn)
                             throws IllegalArgumentException,
                                    IllegalStateException
```
    Disconnects the host ability from an ability that uses the Service template.
    This method provides the same function as the Ability#disconnectAbility(IAbilityConnection) method.
    
    指定者:
    
    disconnectAbility 在接口中 Context
    
    覆盖:
    
    disconnectAbility 在类中 AbilityContext
    
    参数:
    
    conn - Indicates the transferred callback object when the ability slice is connected.
    
    抛出:
    
    IllegalStateException - Throws this exception if the ability or ability slice is not initialized.
    
    IllegalArgumentException - Throws this exception if the input parameter is null.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    Context.disconnectAbility(IAbilityConnection)
  - continueAbility
```
public void continueAbility()
                     throws IllegalStateException,
                            UnsupportedOperationException
```
    Migrates the host ability to another device on the same distributed network.
    This method provides the same function as the Ability#continueAbility() method.
    
    抛出:
    
    IllegalStateException - Throws this exception if the host ability is not initialized or is in a state where this operation is not allowed, for example, it is being migrated.
    
    UnsupportedOperationException - Throws this exception if the host ability does not implement the IAbilityContinuation interface.
    
    从以下版本开始:
    
    1
  - continueAbility
```
public void continueAbility(String deviceId)
                     throws IllegalStateException,
                            UnsupportedOperationException
```
    Migrates the host ability to the given device on the same distributed network.
    This method provides the same function as the Ability#continueAbility(String) method.
    
    参数:
    
    deviceId - Indicates the ID of the target device where the host ability will be migrated to. If this parameter is null, this method has the same effect as continueAbility().
    
    抛出:
    
    IllegalStateException - Throws this exception if the host ability is not initialized or is in a state where this operation is not allowed, for example, it is being migrated.
    
    UnsupportedOperationException - Throws this exception if the host ability does not implement the IAbilityContinuation interface.
    
    从以下版本开始:
    
    3
  - continueAbilityReversibly
```
public void continueAbilityReversibly()
                               throws IllegalStateException,
                                      UnsupportedOperationException
```
    Migrates the host ability to another device on the same distributed network in a reversible way that allows the ability to be migrated back to the local device through reverseContinueAbility().
    This method provides the same function as the Ability#continueAbilityReversibly() method.
    
    抛出:
    
    IllegalStateException - Throws this exception if the host ability is not initialized or is in a state where this operation is not allowed, for example, it is being migrated.
    
    UnsupportedOperationException - Throws this exception if the host ability does not implement the IAbilityContinuation interface.
    
    从以下版本开始:
    
    3
  - continueAbilityReversibly
```
public void continueAbilityReversibly(String deviceId)
                               throws IllegalStateException,
                                      UnsupportedOperationException
```
    Migrates the host ability to another device on the same distributed network in a reversible way that allows the ability to be migrated back to the local device through reverseContinueAbility().
    This method provides the same function as the Ability#continueAbilityReversibly(String) method.
    
    参数:
    
    deviceId - Indicates the ID of the target device where the host ability will be migrated to. If this parameter is null, this method has the same effect as continueAbilityReversibly().
    
    抛出:
    
    IllegalStateException - Throws this exception if the host ability is not initialized or is in a state where this operation is not allowed, for example, it is being migrated.
    
    UnsupportedOperationException - Throws this exception if the host ability does not implement the IAbilityContinuation interface.
    
    从以下版本开始:
    
    3
  - reverseContinueAbility
```
public boolean reverseContinueAbility()
                               throws IllegalStateException,
                                      UnsupportedOperationException
```
    Migrates the host ability from another device on the same distributed network back to the local device.
    This method provides the same function as the Ability#reverseContinueAbility() method.
    
    返回:
    
    Returns true if the migration request is successful; returns false otherwise.
    
    抛出:
    
    IllegalStateException - Throws this exception if the host ability was not involved in a reversible migration process, or if it is in a state where this operation is not allowed, for example, it is being migrated back.
    
    UnsupportedOperationException - Throws this exception if the host ability does not implement the IAbilityContinuation interface.
    
    从以下版本开始:
    
    3
  - getContinuationState
```
public final ContinuationState getContinuationState()
                                             throws UnsupportedOperationException
```
    Obtains the migration state of the host ability.
    This method provides the same function as the Ability#getContinuationState() method.
    
    返回:
    
    Returns the migration state.
    
    抛出:
    
    UnsupportedOperationException - Throws this exception if the host ability does not implement the IAbilityContinuation interface.
    
    从以下版本开始:
    
    3
  - getOriginalDeviceId
```
public final String getOriginalDeviceId()
                                 throws UnsupportedOperationException
```
    Obtains the ID of the source device from which the host ability is migrated.
    This method provides the same function as the Ability#getOriginalDeviceId() method.
    
    返回:
    
    Returns the source device ID.
    
    抛出:
    
    UnsupportedOperationException - Throws this exception if the host ability does not implement the IAbilityContinuation interface.
    
    从以下版本开始:
    
    3
  - setDisplayOrientation
```
public void setDisplayOrientation(AbilityInfo.DisplayOrientation requestedOrientation)
```
    Sets the display orientation of the host ability.
    After you change the display orientation using this method, the system calls back the onOrientationChanged(ohos.bundle.AbilityInfo.DisplayOrientation) method. If requestedOrientation is set to DisplayOrientation#UNSPECIFIED, the display orientation of the ability depends on the system setting.
    
    If an ability is in the foreground, the setting takes effect immediately. Otherwise, the setting takes effect when the ability returns to the foreground.
    
    指定者:
    
    setDisplayOrientation 在接口中 Context
    
    覆盖:
    
    setDisplayOrientation 在类中 AbilityContext
    
    参数:
    
    requestedOrientation - Indicates the display orientation, which can be UNSPECIFIED, LANDSCAPE, PORTRAIT, or FOLLOWRECENT.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if requestedOrientation is invalid.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    Context.setDisplayOrientation(AbilityInfo.DisplayOrientation)
  - acquireAbilityFormAsync
```
public boolean acquireAbilityFormAsync(Intent intent,
                                       AbilityForm.OnAcquiredCallback acquiredCallback)
```
    Requests the AbilityForm instance provided by the target ability.
    This method is executed asynchronously. After the AbilityForm instance is obtained, the system calls back the OnAcquiredCallback method. If the target ability does not use the Page template or does not provide the AbilityForm capability, the caller is not notified.
    
    To use this method, your application must have the ohos.permission.REQUIRE_FORM permission. This permission is available only to system applications. If the caller does not have the permission, false is returned.
    
    参数:
    
    intent - Indicates the target ability.
    
    acquiredCallback - Indicates the notification callback after the AbilityForm instance is asynchronously obtained.
    
    返回:
    
    Returns true if the request is sent successfully; returns false otherwise.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if intent or acquiredCallback is invalid.
    
    从以下版本开始:
    
    1
  - acquireForm
```
public boolean acquireForm(Intent intent,
                           AbilitySlice.FormCallback callback)
                    throws FormException
```
    Obtains a specified form that matches the application bundle name, module name, form name, form grid style, and other related information specified in the passed Intent.
    This method is asynchronous. After the Form instance is obtained, AbilitySlice.FormCallback.onAcquired(int, Form) will be invoked to notify the application.
    Permissions: SystemPermission.REQUIRE_FORM; SystemPermission.GET_BUNDLE_INFO_PRIVILEGED
    参数:
    
    intent - Indicates the detailed information about the form to be obtained, including the bundle name, module name, ability name, form name, form grid styles, form width and height, and form ID.
    
    callback - Indicates the callback to be invoked whenever the Form instance is obtained.
    
    返回:
    
    Returns true if the request is successfully initiated; returns false otherwise.
    
    抛出:
    FormException - Throws this exception if the form fails to be obtained due to any of the following reasons:
    
    The input parameter is null.
    
    The Intent does not bear the necessary bundleName, abilityName, and moduleName.
    
    An error occurred when sending the request to the Form Manager Service.
    
    No form can be found based on the passed parameters.
    
    The application is not granted with the SystemPermission.REQUIRE_FORM or SystemPermission.GET_BUNDLE_INFO_PRIVILEGED permission.
    
    The form identified by the ID has been obtained by the current application.
    
    The form is being restored.
    从以下版本开始:
    
    5
  - deleteForm
```
@Deprecated
public boolean deleteForm(int formId)
                   throws FormException
```
    已过时。 This change is effective since API version 5. Replaced by deleteForm(long).
    
    Deletes an obtained form by its ID.
    After this method is called, the form won't be available for use by the application and the Form Manager Service no longer keeps the cache information about the form.
    
    Permission: SystemPermission.REQUIRE_FORM
    参数:
    
    formId - Indicates the form ID, which can be obtained via Form.getId().
    
    返回:
    
    Returns true if the form is successfully deleted; returns false otherwise.
    
    抛出:
    FormException - Throws this exception if the form fails to be deleted due to any of the following reasons:
    
    The passed formId is invalid. Its value must be larger than 0.
    
    The specified form has not been added by the application.
    
    An error occurred when connecting to the Form Manager Service.
    
    The application is not granted with the SystemPermission.REQUIRE_FORM permission.
    
    The form has been obtained by another application and cannot be deleted by the current application.
    
    The form is being restored.
    从以下版本开始:
    
    5
  - deleteForm
```
public boolean deleteForm(long formId)
                   throws FormException
```
    Deletes an obtained form by its ID.
    After this method is called, the form won't be available for use by the application and the Form Manager Service no longer keeps the cache information about the form.
    
    Permission: SystemPermission.REQUIRE_FORM
    参数:
    
    formId - Indicates the form ID, which can be obtained via Form.getId().
    
    返回:
    
    Returns true if the form is successfully deleted; returns false otherwise.
    
    抛出:
    FormException - Throws this exception if the form fails to be deleted due to any of the following reasons:
    
    The passed formId is invalid. Its value must be larger than 0.
    
    The specified form has not been added by the application.
    
    An error occurred when connecting to the Form Manager Service.
    
    The application is not granted with the SystemPermission.REQUIRE_FORM permission.
    
    The form has been obtained by another application and cannot be deleted by the current application.
    
    The form is being restored.
    从以下版本开始:
    
    5
  - releaseForm
```
@Deprecated
public boolean releaseForm(int formId)
                    throws FormException
```
    已过时。 This change is effective since API version 5. Replaced by releaseForm(long).
    
    Releases an obtained form by its ID.
    After this method is called, the form won't be available for use by the application, but the Form Manager Service still keeps the cache information about the form, so that the application can quickly obtain it based on the formId.
    
    Permission: SystemPermission.REQUIRE_FORM
    参数:
    
    formId - Indicates the form ID, which can be obtained via Form.getFormId().
    
    返回:
    
    Returns true if the form is successfully released; returns false otherwise.
    
    抛出:
    FormException - Throws this exception if the form fails to be released due to any of the following reasons:
    
    The passed formId is invalid. Its value must be larger than 0.
    
    The specified form has not been added by the application.
    
    An error occurred when connecting to the Form Manager Service.
    
    The application is not granted with the SystemPermission.REQUIRE_FORM permission.
    
    The form has been obtained by another application and cannot be released by the current application.
    
    The form is being restored.
    从以下版本开始:
    
    5
  - releaseForm
```
public boolean releaseForm(long formId)
                    throws FormException
```
    Releases an obtained form by its ID.
    After this method is called, the form won't be available for use by the application, but the Form Manager Service still keeps the cache information about the form, so that the application can quickly obtain it based on the formId.
    
    Permission: SystemPermission.REQUIRE_FORM
    参数:
    
    formId - Indicates the form ID, which can be obtained via Form.getId().
    
    返回:
    
    Returns true if the form is successfully released; returns false otherwise.
    
    抛出:
    FormException - Throws this exception if the form fails to be released due to any of the following reasons:
    
    The passed formId is invalid. Its value must be larger than 0.
    
    The specified form has not been added by the application.
    
    An error occurred when connecting to the Form Manager Service.
    
    The application is not granted with the SystemPermission.REQUIRE_FORM permission.
    
    The form has been obtained by another application and cannot be released by the current application.
    
    The form is being restored.
    从以下版本开始:
    
    5
  - releaseForm
```
public boolean releaseForm(long formId,
                           boolean isReleaseCache)
                    throws FormException
```
    Releases an obtained form by its ID.
    After this method is called, the form won't be available for use by the application, if isReleaseCache is false, this method is same as releaseForm(int), otherwise the Form Manager Service still store this form in the cache.
    
    Permission: SystemPermission.REQUIRE_FORM
    参数:
    
    formId - Indicates the form ID, which can be obtained via Form.getId().
    
    isReleaseCache - Indicates whether to clear cache in service.
    
    返回:
    
    Returns true if the form is successfully released; returns false otherwise.
    
    抛出:
    FormException - Throws this exception if the form fails to be released due to any of the following reasons:
    
    The passed formId is invalid. Its value must be larger than 0.
    
    The specified form has not been added by the application.
    
    An error occurred when connecting to the Form Manager Service.
    
    The application is not granted with the SystemPermission.REQUIRE_FORM permission.
    
    The form has been obtained by another application and cannot be released by the current application.
    
    The form is being restored.
    从以下版本开始:
    
    5
  - castTempForm
```
public boolean castTempForm(long formId)
                     throws FormException
```
    Converts a specified temporary form that has been obtained by the application into a normal form.
    After this method is successfully called, the temporary form will be converted to a normal form, the data in the cache will be updated accordingly, and the form data such as the form ID will be made persistent.
    
    Permissions: SystemPermission.REQUIRE_FORM
    参数:
    
    formId - Indicates the ID of the temporary form to convert, which is obtained via Form.getId().
    
    返回:
    
    Returns true if the conversion is successful; returns false otherwise.
    
    抛出:
    FormException - Throws this exception if the form fails to be converted due to any of the following reasons:
    
    The passed formId is invalid. Its value must be larger than 0.
    
    The specified form ID is not the ID of a temporary form.
    
    An error occurred when connecting to the Form Manager Service.
    
    The application is not granted with the SystemPermission.REQUIRE_FORM permission.
    
    The number of normal forms requested by the current form client in the cache has reached the upper limit (256).
    
    The number of Form instances in the cache of the Form Manager Service has reached the upper limit (512).
    
    The form is being restored.
    从以下版本开始:
    
    5
  - notifyVisibleForms
```
public void notifyVisibleForms(List<Long> formIds)
                        throws FormException
```
    Sends a notification to the form framework to make the specified forms visible.
    After this method is successfully called, Ability.onEventNotify(Map<Long, int>) will be called to notify the form provider of the form visibility change event.
    
    Permissions: SystemPermission.REQUIRE_FORM
    参数:
    
    formIds - Indicates the IDs of the forms to be made visible.
    
    抛出:
    FormException - Throws this exception if the forms fail to be made visible due to any of the following reasons:
    
    The passed formIds parameter is invalid. Each form ID in it must be larger than 0.
    
    An error occurred when connecting to the Form Manager Service.
    
    The application is not granted with the SystemPermission.REQUIRE_FORM permission.
    
    The form has been obtained by another application and cannot be changed by the current application.
    
    The form is being restored.
    从以下版本开始:
    
    5
  - notifyInvisibleForms
```
public void notifyInvisibleForms(List<Long> formIds)
                          throws FormException
```
    Sends a notification to the form framework to make the specified forms invisible.
    After this method is successfully called, Ability.onEventNotify(Map<Long, int>) will be called to notify the form provider of the form visibility change event.
    
    Permissions: SystemPermission.REQUIRE_FORM
    参数:
    
    formIds - Indicates the IDs of the forms to be made invisible.
    
    抛出:
    FormException - Throws this exception if the forms fail to be made invisible due to any of the following reasons:
    
    The passed formIds parameter is invalid. Each form ID in it must be larger than 0.
    
    An error occurred when connecting to the Form Manager Service.
    
    The application is not granted with the SystemPermission.REQUIRE_FORM permission.
    
    The form has been obtained by another application and cannot be changed by the current application.
    
    The form is being restored.
    从以下版本开始:
    
    5
  - checkAndDeleteInvalidForms
```
public int checkAndDeleteInvalidForms(List<Long> persistedIds)
                               throws FormException
```
    Checks for and deletes invalid forms of the application in the Form Manager Service based on the list of valid form IDs passed.
    If an empty list is passed to this method, the Form Manager Service will delete all forms of the application.
    
    Permissions: SystemPermission.REQUIRE_FORM
    参数:
    
    persistedIds - Indicates the list of valid forms with persisted IDs.
    
    返回:
    
    Returns the number of invalid forms deleted by the Form Manager Service.
    
    抛出:
    FormException - Throws this exception if the invalid forms fail to be deleted due to any of the following reasons:
    
    The passed persistedIds is invalid. The value of persistedIds must not be null.
    
    The number of forms identified by persistedIds has reached the upper limit (256) allowed for a single application.
    
    An error occurred when connecting to the Form Manager Service.
    
    The application is not granted with the SystemPermission.REQUIRE_FORM permission.
    
    The forms are being restored.
    从以下版本开始:
    
    5
  - acquireFormState
```
public void acquireFormState(Intent intent,
                             AbilitySlice.FormCallback callback)
                      throws FormException
```
    Obtains the state of the form that matches the application bundle name, module name, form name, form grid style, and other related information specified in the passed intent.
    This method is asynchronous. After the FormState is obtained, AbilitySlice.FormCallback.onAcquiredState(Intent, FormState) will be invoked to notify the application.
    
    Permissions: SystemPermission.REQUIRE_FORM; SystemPermission.GET_BUNDLE_INFO_PRIVILEGED
    参数:
    
    intent - Indicates the detailed information of the form to be obtained, including the bundle name, ability name, module name, form name, and form grid style.
    
    callback - Indicates the callback to be invoked whenever the FormState is obtained.
    
    抛出:
    FormException - Throws this exception if the form state fails to be obtained due to any of the following reasons:
    
    The input parameter is null.
    
    The intent does not bear the necessary bundleName, abilityName, moduleName, formName, and dimension.
    
    An error occurred when sending the request to the Form Manager Service.
    
    No form can be found based on the passed parameters.
    
    The application is not granted with the SystemPermission.REQUIRE_FORM or SystemPermission.GET_BUNDLE_INFO_PRIVILEGED permission.
    
    The form is being restored.
    从以下版本开始:
    
    6
  - getAllFormsInfo
```
public List<FormInfo> getAllFormsInfo()
                               throws FormException
```
    Obtains the FormInfo objects provided by all applications on the device.
    Permission: SystemPermission.GET_BUNDLE_INFO_PRIVILEGED
    
    返回:
    
    Returns a list of FormInfo objects if obtained; returns an empty List if no FormInfo is available on the device.
    
    抛出:
    
    FormException - Throws this exception if FormInfo fails to be obtained due to a connection error between the application and bundle manager service or because the application is not granted with the SystemPermission.GET_BUNDLE_INFO_PRIVILEGED permission.
    
    从以下版本开始:
    
    5
  - getAllForms
```
@Deprecated
public List<FormInfo> getAllForms()
                           throws FormException
```
    已过时。 This change is effective since API version 5. Replaced by getAllFormsInfo().
    
    Obtains the FormInfo objects provided by all applications on the device.
    Permission: SystemPermission.GET_BUNDLE_INFO_PRIVILEGED
    
    返回:
    
    Returns a list of FormInfo objects if obtained; returns an empty List if no FormInfo is available on the device.
    
    抛出:
    
    FormException - Throws this exception if FormInfo fails to be obtained due to a connection error between the application and bundle manager service or because the application is not granted with the SystemPermission.GET_BUNDLE_INFO_PRIVILEGED permission.
    
    从以下版本开始:
    
    5
  - getFormsInfoByApp
```
public List<FormInfo> getFormsInfoByApp(String bundleName)
                                 throws FormException
```
    Obtains the FormInfo objects provided by a specified application on the device.
    Permission: SystemPermission.GET_BUNDLE_INFO_PRIVILEGED
    
    参数:
    
    bundleName - Indicates the bundle name of the application. Specifically, it is the value of the bundleName attribute defined in the app tag of the config.json file for the application.
    
    返回:
    
    Returns a list of FormInfo objects if obtained; returns an empty List if no FormInfo is provided by the specified application.
    
    抛出:
    
    FormException - Throws this exception if FormInfo fails to be obtained due to a connection error between the application and bundle manager service or because the application is not granted with the SystemPermission.GET_BUNDLE_INFO_PRIVILEGED permission.
    
    从以下版本开始:
    
    5
  - getFormsByApp
```
@Deprecated
public List<FormInfo> getFormsByApp(String bundleName)
                             throws FormException
```
    已过时。 This change is effective since API version 5. Replaced by getFormsInfoByApp(java.lang.String).
    
    Obtains the FormInfo objects provided by a specified application on the device.
    Permission: SystemPermission.GET_BUNDLE_INFO_PRIVILEGED
    
    参数:
    
    bundleName - Indicates the bundle name of the application. Specifically, it is the value of the bundleName attribute defined in the app tag of the config.json file for the application.
    
    返回:
    
    Returns a list of FormInfo objects if obtained; returns an empty List if no FormInfo is provided by the specified application.
    
    抛出:
    
    FormException - Throws this exception if FormInfo fails to be obtained due to a connection error between the application and bundle manager service or because the application is not granted with the SystemPermission.GET_BUNDLE_INFO_PRIVILEGED permission.
    
    从以下版本开始:
    
    5
  - getFormsInfoByModule
```
public List<FormInfo> getFormsInfoByModule(String bundleName,
                                           String moduleName)
                                    throws FormException
```
    Obtains the FormInfo objects provided by a specified application module on the device.
    Permission: SystemPermission.GET_BUNDLE_INFO_PRIVILEGED
    
    参数:
    
    bundleName - Indicates the bundle name of the application. Specifically, it is the value of the bundleName attribute defined in the app tag of the config.json file for the application.
    
    moduleName - Indicates the module name of the application. Specifically, it is the value of the moduleName sub-attribute of the distro attribute defined in the module tag of the config.json file for the application.
    
    返回:
    
    Returns a list of FormInfo objects if obtained; returns an empty List if no FormInfo is provided by the specified application module.
    
    抛出:
    
    FormException - Throws this exception if FormInfo fails to be obtained due to a connection error between the application and bundle manager service or because the application is not granted with the SystemPermission.GET_BUNDLE_INFO_PRIVILEGED permission.
    
    从以下版本开始:
    
    5
  - getFormsByModule
```
@Deprecated
public List<FormInfo> getFormsByModule(String bundleName,
                                       String moduleName)
                                throws FormException
```
    已过时。 This change is effective since API version 5. Replaced by getFormsInfoByModule(java.lang.String,java.lang.String).
    
    Obtains the FormInfo objects provided by a specified application module on the device.
    Permission: SystemPermission.GET_BUNDLE_INFO_PRIVILEGED
    
    参数:
    
    bundleName - Indicates the bundle name of the application. Specifically, it is the value of the bundleName attribute defined in the app tag of the config.json file for the application.
    
    moduleName - Indicates the module name of the application. Specifically, it is the value of the moduleName sub-attribute of the distro attribute defined in the module tag of the config.json file for the application.
    
    返回:
    
    Returns a list of FormInfo objects if obtained; returns an empty List if no FormInfo is provided by the specified application module.
    
    抛出:
    
    FormException - Throws this exception if FormInfo fails to be obtained due to a connection error between the application and bundle manager service or because the application is not granted with the SystemPermission.GET_BUNDLE_INFO_PRIVILEGED permission.
    
    从以下版本开始:
    
    5
  - requestForm
```
@Deprecated
public boolean requestForm(int formId)
                    throws FormException
```
    已过时。 This change is effective since API version 5. Replaced by requestForm(long).
    
    Requests for form data update.
    This method must be called when the application has detected that a system setting item (such as the language, resolution, or screen orientation) being listened for has changed. Upon receiving the update request, the form provider automatically updates the form data (if there is any update) through the form framework, with the update process being unperceivable by the application.
    
    Permission: SystemPermission.REQUIRE_FORM
    参数:
    
    formId - Indicates the ID of the form to update.
    
    返回:
    
    Returns true if the update request is successfully initiated; returns false otherwise.
    
    抛出:
    FormException - Throws this exception if the update request fails to be initiated due to any of the following reasons:
    
    The passed formId is invalid. Its value must be larger than 0.
    
    The specified form has not been added by the application.
    
    An error occurred when connecting to the Form Manager Service.
    
    The application is not granted with the SystemPermission.REQUIRE_FORM permission.
    
    The form has been obtained by another application and cannot be updated by the current application.
    
    The form is being restored.
    从以下版本开始:
    
    5
  - requestForm
```
public boolean requestForm(long formId)
                    throws FormException
```
    Requests for form data update.
    This method must be called when the application has detected that a system setting item (such as the language, resolution, or screen orientation) being listened for has changed. Upon receiving the update request, the form provider automatically updates the form data (if there is any update) through the form framework, with the update process being unperceivable by the application.
    
    Permission: SystemPermission.REQUIRE_FORM
    参数:
    
    formId - Indicates the ID of the form to update.
    
    返回:
    
    Returns true if the update request is successfully initiated; returns false otherwise.
    
    抛出:
    FormException - Throws this exception if the update request fails to be initiated due to any of the following reasons:
    
    The passed formId is invalid. Its value must be larger than 0.
    
    The specified form has not been added by the application.
    
    An error occurred when connecting to the Form Manager Service.
    
    The application is not granted with the SystemPermission.REQUIRE_FORM permission.
    
    The form has been obtained by another application and cannot be updated by the current application.
    
    The form is being restored.
    从以下版本开始:
    
    5
  - requestForm
```
@Deprecated
public boolean requestForm(long formId,
                           Intent intent)
                    throws FormException
```
    已过时。 This change is effective since API version 5. Replaced by requestForm(long).
    
    Requests for form data update, by passing a set of parameters (using intent) to the form provider.
    This method must be called when the application has detected that a system setting item (such as the language, resolution, or screen orientation) being listened for has changed. Upon receiving the update request, the form provider automatically updates the form data (if there is any update) through the form framework, with the update process being unperceivable by the application.
    
    Permission: SystemPermission.REQUIRE_FORM
    参数:
    
    formId - Indicates the ID of the form to update.
    
    intent - Indicates a set of parameters to be transparently passed to the form provider.
    
    返回:
    
    Returns true if the update request is successfully initiated; returns false otherwise.
    
    抛出:
    FormException - Throws this exception if the update request fails to be initiated due to any of the following reasons:
    
    The passed formId or intent is invalid. The value of formId must be larger than 0, and intent must not be null.
    
    The specified form has not been added by the application.
    
    An error occurred when connecting to the Form Manager Service.
    
    The application is not granted with the SystemPermission.REQUIRE_FORM permission.
    
    The form has been obtained by another application and cannot be updated by the current application.
    
    The form is being restored.
    从以下版本开始:
    
    5
  - releaseAbilityForm
```
public void releaseAbilityForm(AbilityForm abilityForm)
```
    Releases a specified AbilityForm instance of the host ability.
    
    参数:
    
    abilityForm - Indicates the AbilityForm instances to release.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if abilityForm is invalid or the IAbilityConnection object related to the abilityForm cannot be obtained.
    
    从以下版本开始:
    
    1
  - getLifecycle
```
public final Lifecycle getLifecycle()
```
    Obtains the Lifecycle object of the current ability slice.
    
    指定者:
    
    getLifecycle 在接口中 ILifecycle
    
    返回:
    
    Returns the Lifecycle object.
    
    从以下版本开始:
    
    1
  - getAbility
```
public final Ability getAbility()
```
    Obtains the host ability of this AbilitySlice.
    
    返回:
    
    Returns the Ability object that hosts this AbilitySlice.
    
    从以下版本开始:
    
    3

类 AbilitySlice

Entry of an Ability Using the Page Template

AbilitySlice Lifecycle

Switching Between Ability Slices

嵌套类概要

字段概要

从接口继承的字段 ohos.app.Context

构造器概要

方法概要

从类继承的方法 ohos.app.AbilityContext

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

字段详细资料

PARAM_FORM_CUSTOMIZE_KEY

PARAM_FORM_DIMENSION_KEY

PARAM_FORM_HEIGHT_KEY

PARAM_FORM_IDENTITY_KEY

PARAM_FORM_ID_KEY

PARAM_FORM_NAME_KEY

PARAM_FORM_TEMPORARY_KEY

PARAM_FORM_WIDTH_KEY

PARAM_MODULE_NAME_KEY

构造器详细资料

AbilitySlice

方法详细资料

onStart

onActive

onInactive

onForeground

onBackground

onStop

onAbilityResult

onResult

onOrientationChanged

onBackPressed

onKeyDown

onKeyUp

postTask

onHotkeyTriggered

onKeyPressAndHold

toString

getWindow

getLayoutParams

setLayoutParams

setIsAmbientMode

getContinuationRegisterManager

setUIContent

setUIContent

findComponentById

present

presentForResult

setResult

terminate

startAbility

startAbility

startAbilityForResult

startAbilityForResult

getState

stopAbility

terminateAbility

connectAbility

disconnectAbility

continueAbility

continueAbility

continueAbilityReversibly

continueAbilityReversibly

reverseContinueAbility

getContinuationState

getOriginalDeviceId

setDisplayOrientation

acquireAbilityFormAsync

acquireForm

deleteForm

deleteForm

releaseForm

releaseForm

releaseForm

castTempForm

notifyVisibleForms

notifyInvisibleForms

checkAndDeleteInvalidForms