Uso de complementos específicos de AEM Mobile adaptados para Cordova

entityName:
Cadena: el nombre de la entidad

entityType:
Cadena: el tipo de entidad

forceUpdate:
Booleano: si “true”, consultar siempre al servidor para obtener la última versión

success:
Función: devolución de llamada correcta

error:
Función: devolución de llamada fallida

si culmina con éxito: un objeto Entity

Nota: null es un valor de retorno permitido para las pancartas dinámicas (ya que no se trata de una propiedad necesaria para este tipo de entidad).

si culmina con un error: el objeto cq.mobile.contextError con la propiedad code completa

Es compatible con artículo, pancarta, colección, pancarta dinámica

entityName debe coincidir con el nombre (no el título) de On-Demand Services.

entityType debe coincidir con los valores de Entity.type

Si el valor de forceUpdate es false y la entidad se almacena en la caché, se mostrará dicha entidad. Es posible que no se trate de la última versión de esa entidad.

Si forceUpdate es verdadero, pero no se puede conectar al servidor, se mostrará la entidad existente si está disponible en la caché. Si no hay nada en la caché, se mostrará un error de red.

Si no puede conectar con el servidor, pero no se puede encontrar la entidad solicitada (o está restringida y el usuario no tiene autorización), se mostrará un error Entity Not Found.

entityOrEntityList:
Objeto de Entity o de EntityList: la entidad o entidades para las que se recupera la información de asignación de derechos

success:
Función: devolución de llamada correcta

error:
Función: devolución de llamada fallida

si culmina con éxito:

[
{
“entityName” : <entityName1>,
“isEntitled” : true o false
},
{
“entityName” : <entityName2>,
“isEntitled” : true o false
},
]

si culmina con un error: el objeto cq.mobile.contextError con la propiedad code completa

Es compatible con colección

getEntitlementInfo () solo devolverá la información de asignación de derechos de las colecciones. Si se transfiere un objeto Entity que no pertenece a la colección, se mostrará un error Wrong Entity Type.

Si se transfiere un objeto EntityList, solo se mostrarán los objetos de la colección entitlementInfo. Si no hay colecciones, se devolverá una matriz vacía.

Si se realiza una vigesimosexta solicitud (y cualquier solicitud subsecuente) a esta API en el periodo de un minuto, se mostrará un error Network Rate Limit Exceeded.

Si el dispositivo está fuera de línea, se mostrará la información de asignación de derechos, independientemente de cuál sea la caché.

Si el dispositivo está en línea y no se puede poner en contacto con el servicio de asignación de derechos, se mostrará un error de red.

entity: El estado de descarga de la colección.

success: Función, la devolución de llamada en caso de éxito

error: Función, la devolución de llamada en caso de error

si culmina con éxito:
{ "entityName" : "isSavable" : "progressPercent" :  "downloadState" : }

si culmina con un error: el objeto cq.mobile.contextError con la propiedad code completa

Es compatible con colección

getEntityStatus() recuperará información del estado de la descarga para la entidad de la colección.

Información de estado:

"entityName": el nombre de la entidad de la colección.

"isSavable": la colección debe estar marcada como descarga (guardar) permitida en las propiedades de la colección y disponer de la suficiente asignación de derechos para devolver True.

"progressPercent" : valor porcentual de 0 a 100 de la colección descargada actualmente. Nota: puede que este valor no siempre sea preciso si la información se ha vaciado de la memoria. Consulte los estados de la descarga que encontrará más adelante en este documento.

Errors: getEntityStatus() solo devolverá la información del estado de asignación de derechos de las colecciones. Si se transfiere, no se encuentra o no se inicializa un objeto Entity que no pertenece a la colección, se mostrará un error. Consulte la lista de errores que encontrará más adelante en este documento.

entity: La colección que se va a descargar y guardar.

isSilent: BOOLEANO, (solo Android) Si el valor es “true”, la entidad se guarda en el fondo sin ninguna notificación.

success: Función, la devolución de llamada en caso de éxito.

error: Función, la devolución de llamada en caso de error.

