harmony 鸿蒙Enabling Quick Reply for Cross-device Notifications

2025-06-12
浏览 (5)

Enabling Quick Reply for Cross-device Notifications

Since API version 18, quick reply is enabled for cross-device notifications.

When an application on the phone subscribes to a notification reply event by specifying an event ID and publishes a notification that supports quick reply to the watch, the user can view the notification and quickly reply to it on the watch without unlocking the mobile phone.

Prerequisites

The user has connected the watch to the phone through Huawei Health.
The user has enabled the global notification and the notification for the current application in Huawei Health > Devices > Notifications.

Implementation Principles

The figure below shows the procedure. You only need to implement step 1 and step 2. Step 6 is a user operation. Other operations are implemented by the system.

notification_introduction

APIs

API	Description
publish(request: NotificationRequest): Promise<void>	Publishes a notification.
on(method: string, callback: CalleeCallback): void	Registers a caller notification callback, which is invoked when the target ability registers a function.

How to Develop

Import the related modules.

import { notificationManager } from '@kit.NotificationKit';
import { AbilityConstant, UIAbility, Want } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { rpc } from '@kit.IPCKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';


const TAG: string = '[PublishOperation]';
const DOMAIN_NUMBER: number = 0xFF00;

Enable the application to subscribe to the notification reply event.

class MySequenceable implements rpc.Parcelable {
  inputKey: string = ""
  userInput: string = ""


  constructor(inputKey: string, userInput: string) {
    this.inputKey = inputKey
    this.userInput = userInput
  }


  marshalling(messageParcel: rpc.MessageSequence) {
    messageParcel.writeString(this.inputKey)
    messageParcel.writeString(this.userInput)
    return true
  }


  unmarshalling(messageParcel: rpc.MessageSequence) {
    this.inputKey = messageParcel.readString()
    this.userInput = messageParcel.readString()
    return true
  }
}


function sendMsgCallback(data: rpc.MessageSequence) {
  // Receive the serialized data sent by the client.
  let receivedData = new MySequenceable('', '')
  // receivedData.inputKey is value1.
  receivedData.inputKey = data.readString();
  // The value of receivedData.userInput is the quick reply content specified by the user.
  receivedData.userInput = data.readString();
  hilog.info(0x0000, '01203', "inputKey : " + JSON.stringify(receivedData.inputKey));
  hilog.info(0x0000, '01203', "userInput : " + JSON.stringify(receivedData.userInput));


  return new MySequenceable('', '')
}


export default class EntryAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
    hilog.info(0x0000, '01203', '%{public}s', 'Ability onCreate');
    hilog.info(0x0000, '01203', 'onCreate %{public}s', JSON.stringify(want));
    try {
      // Register sendMsgCallback on the server and subscribe to com.ohos.notification_service.sendReply.
      this.callee.on('com.ohos.notification_service.sendReply', sendMsgCallback)
    } catch (error) {
      hilog.error(DOMAIN_NUMBER, TAG, `Failed to register. Code is ${error.code}, message is ${error.message}`);
    }
    hilog.info(0x0000, '01203', 'register successfully');
  }
}

Publish a notification that can be quickly replied to. This notification must contain actionButtons of userInput, and notificationSlotType must be set to SOCIAL_COMMUNICATION.

// Save the WantAgent object created. It will be used to complete the trigger operations.
let wantAgentObj:WantAgent;
// The abilityName of the wantAgentInfo must be EntryAbility.
let wantAgentInfo:wantAgent.WantAgentInfo = {
  wants: [
    {
      deviceId: '',
      bundleName: 'com.samples.notification',
      abilityName: 'EntryAbility',
      action: '',
      entities: [],
      uri: '',
      parameters: {}
    }
  ],
  actionType: wantAgent.OperationType.START_ABILITY,
  requestCode: 0,
  wantAgentFlags:[wantAgent.WantAgentFlags.CONSTANT_FLAG]
};
// Create a WantAgent object.
wantAgent.getWantAgent(wantAgentInfo, (err: BusinessError, data:WantAgent) => {
  if (err) {
     hilog.error(DOMAIN_NUMBER, TAG, `Failed to get want agent. Code is ${err.code}, message is ${err.message}`);
     return;
  }
  hilog.info(DOMAIN_NUMBER, TAG, 'Succeeded in getting want agent.');
  wantAgentObj = data;
  let notificationRequest: notificationManager.NotificationRequest = {
    id: 1,
    // notificationSlotType must be set to SOCIAL_COMMUNICATION.
    notificationSlotType: notificationManager.SlotType.SOCIAL_COMMUNICATION,
    content: {
      notificationContentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
      normal: {
        title: 'Test_Title',
        text: 'Test_Text',
        additionalText: 'Test_AdditionalText',
      },
    },
    actionButtons: [{
      title: "button1",
      wantAgent: wantAgentObj,
      // userInput must be carried.
      userInput: {"inputKey": "value1"},
    }],
  }
  // Publish the notification.
  notificationManager.publish(notificationRequest, (err: BusinessError) => {
    if (err) {
      hilog.error(DOMAIN_NUMBER, TAG, `Failed to publish notification. Code is ${err.code}, message is ${err.message}`);
      return;
    }
    hilog.info(DOMAIN_NUMBER, TAG, 'Succeeded in publishing notification.');
  });
});