Utilisation des plug-ins activés pour Cordova spécifiques à AEM Mobile

entityName :
Chaîne - Nom de l'entité

entityType :
Chaîne - Type de l'entité

forceUpdate:
Booléen - Si « vrai », toujours interroger le serveur pour la dernière version

succès :
Fonction - Rappel de succès

erreur :
Fonction - Rappel d'erreur

pour succès : objet Entity

Remarque : la valeur « null » est une valeur renvoyée autorisée pour les bannières dynamiques (il ne s'agit pas d'une propriété obligatoire pour ce type d'entité)

pour échec : objet cq.mobile.contextError, le code de propriété étant renseigné

Article, bannière, collection, bannière dynamique pris en charge

entityName doit correspondre au nom (et non au titre) trouvé dans les services à la demande.

entityType doit correspondre aux valeurs trouvées dans Entity.type

Si forceUpdate est faux et l'entité est mise en cache, cette entité est retournée. Il est possible qu'il ne s'agisse pas de la dernière version de cette entité.

Si forceUpdate est vrai, mais la connexion au serveur est impossible, l'entité existante est renvoyée, si disponible en mémoire cache. S'il n'y a rien en mémoire cache, une erreur réseau est renvoyée.

Si la connexion au serveur est impossible, mais l'entité demandée est introuvable (ou est restreinte et l'utilisateur n'y a pas droit), une erreur Entité non trouvée est renvoyée.

entityOrEntityList:
Objet Entity ou EntityList - Entité ou entités pour lesquelles les informations sur les droits doivent être extraites

succès :
Fonction - Rappel de succès

erreur :
Fonction - Rappel d'erreur

pour succès :

[
{
« entityName » : <entityName1>,
« isEntitled » : true ou false
},
{
« entityName » : <entityName2>,
« isEntitled » : true ou false
},
]

pour échec : objet cq.mobile.contextError, le code de propriété étant renseigné

Collection prise en charge

getEntitlementInfo () renverra uniquement les informations sur les droits pour les collections. Si un objet Entity ne faisant pas partie d'une collection est transmis, une erreur Type d'entité erroné est renvoyée.

Si un objet EntityList est transmis, seul entitlementInfo pour les objets de collection est renvoyé. S'il n'y a aucune collection, le tableau renvoyé est vide.

La 26ème requête (et toute requête ultérieure) à cette API au cours d'une période d'une minute retournera une erreur Dépassement de la limite de taux de réseau.

Si le périphérique est hors ligne, les informations sur les droits mises en cache sont renvoyées.

Si le périphérique est connecté et le service de droits ne peut pas être contacté, une erreur réseau est renvoyée.

entité : statut de téléchargement de la collection.

succès : Fonction - Rappel de succès

erreur : Fonction - Rappel d'erreur

pour succès :
{ "entityName" : "isSavable" : "progressPercent" : "downloadState" : }

pour échec : objet cq.mobile.contextError, le code de propriété étant renseigné

Collection prise en charge

getEntityStatus() extraira les informations sur le statut de téléchargement pour l'entité de collection.

Informations sur le statut :

« entityName » : nom de l'entité de collection.

« isSavable » : le téléchargement (enregistrement) doit être autorisé dans les propriétés de la collection et celle-ci doit avoir des droits suffisants pour retourner la valeur vrai.

« progressPercent » : quantité de la collection actuellement téléchargée, en pourcentage compris entre 0 et 100. Remarque : cette valeur peut ne pas toujours être précise si les informations ont été purgées de la mémoire. Les différents états de téléchargement sont décrits dans la suite de ce document.

Erreurs : getEntityStatus() renverra uniquement les informations sur le statut des droits pour les collections. Si un objet Entité ne faisant pas partie d'une collection est transmis, non trouvé ou n'a pas été initialisé, une erreur est renvoyée. La liste des erreurs figure dans la suite de ce document.

entité : collection à télécharger et enregistrer.

isSilent : BOOL - (Android uniquement) si vrai, l'entité est sauvegardée en arrière-plan sans notification.

succès : Fonction - Rappel de succès.

erreur : Fonction - Rappel d'erreur.

pour succès : { "rawEntity" : "downloadPercent" : "downloadState" }

pour échec : erreur, le code de propriété étant renseigné

Collection prise en charge

saveEntity() téléchargera et enregistrera l'entité de collection donnée. Cela correspond à cliquer sur le bouton Télécharger dans l'IU.

Rappel de succès : le rappel de succès retourne l'objet Entité enregistré. En outre, le rappel de succès est appelé chaque fois qu'il y a une mise à jour de la progression du téléchargement. La progression peut être suivie via les valeurs retournées « downloadPercent » et « downloadState ». Lorsque l'enregistrement/le téléchargement est initié, le téléchargement de la collection doit devenir le téléchargement actif en cours. Si un autre téléchargement de collection a débuté, cette collection devient le téléchargement actif et la première collection est mise en pause. Le téléchargement de la première collection doit reprendre et le statut prendre la valeur Actif lorsque le téléchargement de la deuxième collection se termine.

Erreurs : saveEntity() téléchargera uniquement des collections. Si un objet Entité ne faisant pas partie d'une collection est transmis, si la collection n'est pas trouvée ou si le téléchargement est annulé, une erreur est renvoyée. La liste des erreurs figure dans la suite de ce document.

entité : objet Entité - entité à archiver (dé-enregistrer)

succès : Fonction - Rappel de succès

erreur : Fonction - Rappel d'erreur

pour succès : objet Entité

pour échec : erreur, le code de propriété étant renseigné

Collection prise en charge

archiveEntity() archivera (contrairement à saveEntity()) l'entité de collection donnée. Cela correspond à cocher la case dans l'IU. Si la collection est entièrement téléchargée et enregistrée, archiveEntity la marque comme non persistante et faisant l'objet de la purge. Si la collection est en cours de téléchargement ou en attente de téléchargement, celui-ci sera annulé et le contenu déjà téléchargé sera marqué comme devant être purgé.

Succès : l'objet Entité archivé est retourné.

Erreurs : archiveEntity() archivera uniquement des collections. Si un objet Entité ne faisant pas partie d'une collection est transmis ou si la collection n'est pas trouvée, une erreur est renvoyée.

succès : Fonction - Rappel de succès

erreur : Fonction - Rappel d'erreur

pour succès : tableau des objets Entité

pour échec : erreur, le code de propriété étant renseigné

Collection prise en charge

getSavedEntities() retournera un tableau des objets Entité entièrement téléchargés ou en file d'attente de téléchargement et qui seront enregistrés.

largeur : Nombre - largeur demandée

hauteur : Nombre - hauteur demandée

succès : Fonction - Rappel de succès

erreur : Fonction - Rappel d'erreur

pour succès : URL de fichier vers l'image d'arrière-plan en tant qu'argument du rappel de succès

pour échec : objet cq.mobile.contextError, le code de propriété étant renseigné

Collection prise en charge

Le lecteur d'exécution n'effectue pas de mise à l'échelle de l'image, mais renvoie la taille de l'image la plus proche de la taille spécifiée.

Demande l'image d'arrière-plan aux services à la demande si l'image n'est pas en cache sur l'appareil. Dans la plupart des cas, l'image reste dans le cache pour le futur immédiat.

Si l'appel est tenté sur les entités de type autre que Collection, le rappel d'erreur est appelé.

largeur : Nombre - largeur demandée

hauteur : Nombre - hauteur demandée

succès : Fonction - Rappel de succès

erreur : Fonction - Rappel d'erreur

pour succès : URL de fichier vers l'image de la vignette en tant qu'argument du rappel de succès

pour échec : objet cq.mobile.contextError, le code de propriété étant renseigné

Article, bannière, collection, bannière dynamique pris en charge

Le lecteur d'exécution n'effectue pas de mise à l'échelle de l'image, mais renvoie la taille de l'image la plus proche de la taille spécifiée.

Demande l'image de la vignette aux services à la demande si l'image n'est pas en cache sur l'appareil. Dans la plupart des cas, l'image reste dans le cache pour le futur immédiat.

largeur : Nombre - largeur demandée

hauteur : Nombre - hauteur demandée

succès : Fonction - Rappel de succès

erreur : Fonction - Rappel d'erreur

pour succès : URL de fichier vers l'image de partage sur les réseaux sociaux en tant qu'argument du rappel de succès

pour échec : objet cq.mobile.contextError, le code de propriété étant renseigné

Article pris en charge

Le lecteur d'exécution n'effectue pas de mise à l'échelle de l'image, mais renvoie la taille de l'image la plus proche de la taille spécifiée.

Demande l'image de partage sur les réseaux sociaux aux services à la demande si l'image n'est pas en cache sur l'appareil. Dans la plupart des cas, l'image reste dans le cache pour le futur immédiat.

Si l'appel est tenté sur les entités de type autre que Collection, le rappel d'erreur est appelé.

succès :
Fonction - Rappel de succès

erreur :
Fonction - Rappel d'erreur

pour succès : objet EntityList

pour échec : objet cq.mobile.contextError, le code de propriété étant renseigné

Collection prise en charge

EntityList contiendra toutes les entités enfant non-restreintes pour cette collection qui se trouvent en mémoire cache. S'il n'en existe aucune, un téléchargement de la première page serveur des enfants est tenté.

succès : Fonction - Rappel de succès

erreur : Fonction - Rappel d'erreur

Article pris en charge

L'objet ContentLocation comporte pageNumber et totalPageCount.
pageNumber est en base zéro, 0 est donc la première page de l'article. Ces valeurs reflètent l'emplacement physique du contenu de l'article. Pour les articles HTML, totalPageCount est 1 et pageNumber est 0.

authToken : chaîne - valeur demandée pour authToken

succès : Fonction - Rappel de succès

erreur : Fonction - Rappel d'erreur

pour succès : appelle le rappel de succès sans paramètres

pour échec : appelle le rappel d'erreur avec le code cq.mobile.userError défini

Cet appel s'exécute correctement uniquement sur les projets qui ont une configuration de fournisseur d'identité générique ou qui ont uniquement un fournisseur de droits directs (aucun fournisseur d'identité). Dans le cas contraire, une erreur de prise en charge d'authentification est renvoyée lorsque cette API est appelée.

Si l'appel de setAuthToken échoue pour une raison quelconque (erreur 502, 503 ou 504 retournée), le lecteur réessaie en principe une fois. Si le nouvel essai échoue ou si aucun nouvel essai est exécuté, une erreur réseau est renvoyée.
Toute requête à cette API effectuée lorsqu'une requête précédente est en cours retournera une erreur de dépassement de la limite de taux de réseau jusqu'à ce que la requête précédente retourne un succès ou un échec.

La 11ème requête à cette API dans une période d'une minute retournera une erreur de dépassement de la limite de taux de réseau, de même que chaque requête suivante après cette 11ème requête, jusqu'à ce qu'une minute se soit écoulée depuis la 1ère requête.

Si l'authentification est effectuée via un serveur de droits, la boîte de dialogue de connexion native est affichée.

Si l'authentification est effectuée via un fournisseur d'identité, l'URL d'authentification est affichée dans une vue web sur des lecteurs des périphériques ou elle redirige vers l'URL d'authentification sur le lecteur web pour ordinateur.

Si aucune authentification n'est spécifiée dans le projet, l'appel de cette API renvoie une erreur de prise en charge de l'authentification.

Si l'utilisateur est déjà authentifié, une erreur État d'authentification non valide est renvoyée.

Si le lecteur web n'arrive pas à extraire les paramètres d'authentification, une erreur réseau est renvoyée.

Les utilisateurs peuvent toujours se déconnecter des lecteurs de périphériques en étant hors connexion.

Déconnecte l'utilisateur et actualise l'état de déconnexion à refléter dans l'interface utilisateur.

Si aucune authentification n'est spécifiée dans le projet, l'appel de cette API renvoie une erreur de prise en charge de l'authentification.

Si l'utilisateur est déjà authentifié, une erreur État d'authentification non valide est renvoyée.

Si le lecteur web n'arrive pas se déconnecter, une erreur réseau est renvoyée.

Si les paramètres d'authentification ne peuvent pas être extraits, les lecteurs de périphériques utilisent les paramètres d'authentification en mémoire cache.

succès : Fonction - Rappel de succès

erreur : Fonction - Rappel d'erreur

pour succès : appelle le rappel de succès sans paramètres

pour échec : appelle le rappel d'erreur avec le code cq.mobile.userError défini

Utilisez cette API pour essayer d'actualiser la connexion de l'utilisateur uniquement lorsque vous déterminez que la session en cours n'est plus valide. Cette API actualise la connexion dans deux cas uniquement :

1) Le projet est configuré avec un service de droits mais sans authentification personnalisée. L'appel de cette API entraîne un appel de renewAuthToken sur le service de droits.

2) Le projet est configuré avec un fournisseur d'identité OAuth qui fournit pour un jeton actualisé. L'appel de cette API tente d'utiliser ce jeton actualisé pour actualiser la connexion de la session.