si culmina con éxito: { "rawEntity" : "downloadPercent" : "downloadState" }

si culmina con un error: Error con la propiedad code completa

Es compatible con colección

saveEntity() descargará y guardará la entidad de colección indicada. Es el equivalente a pulsar el botón de descargar en la interfaz de usuario.

Devolución de llamada en caso de éxito: La devolución de llamada en caso de éxito devuelve el objeto de la entidad que se guarda. Además, la devolución de llamada en caso de éxito se solicitará cada vez que se produzca una actualización del progreso de la descarga. Se puede realizar un seguimiento del progreso mediante los valores de retorno "downloadPercent" y "downloadState". Si se ha iniciado el proceso de guardar/descargar, la descarga de la colección debería convertirse en la descarga actual activa. Si se ha iniciado la descarga de otra colección, dicha colección pasará a ser la descarga activa y la primera colección quedará pausada. La primera colección debería reanudar la descarga y su estado debería pasar a ser activo cuando finalice la descarga de la segunda colección.

Errors: saveEntity() solo descargará colecciones. Si se transfiere un objeto Entity que no pertenece a la colección, si no se encuentra la colección o si se cancela la descarga, se mostrará un error. Consulte la lista de errores que encontrará más adelante en este documento.

entity: objeto Entity, la entidad que se debe archivar (no guardar)

success: Función, la devolución de llamada en caso de éxito

error: Función, la devolución de llamada en caso de error

si culmina con éxito: un objeto Entity

si culmina con un error: un error con la propiedad code completa

Es compatible con colección

archiveEntity() archivará (lo contrario a saveEntity()) la entidad de colección indicada. Es el equivalente a pulsar el botón de la marca de verificación en la interfaz de usuario. Si la colección se ha descargado y guardado completamente, archiveEntity marcará la colección como no persistente y sujeta a purga. Si la colección se está descargando activamente o si está en cola para descargarse, la descarga se cancelará y el contenido que se ha estado descargando se marcará como purgable.

Operación realizada correctamente: el objeto Entity archivado se devuelve.

Errors: archiveEntity() solo archivará colecciones. Si se transfiere un objeto Entity que no pertenece a la colección o si no se encuentra la colección, se mostrará un error.

success: Función, la devolución de llamada en caso de éxito

error: Función, la devolución de llamada en caso de error

si culmina con éxito: matriz de objetos Entity

si culmina con un error: error con la propiedad code completa

Es compatible con colección

getSavedEntities() devolverá una matriz de objetos Entity, cuya descarga se haya completado o esté en cola para descargarse, y se guardará

width: Número, la anchura solicitada

height: Número, la altura solicitada

success: Función, la devolución de llamada en caso de éxito

error: Función, la devolución de llamada en caso de error

si culmina con éxito: un archivo URL a la imagen de fondo como argumento de la devolución de llamada success

si culmina con un error: el objeto cq.mobile.contextError con la propiedad code completa

Es compatible con colección

El visor de Runtime no cambia la escala de la imagen; en lugar de ello, devuelve la imagen al tamaño que más se aproxime al especificado.

Solicitará la imagen de fondo de On-Demand Services si la imagen no se encuentra en la caché del dispositivo. En la mayoría de los casos, la imagen permanecerá en la memoria caché para el futuro inmediato.

Si se trata de realizar la llamada en entidades de otros tipos distintos de Colección, se realizará la devolución de llamada de error.

width: Número, la anchura solicitada

height: Número, la altura solicitada

success: Función, la devolución de llamada en caso de éxito

error: Función, la devolución de llamada en caso de error

si culmina con éxito: un archivo URL a la imagen de miniatura como argumento de la devolución de llamada success

si culmina con un error: el objeto cq.mobile.contextError con la propiedad code completa

Es compatible con artículo, pancarta, colección, pancarta dinámica

El visor de Runtime no cambia la escala de la imagen; en lugar de ello, devuelve la imagen al tamaño que más se aproxime al especificado.

Solicitará la imagen de miniatura de On-Demand Services si la imagen no se encuentra en la caché del dispositivo. En la mayoría de los casos, la imagen permanecerá en la memoria caché para el futuro inmediato.

