API del SDK

Configurar el modo de depuración API (setDebug)

Versión compatible desde: EPush HarmonyOS SDK v1.0.0

Descripción de la función

• Llamar dentro de AbilityStage(#onCreate)
• Llamar antes de init
• Interfaz opcional

Definición de la API

              
                  /**
     * debug log 设置，默认false
     *
     * @param debug true 为 debug，false 为非 debug
     */
    setDebug(debug: boolean)

            

Ejemplo de código

              
              EPushInterface.setDebug(true)// Habilitar depuración

            

Descripción de parámetros

• Si debug es true, se imprimirán registros de nivel debug; si es false, solo se imprimirán registros de nivel warning o superior.

Configurar la AppKey de EngageLab (setAppKey)

Versión compatible desde: EPush HarmonyOS SDK v1.0.0

Descripción de la función

• Llamar dentro de AbilityStage(#onCreate)
• Llamar antes de init
• Método obligatorio

Definición de la API

              
                  /**
     * 设置appkey
     *
     * @param appKey 为平台的appkey
     */
    setAppKey(appKey: string)

            

Ejemplo de código

              
              EPushInterface.setAppKey("Su_AppKey")

            

Descripción de parámetros

• appKey se obtiene desde la consola de EngageLab.

Configurar el canal de descarga (setChannel)

Versión compatible desde: EPush HarmonyOS SDK v1.0.0

Descripción de la función

Configurar dinámicamente channel (canal de descarga del paquete de la aplicación)

• channel indica el canal de descarga del paquete de la aplicación. Para facilitar las estadísticas por canal, el valor concreto lo define el desarrollador, como AppGallery de Huawei, etc.

• Llamar dentro de AbilityStage(#onCreate)
• Llamar antes de init
• Método obligatorio

Definición de la API

              
                  /**
     * 配置渠道
     *
     * @param channel 渠道名称
     */
    setChannel(channel: string)

            

Ejemplo de código

              
              EPushInterface.setChannel("Nombre_del_Canal")

            

Descripción de parámetros

• channel se define según las necesidades del negocio.

Configurar el número máximo de elementos en caché de mensajes personalizados (setCustomMessageMaxCacheCount)

Versión compatible desde: EPush HarmonyOS SDK v1.0.0

Descripción de la función

Esta API se utiliza para enviar mensajes personalizados de EngageLab (no aplicable a notificaciones) orientados a determinados escenarios de negocio de algunas aplicaciones. Por ejemplo: cuando su servidor envía 100 mensajes personalizados a un usuario, por características del negocio o consideraciones de rendimiento del procesamiento, si solo desea procesar y guardar los 10 más recientes, se puede utilizar esta API.

• Llamar dentro de AbilityStage(#onCreate)
• Llamar antes de init

Definición de la API

              
                  /**
     * 配置自定义后台信息缓存条数
     *
     * @param maxCacheCount 缓存条数
     */
    setCustomMessageMaxCacheCount(maxCacheCount: number)

            

Ejemplo de código

              
              EPushInterface.setCustomMessageMaxCacheCount(2)

            

Descripción de parámetros

• maxCacheCount número de elementos en caché

Controlar el método de solicitud de permisos de notificación (setUserRequestNotificationPermission)

Versión compatible desde: EPush HarmonyOS SDK v1.0.0

Descripción de la función

Permite configurar si el desarrollador realiza por su cuenta la solicitud del permiso de notificación. Cuando se establece en true, EngageLabSDK no solicitará activamente el permiso de notificación; el desarrollador deberá solicitarlo manualmente en su propio código. Cuando se establece en false, EngageLabSDK solicitará automáticamente el permiso de notificación durante la inicialización.

• Llamar dentro de AbilityStage(#onCreate)
• Llamar antes de init
• Interfaz opcional

Definición de la API

              
                  /**
     * 设置是否由用户自己调用通知申请权限
     * @param applicationContext 应用上下文
     * @param enable true: 用户自己调用通知申请权限, false: SDK调用通知申请权限（默认）
     */
    setUserRequestNotificationPermission(applicationContext: common.ApplicationContext, enable: boolean)

            

Ejemplo de código

              
              // 设置用户自己调用通知申请权限
EPushInterface.setUserRequestNotificationPermission(this.context.getApplicationContext(), true)

// 设置SDK调用通知申请权限（默认）
EPushInterface.setUserRequestNotificationPermission(this.context.getApplicationContext(), false)

            

Descripción de parámetros

• enable: si es true, se configura para que el desarrollador solicite por su cuenta el permiso de notificación; si es false, EngageLabSDK solicitará el permiso de notificación (predeterminado)

Habilitar la funcionalidad de negocio de push API (init)

Versión compatible desde: EPush HarmonyOS SDK v1.0.0

Descripción de la función

El servicio de notificaciones push de EngageLab. Tras llamar a esta API, se habilita el servicio push de JPush y se comenzará a recopilar y reportar la información personal del usuario necesaria para las funciones de negocio del SDK.

• Llamar durante el inicio

Definición de la API

              
                 /**
   * 开启推送业务功能
   * @param context 上下文
   */
    init(context: common.UIAbilityContext | common.AbilityStageContext)

            

Ejemplo de código

              
              EPushInterface.init(this.context)

            

Descripción de parámetros

• En AbilityStage, pasar common.AbilityStageContext; en UIAbility, pasar common.UIAbilityContext.

Instrucciones de uso de la API

• Si el desarrollador llama activamente al método init, se habilita el servicio push de JPush.
• Por cumplimiento normativo antes del lanzamiento de la APP, el desarrollador debe llamar a la interfaz para habilitar la funcionalidad de negocio de push y usar el servicio de EngageLab solo después de que el usuario de la APP haya aceptado la política de privacidad y de que el desarrollador confirme que se va a empezar a proporcionar el servicio de push al usuario.
• Para recomendaciones y explicaciones sobre la política de privacidad de la APP, consulte Cómo redactar una política de privacidad conforme。

Obtener el RegistrationID (getRegistrationId)

Versión compatible desde: EPush HarmonyOS SDK v1.0.0

Descripción de la función

• Se debe ejecutar primero init; de lo contrario, la llamada no será válida

Definición de la API

              
                  /**
     * Devuelve el RID registrado
     */
    getRegistrationId(): string

            

Ejemplo de código

              
              let rid = EPushInterface.getRegistrationId()

            

Descripción de parámetros

• Ninguno

Borrar el token (clearToken)

Versión compatible desde: EPush HarmonyOS SDK v1.0.0

Descripción de la función

Borra el token push del dispositivo actual para volver a registrarse y obtener un nuevo token.

• Se debe ejecutar primero init; de lo contrario, la llamada no será válida

Definición de la API

              
                  /**
     * 清除 token
     */
    clearToken()

            

Ejemplo de código

              
              EPushInterface.clearToken()

            

Descripción de parámetros

• Ninguno