Dans les deux cas, l'actualisation peut ne pas réussir. Si cela se produit, l'utilisateur est déconnecté.

Dans tous les autres cas, notamment si cette API est appelée sur une configuration du projet avec un fournisseur d'identité SAML ou OAuth ne prenant pas en charge l'actualisation, cette actualisation échoue, déconnecte l'utilisateur et renvoie l'utilisateur sur la page d'accueil.

Si aucune authentification n'est spécifiée dans le projet, l'appel de cette API renvoie une erreur de prise en charge de l'authentification.

Si l'utilisateur n'est pas authentifié, une erreur État d'authentification non valide est renvoyée.

Si les lecteurs sont hors ligne et la connexion ne peut pas être actualisée, une erreur réseau est renvoyée.

Si les paramètres d'authentification ne peuvent pas être extraits, les lecteurs de périphériques utilisent les paramètres d'authentification en mémoire cache.

succès : rappel de succès

erreur : rappel d'erreur

Cette méthode retourne les informations d'abonnement de la publication et de l'appareil en cours. Après 60 requêtes d'API effectuées dans une période d'une minute, toute requête suivante à cette API retournera une erreur jusqu'à ce qu'une minute se soit écoulée depuis la première requête.

Le lecteur web pour ordinateur ne prend en charge cette API et retourne toujours une erreur.

