接收推送

功能描述

当设备在线时，推送会通过阿里云的通道将数据下发到SDK，SDK提供IPushListener接口，用于接收推送的数据。

当下发通知时，SDK会回调相关方法，传递通知数据给应用，并创建通知，将通知展示在手机通知栏。当用户点击通知打开Ability时，SDK提供方法获取通知中携带的通知数据。

当下发消息时，SDK会回调相关方法，传递消息数据给应用。

在SDK接入时，应用需要注册IPushListener接口。

接收推送通知/消息

SDK接入时，应用需要注册IPushListener接口，接收推送数据。示例代码如下：

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

// ************* IPushListener接口实现 begin *************
/**
 * 推送回调接口实现，用于接收推送数据
 */
class MyPushListener implements IPushListener {

  onReceiveNotification(data: PushNotification): boolean {
    // 处理推送通知
    // 返回false 表示不定制通知。返回true，表示定制通知。
    return false;
  }

  onShowNotification(data: PushNotification): void {
    // 处理通知展示事件
  }

  onReceiveMessage(data: PushMessage): void {
    // 处理推送消息
  }
}
// ************* IPushListener接口实现 end *************

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

    aliyunPush.init({
      appKey: '请填入在SDK接入准备工作中查询的应用AppKey',
      appSecret: '请填入在SDK接入准备工作中查询的应用AppSecret',
      context: this.context,
    })

    // ************* 注册IPushListener接口 begin *************
    aliyunPush.setPushListener(new MyPushListener());
    // ************* 注册IPushListener接口 end *************
  }

  // 省略其它代码
}

注册IPushListener接口是SDK接入流程的一部分，完成流程示例请参考SDK接入完整代码示例。

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';

/**
 * 推送回调接口实现，用于接收推送数据
 */
class MyPushListener implements IPushListener {
  onReceiveNotification(data: PushNotification): boolean {
    // ************* 定制通知 begin *************
    aliyunPush.getPushHelper().createNotificationRequest(data).then((request) => {
      // 这里以定制title，在title前增加“紧急：”示意
      if (data.style === 3 && request.content.multiLine !== undefined) {
        request.content.multiLine.title = "紧急：" + request.content.multiLine.title;
        request.content.multiLine.longTitle = "紧急：" + request.content.multiLine.longTitle;
      } else if (request.content.normal !== undefined) {
        request.content.normal.title = "紧急：" + request.content.normal.title;
      }
      // 发布通知
      notificationManager.publish(request).then(() => {
        console.debug(`发布定制的通知成功`)
        // 如果要统一逻辑，这里也可以主动调用onShowNotification方法
        this.onShowNotification(data);
      }).catch((e: BusinessError) => {
        console.error(`发布定制的通知失败 ${e.code} ${e.message}`)
      })
    }).catch((e: PushError) => {
      console.error(`创建通知request失败 ${e.code} ${e.message}`)
    })
    // ************* 定制通知 end *************
    // 返回true，应用自己处理通知
    return true;
  }

  onShowNotification(data: PushNotification): void {
    // 处理通知展示事件
  }

  onReceiveMessage(data: PushMessage): void {
    // 处理推送消息
  }
}

// 省略其它代码

从通知中获取推送数据

推送通知时，可以指定点击通知的后续操作，包括：打开应用首页、打开应用自定义页面。

页面对应Ability启动时，可以调用handleClickNotification方法从Want参数获取推送的数据。

示例代码如下：

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

// ************* 自定义推送数据的处理类 begin *************
class MyPushNotificationHandler implements PushNotificationHandler {
  onClickNotification(data: PushNotification | PushMessage, from: Channel): void {
    // 根据业务处理推送的数据
  }

  noPushData(): void {
    // 没有推送数据，不是用户点击推送通知拉起的界面
  }
}
// ************* 自定义推送数据的处理类 end *************

// 点击通知要打开的Ability
export class TargetAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {

    // ************* 初始化Push begin *************
    aliyunPush.init({
      appKey: '请填入在准备工作中查询的应用AppKey',
      appSecret: '请填入在准备工作中查询的应用AppSecret',
      context: this.context,
    })
    // ************* 初始化Push end *************

    // ************* 处理推送数据 begin *************
    aliyunPush.handleClickNotification(want, new MyPushNotificationHandler())
    // ************* 处理推送数据 end *************

  }

  onNewWant(want: Want, launchParam: AbilityConstant.LaunchParam): void {
    // 页面已经启动的场景
    // ************* 处理推送数据 begin *************
    aliyunPush.handleClickNotification(want, new MyPushNotificationHandler())
    // ************* 处理推送数据 end *************
  }

  // 省略其它代码
}

调用handleClickNotification方法是SDK接入流程的一部分，完整流程示例请参考SDK接入完整代码示例。

/**
 * 推送通道
 */
export enum Channel {
  /**
   * 阿里云通道
   */
  Aliyun,
  /**
   * 鸿蒙厂商通道
   */
  HarmonyOS,
}