harmony 鸿蒙Updating Widget Content by State

2023-06-24
浏览 (463)

Updating Widget Content by State

There are cases where multiple copies of the same widget are added to the home screen to accommodate different needs. In these cases, the widget content needs to be dynamically updated based on the state. This topic exemplifies how this is implemented.

In the following example, two copies of the weather widget are added to the home screen: one for displaying the weather of London, and the other Beijing, both configured to be updated at 07:00 every morning. The widget provider detects the target city, and then displays the city-specific weather information on the widgets.

Widget configuration file: Configure the widget to be updated at 07:00 every morning.

  {
    "forms": [
      {
        "name": "widget",
        "description": "This is a service widget.",
        "src": "./ets/widget/pages/WidgetCard.ets",
        "uiSyntax": "arkts",
        "window": {
          "designWidth": 720,
          "autoDesignWidth": true
        },
        "colorMode": "auto",
        "isDefault": true,
        "updateEnabled": true,
        "scheduledUpdateTime": "07:00",
        "updateDuration": 0,
        "defaultDimension": "2*2",
        "supportDimensions": ["2*2"]
      }
    ]
  }

Widget page: A widget has different states and needs to be updated by state. When the state changes, postCardAction is called to notify the EntryFormAbility.

  let storage = new LocalStorage();
  @Entry(storage)
  @Component
  struct WidgetCard {
    @LocalStorageProp('textA') textA: string = 'To be updated...';
    @LocalStorageProp('textB') textB: string ='To be updated...';
    @State selectA: boolean = false;
    @State selectB: boolean = false;
  
    build() {
      Column() {
        Row() {
          Checkbox({ name: 'checkbox1', group: 'checkboxGroup' })
            .select(false)
            .onChange((value: boolean) => {
              this.selectA = value;
              postCardAction(this, {
                'action': 'message',
                'params': {
                  'selectA': JSON.stringify(value)
                }
              });
            })
          Text ('State A')
        }
  
        Row() {
          Checkbox({ name: 'checkbox2', group: 'checkboxGroup' })
            .select(false)
            .onChange((value: boolean) => {
              this.selectB = value;
              postCardAction(this, {
                'action': 'message',
                'params': {
                  'selectB': JSON.stringify(value)
                }
              });
            })
          Text ('State B')
        }
  
        Row() {// Content that is updated only in state A
          Text ('State A:')
          Text(this.textA)
        }
  
        Row() { // Content that is updated only in state B
          Text ('State B:')
          Text(this.textB)
        }
      }.padding('10%')
    }
  }