collectionName : Chaîne - nom de la collection

succès : Fonction - Rappel de succès

erreur : Fonction - Rappel d'erreur

pour succès : tableau des objets Offre

pour échec : erreur, le code de propriété étant renseigné

collectionName doit correspondre au nom trouvé dans Portal.

Si l'entité demandée est introuvable ou si elle est restreinte et non visible, une erreur est renvoyée.

Les offres en cache pour l'entité demandée sont renvoyées, si disponibles. Sinon, une demande réseau au service de droites est envoyée pour extraire les offres.

Après 60 requêtes du réseau au service de droites effectuées dans une période d'une minute, toute requête suivante aux résultats de cette API retournera une erreur jusqu'à ce qu'une minute se soit écoulée depuis la première requête.

Le lecteur web pour ordinateur ne prend en charge cette API et retourne toujours une erreur.

productId : Chaîne - productId de l'offre à acheter

succès : Fonction - Rappel de succès

erreur : Fonction - Rappel d'erreur

pour succès : une demande d'achat est initiée

pour échec : code erreur des appels

succès : Fonction - Rappel de succès

erreur : Fonction - Rappel d'erreur

pour succès : une demande de restauration des achats est initiée

pour échec : code erreur des appels

Cette méthode initie une restauration des précédents achats pour l'utilisateur.

Après 5 requêtes d'API effectuées dans une période d'une minute, toute requête suivante à cette API retournera une erreur jusqu'à ce qu'une minute se soit écoulée depuis la première requête.