width: Número, la anchura solicitada

height: Número, la altura solicitada

success: Función, la devolución de llamada en caso de éxito

error: Función, la devolución de llamada en caso de error

si culmina con éxito: un archivo URL a la imagen de uso compartido en redes sociales como argumento de la devolución de llamada success

si culmina con un error: el objeto cq.mobile.contextError con la propiedad code completa

Es compatible con artículo

El visor de Runtime no cambia la escala de la imagen; en lugar de ello, devuelve la imagen al tamaño que más se aproxime al especificado.

Solicitará la imagen de uso compartido en redes sociales de On-Demand Services si la imagen no se encuentra en la caché del dispositivo. En la mayoría de los casos, la imagen permanecerá en la memoria caché para el futuro inmediato.

Si se trata de realizar la llamada en entidades de otros tipos distintos de Colección, se realizará la devolución de llamada de error.

success:
Función: devolución de llamada correcta

error:
Función: devolución de llamada fallida

si culmina con éxito: un objeto EntityList

si culmina con un error: el objeto cq.mobile.contextError con la propiedad code completa

Es compatible con colección

EntityList incluirá todas las entidades secundarias sin restricciones para esta colección, que se encuentra en la caché. Si no existe ninguna, se intenta descargar la primera página del servidor de las entidades secundarias.

success: Función, la devolución de llamada en caso de éxito

error: Función, la devolución de llamada en caso de error

Es compatible con artículo

El objeto ContentLocation incluye pageNumber y totalPageCount.
pageNumber está basado en cero, de manera que 0 es la primera página del artículo. Estos valores reflejan la ubicación física del contenido del artículo. En el caso de los artículos HTML, totalPageCount es 1 y pageNumber será 0.

authToken: enlace el valor solicitado para authToken

success: Función, la devolución de llamada en caso de éxito

error: Función, la devolución de llamada en caso de error

si culmina con éxito: realiza la devolución de llamada en caso de éxito sin parámetros

si culmina con un error: realiza la devolución de la llamada en caso de error con el conjunto de código cq.mobile.userError

Esta llamada se ejecutará correctamente solo en los proyectos con una configuración genérica del proveedor de identidad o que tengan un proveedor de asignación de derechos directo (ningún proveedor de identidad). De lo contrario, se devuelve un error de compatibilidad con la autenticación cuando se llama a esta API.

Si la llamada de setAuthToken falla por algún motivo (devuelve 502, 503 o 504), el visor realizará un reintento. Si se produce un error al reintentar o no se ejecuta el reintento, se devuelve un error de red.
Cualquier solicitud a esta API realizada mientras que una solicitud anterior está en vuelo devolverá un error de límite de la velocidad de la red excedido hasta que cualquier solicitud anterior devuelva una operación realizada correctamente o un error.

La solicitud número 11 para esta API en un período de un minuto devolverá un mensaje de error de límite de la velocidad de la red excedido, al igual que cualquier solicitud subsiguiente tras la número 11 hasta que haya transcurrido un minuto desde la primera solicitud.

Si la autenticación se produce mediante un servidor de asignación de derechos, se mostrará el cuadro de diálogo de inicio de sesión nativo.

Si la autenticación se produce mediante de un proveedor de identidad, la URL de autenticación se mostrará en una vista de web en los visores de los dispositivos o redirigirá a la URL de autenticación del visor web de escritorio.

Si no se especifica ninguna autenticación en el proyecto, la llamada a esta API devolverá un error Authentication Support.

Si el usuario ya se ha autenticado, se mostrará un error de estado de autenticación no válido.

Si el visor web no puede recuperar la configuración de autenticación, se mostrará un error de red.

Los usuarios todavía podrán cerrar sesión en los visores de los dispositivos cuando no dispongan de conexión.

Cierra la sesión del usuario y actualiza el estado de cierre de sesión para que así se refleje en la interfaz de usuario.

Si no se especifica ninguna autenticación en el proyecto, la llamada a esta API devolverá un error Authentication Support.