EntryFormAbility: The widget state data is stored in the local database. When the update event callback is triggered, the current widget state is obtained through formId, and then content is updated based on the state obtained.

  import formInfo from '@ohos.app.form.formInfo'
  import formProvider from '@ohos.app.form.formProvider';
  import formBindingData from '@ohos.app.form.formBindingData';
  import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
  import dataPreferences from '@ohos.data.preferences';
  import Want from '@ohos.app.ability.Want';
  import Base from '@ohos.base';
  
  export default class EntryFormAbility extends FormExtensionAbility {
    onAddForm(want: Want) {
      let formId: string = '';
      let isTempCard: boolean;
      if (want.parameters) {
        formId = JSON.stringify(want.parameters[formInfo.FormParam.IDENTITY_KEY]);
        isTempCard = want.parameters[formInfo.FormParam.TEMPORARY_KEY] as boolean;
        if (isTempCard === false) {// If the widget is a normal one, the widget information is persisted.
          console.info('Not temp card, init db for:' + formId);
          let promise: Promise<dataPreferences.Preferences> = dataPreferences.getPreferences(this.context, 'myStore');
          promise.then(async (storeDB: dataPreferences.Preferences) => {
            console.info("Succeeded to get preferences.");
            await storeDB.put('A' + formId, 'false');
            await storeDB.put('B' + formId, 'false');
            await storeDB.flush();
          }).catch((err: Base.BusinessError) => {
            console.info(`Failed to get preferences. ${JSON.stringify(err)}`);
          })
        }
      }
      let formData: Record<string, Object|string> = {};
      return formBindingData.createFormBindingData(formData);
    }

    onRemoveForm(formId: string) {
      console.info('onRemoveForm, formId:' + formId);
      let promise = dataPreferences.getPreferences(this.context, 'myStore');
      promise.then(async (storeDB) => {
        console.info("Succeeded to get preferences.");
        await storeDB.delete('A' + formId);
        await storeDB.delete('B' + formId);
      }).catch((err: Base.BusinessError) => {
        console.info(`Failed to get preferences. ${JSON.stringify(err)}`);
      })
    }

    // If the widget is a temporary one, it is recommended that the widget information be persisted when the widget is converted to a normal one.
    onCastToNormalForm(formId: string) {
      console.info('onCastToNormalForm, formId:' + formId);
      let promise: Promise<dataPreferences.Preferences> = dataPreferences.getPreferences(this.context, 'myStore');
      promise.then(async (storeDB: dataPreferences.Preferences) => {
        console.info("Succeeded to get preferences.");
        await storeDB.put('A' + formId, 'false');
        await storeDB.put('B' + formId, 'false');
        await storeDB.flush();
      }).catch((err: Base.BusinessError) => {
        console.info(`Failed to get preferences. ${JSON.stringify(err)}`);
      })
    }

    onUpdateForm(formId: string) {
      let promise: Promise<dataPreferences.Preferences> = dataPreferences.getPreferences(this.context, 'myStore');
      promise.then(async (storeDB: dataPreferences.Preferences) => {
        console.info("Succeeded to get preferences.");
        let stateA = await storeDB.get('A' + formId, 'false');
        let stateB = await storeDB.get('B' + formId, 'false');
        // Update textA in state A.
        if (stateA === 'true') {
          let param: Record<string, string> = { 'textA': 'AAA' };
          let formInfo: formBindingData.FormBindingData = formBindingData.createFormBindingData(param);
          await formProvider.updateForm(formId, formInfo);
        }
        // Update textB in state B.
        if (stateB === 'true') {
          let param: Record<string, string> = { 'textB': 'BBB' };
          let formInfo: formBindingData.FormBindingData = formBindingData.createFormBindingData(param);
          await formProvider.updateForm(formId, formInfo);
        }
        console.info(`Update form success stateA:${stateA} stateB:${stateB}.`);
      }).catch((err: Base.BusinessError) => {
        console.info(`Failed to get preferences. ${JSON.stringify(err)}`);
      })
    }

    onFormEvent(formId: string, message: string) {
      // Store the widget state.
      console.info('onFormEvent formId:' + formId + 'msg:' + message);
      let promise: Promise<dataPreferences.Preferences> = dataPreferences.getPreferences(this.context, 'myStore');
      promise.then(async (storeDB: dataPreferences.Preferences) => {
        console.info("Succeeded to get preferences.");
        let msg: Record<string, string> = JSON.parse(message);
        if (msg.selectA != undefined) {
          console.info('onFormEvent selectA info:' + msg.selectA);
          await storeDB.put('A' + formId, msg.selectA);
        }
        if (msg.selectB != undefined) {
          console.info('onFormEvent selectB info:' + msg.selectB);
          await storeDB.put('B' + formId, msg.selectB);
        }
        await storeDB.flush();
      }).catch((err: Base.BusinessError) => {
        console.info(`Failed to get preferences. ${JSON.stringify(err)}`);
      })
    }
  };

NOTE

When the local database is used for widget information persistence, it is recommended that TEMPORARY_KEY be used in the onAddForm lifecycle callback to determine whether the currently added widget is a normal one. If the widget is a normal one, the widget information is directly persisted. If the widget is a temporary one, the widget information is persisted when the widget is converted to a normal one (onCastToNormalForm). In addition, the persistent widget information needs to be deleted when the widget is destroyed (onRemoveForm), preventing the database size from continuously increasing due to repeated widget addition and deletion.