SDK API Guide

Versión aplicable

La versión del SDK de iOS de MTPush a la que corresponde este documento es v3.0.0 o posterior.

Configurar centro de datos

Descripción de la función

Esta función se utiliza para hacer coincidir el centro de datos que se ha seleccionado en el portal de EngageLab. Asegúrese de que el centro de datos configurado sea coherente con el seleccionado en el portal.
Si no se configura, el SDK utilizará el nodo predeterminado del centro de datos de Singapur.

En v4.3.5 y versiones posteriores, esta interfaz no es válida. Los desarrolladores no necesitan llamar manualmente a esta interfaz para configurar el centro de datos. El SDK hará coincidir automáticamente el centro de datos correspondiente en función del appkey.

Versiones compatibles

Versión inicial compatible: v4.3.0

Versión no válida

Versión a partir de la cual expira: v4.3.5

Definición de la interfaz

+ (void)setSiteName:(NSString *)siteName;

              
              + (void)setSiteName:(NSString *)siteName;

Este bloque de código se muestra en una ventana flotante

Descripción de parámetros

siteName
- Nombre del centro de datos

Instrucciones de llamada

Llamar a esta interfaz antes de llamar a la interfaz de inicialización (setupWithOption:channel:apsForProduction:advertisingIdentifier).

API de etiquetas y alias (iOS)

Descripción de la función

<div style="font-size:13px;background: #E0EFFE;border: 1px solid #ACBFD7;border-radius: 3px;padding: 8px 16px;padding-bottom: 0;margin-bottom: 0;"> <p>Recordatorio: <strong>prestar</strong> atención a la gestión del resultado de devolución de llamada al configurar el alias de etiqueta.</p> <p>Solo cuando el valor devuelto en la devolución de llamada sea 0, la configuración se habrá realizado correctamente y se podrá enviar el push al objetivo. De lo contrario, la API del servidor devuelve un error 1011. Todas las funciones de devolución de llamada se ejecutan en el hilo principal.</p> </div>

              
              <div style="font-size:13px;background: #E0EFFE;border: 1px solid #ACBFD7;border-radius: 3px;padding: 8px 16px;padding-bottom: 0;margin-bottom: 0;">
<p>Recordatorio: <strong>prestar</strong> atención a la gestión del resultado de devolución de llamada al configurar el alias de etiqueta.</p>
<p>Solo cuando el valor devuelto en la devolución de llamada sea 0, la configuración se habrá realizado correctamente y se podrá enviar el push al objetivo. De lo contrario, la API del servidor devuelve un error 1011. Todas las funciones de devolución de llamada se ejecutan en el hilo principal.</p>
</div>

Este bloque de código se muestra en una ventana flotante

Se proporcionan varias API relacionadas para manipular alias y etiquetas.
Estas API se pueden llamar en cualquier parte de la aplicación.

Añadir etiquetas

Llamar a esta API para añadir etiquetas y devolver el resultado en un bloque.

Nota: esta interfaz aplica lógica de adición, no de sobrescritura.

(Las secciones Sobrescribir etiquetas, Eliminar etiquetas, Vaciar etiquetas, Consultar etiquetas, Validar etiquetas, Configurar alias, Eliminar alias y Consultar alias aplican el mismo ajuste: “Llamar a esta API…”)

Mensajería in-app

Ejemplo de uso

Instrucciones de uso

Utilizar las interfaces pageEnterTo: y pageLeave: conjuntamente. Llamar a pageEnterTo: al entrar en una página y a pageLeave: al salir de la página.

Obtener RegistrationID

Obtener registrationID

Llamar a esta API para obtener el RegistrationID de la aplicación. El valor correspondiente solo se devuelve si la aplicación se registra correctamente en el servidor de MTPush; de lo contrario, se devuelve una cadena vacía.

Consejos útiles:
En iOS 9, al desinstalar y reinstalar aplicaciones, el devicetoken devuelto por APNs cambiará. El desarrollador debe obtener el RegistrationID más reciente del dispositivo. Para ello, llamar a esta interfaz registrationID en el método de implementación de kMTCNetworkDidLoginNotification para obtener el RegistrationID.

Configurar el badge

Descripción de la función

Para enviar mensajes push, basta con configurar el badge +1; EngageLab incrementará automáticamente en +1 el valor de badge almacenado en el servidor para cada usuario y luego lo enviará al usuario.

Registrar/actualizar notificaciones locales

Descripción de obtención

Asignar request.requestIdentifier en request como parámetro para actualizar el push existente; de lo contrario, se registra un nuevo push.

Configuración del nivel de registro

Habilitar el modo de depuración

Descripción de obtención

Cuando se necesite más información de depuración, Llamar a esta API para habilitar el modo Debug.

Deshabilitar la información de registro

Descripción de obtención

Llamar a esta API cuando no se necesite información de depuración (se recomienda llamar a esta API al publicar para ocultar la información de registro y ahorrar rendimiento).

Configurar el modo de cifrado TCP

Instrucciones de llamada

Llamar a este método antes de inicializar la interfaz.

Función de difusión por voz

Configurar appGroupId

Instrucciones de llamada

Llamar a esta interfaz antes de la interfaz de inicialización.

Configurar si se habilita la difusión por voz

Instrucciones de llamada

Llamar a esta interfaz antes de la interfaz de inicialización. Está deshabilitada de forma predeterminada.

Configurar si se debe restablecer RegistrationID al sustituir el dispositivo

Instrucciones de uso

Llamar a este método antes de la interfaz de inicialización. Está deshabilitado de forma predeterminada.

LiveActivity

Informar de liveActivity PushToStartToken

Llamar a esta API para informar del pushToStartToken de una liveActivity y devolver el resultado en el bloque.

Informar de liveActivity PushToken (actualizar token)

Llamar a esta API para informar del PushToken de una liveActivity concreta y devolver el resultado en el bloque.