Si el usuario ya se ha autenticado, se mostrará un error de estado de autenticación no válido.

Si el visor web no puede finalizar sesión, se mostrará un error de red.

Los visores de los dispositivos utilizarán los ajustes de autenticación almacenados en caché cuando no puedan recuperar dichos ajustes.

success: Función, la devolución de llamada en caso de éxito

error: Función, la devolución de llamada en caso de error

si culmina con éxito: realiza la devolución de llamada en caso de éxito sin parámetros

si culmina con un error: realiza la devolución de la llamada en caso de error con el conjunto de código cq.mobile.userError

Use esta API para intentar actualizar el inicio de sesión del usuario solamente cuando determine que la sesión actual ya no es válida. Esta API actualizará el inicio de sesión solamente en dos casos:

1) El proyecto está configurado con un servicio de asignación de derechos, pero sin autenticación personalizada. Al realizar una llamada a esta API también se realizará una llamada de renewAuthToken en el servicio de asignación de derechos.

2) El proyecto está configurado con un proveedor de identidad de OAuth que proporciona un autentificador de actualización. Al realizar una llamada a esta API se intentará utilizar dicho autentificador de actualización para actualizar el inicio de sesión.

La actualización puede fracasar en ambos casos. Si esto sucede, se cerrará la sesión del usuario.

En el resto de casos —incluso si esta API recibe una llamada de una configuración de proyecto con un SAML o un proveedor de identidad OAuth que no admite actualizaciones— esta actualización fallará, se cerrará la sesión del usuario y lo redirigirá a la pantalla de inicio.

Si no se especifica ninguna autenticación en el proyecto, la llamada a esta API devolverá un error Authentication Support.

Si el usuario no se ha autenticado, se mostrará un error de estado de autenticación no válido.

Si los visores están sin conexión y no se puede actualizar el inicio de sesión, se mostrará un error de red.

Los visores de los dispositivos utilizarán los ajustes de autenticación almacenados en caché cuando no puedan recuperar dichos ajustes.

success: La devolución de llamada correcta

error: La devolución de llamada fallida

Este método devuelve la información de suscripción para la publicación y el dispositivo actuales. Tras realizar 60 solicitudes de API en un período de un minuto, cualquier solicitud posterior a esta API mostrará un error hasta que haya pasado un minuto desde la primera solicitud.

Visor web de escritorio no es compatible con esta API y siempre muestra un error.

collectionName: Cadena, el nombre de la colección

success: Función, la devolución de llamada en caso de éxito

error: Función, la devolución de llamada en caso de error

si culmina con éxito: una matriz de objetos de Oferta

si culmina con un error: un error con la propiedad code completa

collectionName debe coincidir con el nombre encontrado en el Portal.

Si no se puede encontrar la entidad solicitada o si está restringida y no se puede ver, se mostrará un error.

Si están disponibles, se devuelven las ofertas existentes en la memoria caché para la entidad solicitada. En caso contrario, se producirá una solicitud al servicio de asignación de derechos para recuperar las ofertas.

Tras realizar 60 solicitudes de red al servicio de asignación de derechos en un período de un minuto, cualquier solicitud posterior a esta API mostrará un error hasta que haya pasado un minuto desde la primera solicitud.

Visor web de escritorio no es compatible con esta API y siempre muestra un error.

productId: Cadena, el productId de la oferta que se va a comprar

success: Función, la devolución de llamada en caso de éxito

error: Función, la devolución de llamada en caso de error

si culmina con éxito: se inicia una solicitud de compra

si culmina con un error: se realiza la llamada del código de error

success: Función, la devolución de llamada en caso de éxito

error: Función, la devolución de llamada en caso de error

si culmina con éxito: se inicia una solicitud de restauración de compra

si culmina con un error: se realiza la llamada del código de error

Este método reiniciará la restauración de compras anteriores del usuario.

Tras realizar 5 solicitudes de API en un período de un minuto, cualquier solicitud posterior a esta API mostrará un error hasta que haya pasado un minuto desde la primera solicitud.