@ohos.app.ability.autoFillManager (autoFillManager)

The autoFillManager module provides APIs for saving accounts and passwords.

NOTE

The initial APIs of this module are supported since API version 11. Newly added APIs will be marked with a superscript to indicate their earliest API version.

The APIs of this module can be used only in the stage model.

Modules to Import

import autoFillManager from '@ohos.app.ability.autoFillManager';

AutoSaveCallback

Implements callbacks triggered when saving is complete.

AutoSaveCallback.onSuccess

onSuccess(): void

Called when saving is successful.

System capability: SystemCapability.Ability.AbilityRuntime.AbilityCore

Example

See AutoSaveCallback.onFailure.

AutoSaveCallback.onFailure

onFailure(): void

Called when saving fails.

System capability: SystemCapability.Ability.AbilityRuntime.AbilityCore

Example

// Index.ets, a page containing components such as the account and password text boxes.
import autoFillManager from '@ohos.app.ability.autoFillManager';
import { UIContext } from '@ohos.arkui.UIContext';
import Base from '@ohos.base';

let uiContext = AppStorage.get<UIContext>("uiContext");
let callback : autoFillManager.AutoSaveCallback = {
  onSuccess: () => {
    console.log("save request on success");
  },
  onFailure: () => {
    console.log("save request on failure");
  }
}

@Entry
@Component
struct Index {
  build() {
    Button('requestAutoSave')
      .onClick(() => {
        try {
          // Initiate a saving request.
          autoFillManager.requestAutoSave(uiContext, callback);
        } catch (error) {
          console.error(`catch error, code: ${(error as Base.BusinessError).code}, message: ${(error as Base.BusinessError).message}`);
        }
      })
  }
}

NOTE

In the example, the UiContext obtained from the AppStorage is obtained from the OnWindowStageCreate lifecycle of the EntryAbility (ability that starts the page) and stored in the AppStorage. For details, see requestAutoSave.

requestAutoSave

requestAutoSave(context: UIContext, callback?: AutoSaveCallback): void

Initiates a saving request. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.AbilityCore

Parameters

Error codes

For details about the error codes, see Ability Error Codes.

Example

// EntryAbility.ets
import UIAbility from '@ohos.app.ability.UIAbility';
import hilog from '@ohos.hilog';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';
import { UIContext } from '@ohos.arkui.UIContext';
import common from '@ohos.app.ability.common';

export default class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage): void {
    // Main window is created. Set a main page for this ability.
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageCreate');
    let localStorageData: Record<string, string | common.UIAbilityContext> = {
        'message': "AutoFill Page",
        'context': this.context,
    };
    let storage = new LocalStorage(localStorageData);
    windowStage.loadContent('pages/Index', storage, (err, data) => {
      if (err.code) {
        hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? '');
        return;
      }
      // Obtain the main window.
      windowStage.getMainWindow((err: BusinessError, data: window.Window) => {
        let errCode: number = err.code;
        if (errCode) {
          console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err));
          return;
        }
        console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data));
        // get UIContext instance.
        let uiContext: UIContext = windowStage.getMainWindowSync().getUIContext();
        PersistentStorage.persistProp("uiContext", uiContext);
      })
      hilog.info(0x0000, 'testTag', 'Succeeded in loading the content. Data: %{public}s', JSON.stringify(data) ?? '');
    });
  }
}

// Index.ets
import autoFillManager from '@ohos.app.ability.autoFillManager';
import { UIContext } from '@ohos.arkui.UIContext';
import Base from '@ohos.base';

@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        Text('Hello World')
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
      }

      Button('requestAutoSave')
        .onClick(() => {
          let uiContext = AppStorage.get<UIContext>("uiContext");
          console.log("uiContext: ", JSON.stringify(uiContext));
          try {
            // Initiate a saving request.
            autoFillManager.requestAutoSave(uiContext, {
              onSuccess: () => {
                console.log("save request on success");
              },
              onFailure: () => {
                console.log("save request on failure");
              }
            });
          } catch (error) {
            console.error(`catch error, code: ${(error as Base.BusinessError).code}, message: ${(error as Base.BusinessError).message}`);
          }
        })
        .width('100%')
    }
    .height('100%')
  }
}