Receive pushes

Feature description

When a device is online, the Alibaba Cloud channel sends pushes to the SDK. The SDK provides the IPushListener interface to receive push data.

When a notification is sent, the SDK calls the relevant callback method, passes the notification data to the application, creates a notification, and displays it in the device's notification bar. When a user taps the notification to open an Ability, the SDK provides a method to retrieve the notification data.

When a message is sent, the SDK calls the relevant callback method and passes the message data to the application.

When you integrate the SDK, the application must register the IPushListener interface.

Receive push notifications or messages

When you integrate the SDK, you can register the IPushListener interface to receive push data. The following code shows an example:

import { AbilityConstant, UIAbility, Want } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { aliyunPush, IPushListener, PushMessage, PushNotification } from '@aliyun/push';

// ************* IPushListener interface implementation begin *************
/**
 * Push callback interface implementation for receiving push data
 */
class MyPushListener implements IPushListener {

  onReceiveNotification(data: PushNotification): boolean {
    // Process the push notification.
    // Return false to not customize the notification. Return true to customize the notification.
    return false;
  }

  onShowNotification(data: PushNotification): void {
    // Process the notification display event.
  }

  onReceiveMessage(data: PushMessage): void {
    // Process the push message.
  }
}
// ************* IPushListener interface implementation end *************

export default class EntryAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {

    aliyunPush.init({
      appKey: 'Enter the AppKey that you queried in the SDK integration preparations.',
      appSecret: 'Enter the AppSecret that you queried in the SDK integration preparations.',
      context: this.context,
    })

    // ************* Register the IPushListener interface begin *************
    aliyunPush.setPushListener(new MyPushListener());
    // ************* Register the IPushListener interface end *************
  }

  // Other code is omitted.
}

Registering the IPushListener interface is part of the SDK integration flow. For a complete code example, see Complete SDK integration code example.

export enum PushDataType {
  Notification = 1,
  Message = 2,
}

export enum OpenType {
  App = 1,
  Ability = 2,
}

import { aliyunPush, IPushListener, PushError, PushMessage, PushNotification } from '@aliyun/push';
import { notificationManager } from '@kit.NotificationKit';
import { BusinessError } from '@kit.BasicServicesKit';

/**
 * Push callback interface implementation for receiving push data
 */
class MyPushListener implements IPushListener {
  onReceiveNotification(data: PushNotification): boolean {
    // ************* Customize notification begin *************
    aliyunPush.getPushHelper().createNotificationRequest(data).then((request) => {
      // This example shows how to customize the title by adding "Urgent: " before it.
      if (data.style === 3 && request.content.multiLine !== undefined) {
        request.content.multiLine.title = "Urgent: " + request.content.multiLine.title;
        request.content.multiLine.longTitle = "Urgent: " + request.content.multiLine.longTitle;
      } else if (request.content.normal !== undefined) {
        request.content.normal.title = "Urgent: " + request.content.normal.title;
      }
      // Publish the notification.
      notificationManager.publish(request).then(() => {
        console.debug(`Custom notification published successfully`)
        // To unify the logic, you can also actively call the onShowNotification method here.
        this.onShowNotification(data);
      }).catch((e: BusinessError) => {
        console.error(`Failed to publish the custom notification: ${e.code} ${e.message}`)
      })
    }).catch((e: PushError) => {
      console.error(`Failed to create the notification request: ${e.code} ${e.message}`)
    })
    // ************* Customize notification end *************
    // Return true to have the application process the notification.
    return true;
  }

  onShowNotification(data: PushNotification): void {
    // Process the notification display event.
  }

  onReceiveMessage(data: PushMessage): void {
    // Process the push message.
  }
}

// Other code is omitted.

Get push data from a notification

When you send a push notification, you can specify the action that occurs when a user taps the notification. These actions include opening the application's homepage or a custom page in the application.

When the corresponding Ability for the page starts, call the handleClickNotification method to retrieve the push data from the Want parameter.

The following code shows an example:

import { aliyunPush, Channel, PushMessage, PushNotification, PushNotificationHandler } from '@aliyun/push';
import { AbilityConstant, UIAbility, Want } from '@kit.AbilityKit';

// ************* Custom push data handler class begin *************
class MyPushNotificationHandler implements PushNotificationHandler {
  onClickNotification(data: PushNotification | PushMessage, from: Channel): void {
    // Process the push data as needed.
  }

  noPushData(): void {
    // No push data. The interface was not launched by a user tapping a push notification.
  }
}
// ************* Custom push data handler class end *************

// The Ability to open when the notification is tapped.
export class TargetAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {

    // ************* Initialize Push begin *************
    aliyunPush.init({
      appKey: 'Enter the AppKey that you queried in the preparations.',
      appSecret: 'Enter the AppSecret that you queried in the preparations.',
      context: this.context,
    })
    // ************* Initialize Push end *************

    // ************* Process push data begin *************
    aliyunPush.handleClickNotification(want, new MyPushNotificationHandler())
    // ************* Process push data end *************

  }

  onNewWant(want: Want, launchParam: AbilityConstant.LaunchParam): void {
    // Scenario where the page is already running.
    // ************* Process push data begin *************
    aliyunPush.handleClickNotification(want, new MyPushNotificationHandler())
    // ************* Process push data end *************
  }

  // Other code is omitted.
}

Calling the handleClickNotification method is part of the SDK integration flow. For a complete code example, see Complete SDK integration code example.

/**
 * Push channel
 */
export enum Channel {
  /**
   * Alibaba Cloud channel
   */
  Aliyun,
  /**
   * HarmonyOS vendor channel
   */
  HarmonyOS,
}