Verwenden von AEM Mobile-spezifischen Cordova-kompatiblen Zusatzmodulen

entityName
(Zeichenfolge): der Name der Entität

entityType
(Zeichenfolge): der Typ der Entität

forceUpdate
(Boolesch): bei „true“ Server immer nach der neuesten Version abfragen

success
(Funktion): Rückruffunktion bei Erfolg

error
(Funktion): Rückruffunktion bei Fehler

Bei Erfolg: ein Entity-Objekt

Hinweis: „null“ ist ein gültiger Rückgabewert für dynamische Banner (da diese Eigenschaft für diesen Entitätstyp nicht erforderlich ist).

Bei Fehler: ein cq.mobile.contextError-Objekt mit automatisch ausgefüllter Codeeigenschaft

Unterstützung für Artikel, Banner, Sammlungen, dynamische Banner

entityName muss mit dem Namen (nicht dem Titel) in den On-Demand-Diensten übereinstimmen.

entityType muss mit dem Wert in Entity.type übereinstimmen.

Wenn forceUpdate den Wert „false“ hat und die Entität zwischengespeichert ist, wird diese Entität zurückgegeben. Möglicherweise ist dies nicht die aktuelle Version dieser Entität.

Wenn forceUpdate den Wert „true“ hat, aber keine Verbindung mit dem Server hergestellt werden kann, wird die bestehende Entität zurückgegeben, sofern diese im Cache verfügbar ist. Wenn sie im Cache nicht vorhanden ist, wird der Fehler „NETWORK_ERROR“ zurückgegeben.

Wenn keine Verbindung mit dem Server hergestellt und die angeforderte Entität nicht gefunden werden kann (oder wenn diese eingeschränkt und der Benutzer nicht berechtigt ist), wird der Fehler „ENTITY_NOT_FOUND_ERROR“ zurückgegeben.

entityOrEntityList
(Entity- oder EntityList-Objekt): die Entität oder Entitäten, für die Berechtigungsinformationen abgerufen werden sollen

success
(Funktion): Rückruffunktion bei Erfolg

error
(Funktion): Rückruffunktion bei Fehler

Bei Erfolg:

[
{
"entityName" : <entityName1>,
"isEntitled" : true oder false
},
{
"entityName" : <entityName2>,
"isEntitled" : true oder false
},
]

Bei Fehler: ein cq.mobile.contextError-Objekt mit automatisch ausgefüllter Codeeigenschaft

Unterstützung für Sammlungen

getEntitlementInfo() gibt ausschließlich die Berechtigungsinformationen für Sammlungen zurück. Wenn ein Entity-Objekt an diese Funktion übergeben wird, das keine Sammlung ist, wird der Fehler „WRONG_ENTITY_TYPE_ERROR“ zurückgegeben.

Wenn ein EntityList-Objekt an die Funktion übergeben wird, wird nur entitlementInfo für Sammlungsobjekte zurückgegeben. Wenn keine Sammlungen vorhanden sind, ist das zurückgegebene Array leer.

Ab der 26. Anforderung dieser API innerhalb einer Minute wird der Fehler „NETWORK_RATE_LIMIT_EXCEEDED_ERROR“ zurückgegeben.

Wenn das Gerät offline ist, werden die zwischengespeicherten Berechtigungsinformationen zurückgegeben, sofern vorhanden.

Wenn das Gerät online ist und der Berechtigungsdienst nicht kontaktiert werden kann, wird der Fehler „NETWORK_ERROR“ zurückgegeben.

entity: Der Downloadstatus der Sammlung.

success (Funktion): Rückruffunktion bei Erfolg

error (Funktion): Rückruffunktion bei Fehler

Bei Erfolg:
{ "entityName" : "isSavable" : "progressPercent" :  "downloadState" : }

Bei Fehler: cq.mobile.contextError-Objekt mit ausgefüllter code-Eigenschaft

Unterstützung für Sammlungen

getEntityStatus() ruft die Informationen zum Downloadstatus für die Sammlungsentität ab.

Statusinformationen:

„entityName“: der Name der Sammlungsentität.

„isSavable“: Für die Sammlung muss in den Sammlungseigenschaften festgelegt sein, dass Download (Speichern) zulässig ist, und die Berechtigungen müssen ausreichen, damit „true“ zurückgegeben wird.

„progressPercent“ : Zurzeit heruntergeladener Anteil der Sammlung zwischen 0 und 100 Prozent. Hinweis: Dieser Wert ist möglicherweise nicht immer genau, wenn Informationen aus dem Speicher entfernt wurden. Siehe Downloadstatus weiter unten in diesem Dokument.

Fehler: getEntityStatus() gibt ausschließlich die Berechtigungsstatusinformationen für Sammlungen zurück. Wenn ein Entity-Objekt, das keine Sammlung ist, übergeben wird, nicht gefunden wird oder nicht initialisiert wurde, wird ein Fehler zurückgegeben. Beschreibungen der Fehler finden Sie weiter unten in diesem Dokument.

entity: Die Sammlung, die heruntergeladen und gespeichert werden soll.

isSilent: BOOL – (Nur Android) Bei „true“ wird die Entität im Hintergrund ohne Benachrichtigung gespeichert.

success (Funktion): Rückruffunktion bei Erfolg.

error (Funktion): Rückruffunktion bei Fehler.

Bei Erfolg: { "rawEntity" : "downloadPercent" : "downloadState" }

Bei Fehler: Fehler mit eingefügter Codeeigenschaft

Unterstützung für Sammlungen

saveEntity() lädt die angegebene Sammlungsentität herunter und speichert sie. Dies entspricht dem Tippen auf die Download-Schaltfläche in der Benutzeroberfläche.

Rückruf bei Erfolg: Der Rückruf bei Erfolg gibt das Entitätsobjekt zurück, das gespeichert wird. Der Rückruf bei Erfolg wird außerdem jedes Mal aufgerufen, wenn ein Fortschrittsupdate des Downloads verfügbar ist. Der Fortschritt kann über die Rückgabewerte „downloadPercent“ und „downloadState“ nachverfolgt werden. Beim Initiieren des Speicher-/Downloadvorgangs sollte der Download der Sammlung der aktuelle aktive Download werden. Wenn ein weiterer Sammlungsdownload gestartet wird, wird diese Sammlung der aktive Download und der Download der ersten Sammlung wird angehalten. Der Download der ersten Sammlung sollte fortgesetzt werden und der Status aktiv werden, wenn der Download der zweiten Sammlung abgeschlossen wurde.

Fehler: saveEntity() lädt nur Sammlungen herunter. Wenn ein Entity-Objekt, das keine Sammlung ist, übergeben wird, wenn die Sammlung nicht gefunden wird oder der Download abgebrochen wird, wird ein Fehler zurückgegeben. Beschreibungen der Fehler finden Sie weiter unten in diesem Dokument.

entity: Entity-Objekt – die Entität, die archiviert werden soll (nicht speichern)

success (Funktion): Rückruffunktion bei Erfolg

error (Funktion): Rückruffunktion bei Fehler

Bei Erfolg: ein Entity-Objekt

Bei Fehler: Fehler mit eingefügter Codeeigenschaft

Unterstützung für Sammlungen

archiveEntity() archiviert (Gegenteil von saveEntity()) die angegebene Sammlungsentität. Dies entspricht dem Tippen auf das Häkchen in der Benutzeroberfläche. Wenn die Sammlung vollständig heruntergeladen und gespeichert wurde, markiert archiveEntity die Sammlung als nicht dauerhaft und sie kann bereinigt werden. Wenn die Sammlung aktiv heruntergeladen wird oder in der Download-Warteschlange ist, wird der Download abgebrochen und der bereits heruntergeladene Inhalt wird für die Bereinigung markiert.

Erfolg: Das archivierte Entity-Objekt wird zurückgegeben.

Fehler: archiveEntity() archiviert nur Sammlungen. Wenn ein Entity-Objekt, das keine Sammlung ist, übergeben wird oder die Sammlung nicht gefunden wird, wird ein Fehler zurückgegeben.

success (Funktion): Rückruffunktion bei Erfolg

error (Funktion): Rückruffunktion bei Fehler

Bei Erfolg: Array mit Entity-Objekten

Bei Fehler: Fehler mit eingefügter Codeeigenschaft

Unterstützung für Sammlungen

getSavedEntities() gibt ein Array mit Entity-Objekten zurück, die vollständig heruntergeladen wurden oder sich in der Warteschlange für den Download befinden und gespeichert werden.

width (Zahl): die angeforderte Breite

height (Zahl): die angeforderte Höhe

success (Funktion): Rückruffunktion bei Erfolg

error (Funktion): Rückruffunktion bei Fehler

Bei Erfolg: eine Datei-URL für das Hintergrundbild als Argument der Rückruffunktion bei success

Bei Fehler: ein cq.mobile.contextError-Objekt mit automatisch ausgefüllter Codeeigenschaft

Unterstützung für Sammlungen

Der Laufzeit-Viewer skaliert das Bild nicht; stattdessen wird die Bildgröße zurückgegeben, die der angegebenen Größe am nächsten kommt.

Fordert das Hintergrundbild bei den On-Demand-Diensten an, wenn das Bild nicht auf dem Gerät zwischengespeichert wurde. In den meisten Fällen bleibt das Bild eine Zeit lang im Cache.

Wenn der Aufruf für Entitäten erfolgt, bei deren Typ es sich nicht um eine Sammlung handelt, wird die Fehlerrückruffunktion aufgerufen.

width (Zahl): die angeforderte Breite

height (Zahl): die angeforderte Höhe

success (Funktion): Rückruffunktion bei Erfolg

error (Funktion): Rückruffunktion bei Fehler

Bei Erfolg: eine Datei-URL für das Miniaturbild als Argument der Rückruffunktion bei success

Bei Fehler: ein cq.mobile.contextError-Objekt mit automatisch ausgefüllter Codeeigenschaft

Unterstützung für Artikel, Banner, Sammlungen, dynamische Banner

Der Laufzeit-Viewer skaliert das Bild nicht; stattdessen wird die Bildgröße zurückgegeben, die der angegebenen Größe am nächsten kommt.

Fordert das Miniaturbild bei den On-Demand-Diensten an, wenn das Bild nicht auf dem Gerät zwischengespeichert wurde. In den meisten Fällen bleibt das Bild eine Zeit lang im Cache.

width (Zahl): die angeforderte Breite

height (Zahl): die angeforderte Höhe

success (Funktion): Rückruffunktion bei Erfolg

error (Funktion): Rückruffunktion bei Fehler

Bei Erfolg: eine Datei-URL für das Social Sharing-Bild als Argument der Rückruffunktion bei success

Bei Fehler: ein cq.mobile.contextError-Objekt mit automatisch ausgefüllter Codeeigenschaft

Unterstützung für Artikel

Der Laufzeit-Viewer skaliert das Bild nicht; stattdessen wird die Bildgröße zurückgegeben, die der angegebenen Größe am nächsten kommt.

Fordert das Social Sharing-Bild bei den On-Demand-Diensten an, wenn das Bild nicht auf dem Gerät zwischengespeichert wurde. In den meisten Fällen bleibt das Bild eine Zeit lang im Cache.

Wenn der Aufruf für Entitäten erfolgt, bei deren Typ es sich nicht um eine Sammlung handelt, wird die Fehlerrückruffunktion aufgerufen.

success
(Funktion): Rückruffunktion bei Erfolg

error
(Funktion): Rückruffunktion bei Fehler

Bei Erfolg: ein EntityList-Objekt

Bei Fehler: ein cq.mobile.contextError-Objekt mit automatisch ausgefüllter Codeeigenschaft

Unterstützung für Sammlungen

EntityList enthält alle nicht eingeschränkten untergeordneten Entitäten dieser Sammlung, die sich im Cache befinden. Wenn keine Entitäten vorhanden sind, wird versucht, die erste Serverseite der untergeordneten Entitäten herunterzuladen.

success (Funktion): Rückruffunktion bei Erfolg

error (Funktion): Rückruffunktion bei Fehler

Unterstützung für Artikel

Das ContentLocation-Objekt enthält pageNumber und totalPageCount.
pageNumber ist nullbasiert. Die erste Seite des Artikels ist also 0. Diese Werte stellen den physischen Speicherort des Artikelinhalts dar. Bei HTML-Artikeln haben totalPageCount den Wert 1 und pageNumber den Wert 0.

authToken (Zeichenfolge): der angeforderte Wert von authToken

success (Funktion): Rückruffunktion bei Erfolg

error (Funktion): Rückruffunktion bei Fehler

Bei Erfolg: Rückruffunktion bei Erfolg wird ohne Parameter aufgerufen

Bei Fehler: Rückruffunktion bei Fehler wird mit dem Codesatz „cq.mobile.userError“ aufgerufen

Dieser Aufruf wird nur bei Projekten erfolgreich ausgeführt, für die ein allgemeiner Identitätsanbieter eingerichtet ist oder die nur über einen Anbieter für die direkte Berechtigung (kein Identitätsanbieter) verfügen. Andernfalls wird beim Aufruf dieser API der Fehler „AUTHENTICATION_SUPPORT_ERROR“ zurückgegeben.

Wenn der Aufruf von setAuthToken aus irgendeinem Grund (Fehler „502“, „503“ oder „504“ wird zurückgegeben) fehlschlägt, unternimmt der Viewer im Idealfall einen zweiten Versuch. Wenn der zweite Versuch fehlschlägt oder gar nicht ausgeführt wird, wird ein Netzwerkfehler zurückgegeben.
Jede Anforderung dieser API, während diese noch eine vorige Anfrage verarbeitet, führt so lange zum Fehler „NETWORK_RATE_LIMIT_EXCEEDED_ERROR“, bis die vorige Anfrage „success“ oder „failure“ zurückgibt.

Die elfte Anforderung dieser API innerhalb einer Minute gibt den Fehler „NETWORK_RATE_LIMIT_EXCEEDED_ERROR“ zurück. Jede weitere Anforderung gibt ebenfalls diesen Fehler zurück, bis ab der ersten Anforderung eine Minute verstrichen ist.

Erfolgt die Authentifizierung über einen Berechtigungsserver, wird das native Dialogfeld für die Anmeldung angezeigt.

Wenn die Authentifizierung über einen Identitätsanbieter ausgeführt wird, gibt es je nach Viewer zwei Möglichkeiten: Auf Geräte-Viewern wird die Authentifizierungs-URL in einer Webansicht angezeigt und beim Web Viewer für den Desktop erfolgt eine Weiterleitung zur Authentifizierungs-URL.

Wenn keine Authentifizierungsmethode im Projekt festgelegt ist, gibt der Aufruf dieser API den Fehler „AUTHENTICATION_SUPPORT_ERROR“ zurück.

Wenn der Benutzer bereits authentifiziert ist, wird der Fehler „Ungültiger Authentifizierungsstatus“ zurückgegeben.

Wenn die Authentifizierungseinstellungen vom Web Viewer nicht abgerufen werden können, wird der Fehler „NETWORK_ERROR“ zurückgegeben.

Benutzer können sich bei Geräte-Viewern auch im Offlinemodus abmelden.

Der Benutzer wird abgemeldet und der Abmeldestatus in der Benutzeroberfläche wird aktualisiert.

Wenn keine Authentifizierungsmethode im Projekt festgelegt ist, gibt der Aufruf dieser API den Fehler „AUTHENTICATION_SUPPORT_ERROR“ zurück.

Wenn der Benutzer bereits authentifiziert ist, wird der Fehler „Ungültiger Authentifizierungsstatus“ zurückgegeben.

Wenn die Abmeldung beim Web Viewer nicht ausgeführt werden kann, wird der Fehler „NETWORK_ERROR“ zurückgegeben.

Wenn keine Authentifizierungseinstellungen abgerufen werden können, verwenden Geräte-Viewer zwischengespeicherte Authentifizierungseinstellungen.

success (Funktion): Rückruffunktion bei Erfolg

error (Funktion): Rückruffunktion bei Fehler

Bei Erfolg: Rückruffunktion bei Erfolg wird ohne Parameter aufgerufen

Bei Fehler: Rückruffunktion bei Fehler wird mit dem Codesatz „cq.mobile.userError“ aufgerufen

Versuchen Sie nur dann die Anmeldung des Benutzers mit dieser API zu aktualisieren, wenn Sie feststellen, dass die aktuelle Sitzung nicht mehr gültig ist. Die Anmeldung wird von dieser API nur in den folgenden beiden Szenarien aktualisiert:

1. Das Projekt wird mit einem Berechtigungsdienst, aber ohne benutzerdefinierte Authentifizierung eingerichtet. Durch Aufrufen dieser API wird „renewAuthToken“ im Berechtigungsdienst aufgerufen.

2. Das Projekt wird mit einem OAuth-Identitätsanbieter eingerichtet, durch den ein Aktualisierungstoken bereitgestellt wird. Wird diese API aufgerufen, wird versucht, das Aktualisierungstoken für die Aktualisierung der Anmeldesitzung zu verwenden.

In beiden Szenarien kann die Aktualisierung fehlschlagen. In diesem Fall wird der Benutzer abgemeldet.

In allen anderen Szenarien schlägt diese Aktualisierung fehl und der Benutzer wird abgemeldet und kehrt zur Startseite zurück. Dies gilt auch, wenn diese API in einem Projekt mit einem SAML- oder OAuth-Identitätsanbieter aufgerufen wird, der keine Aktualisierung unterstützt.

Wenn keine Authentifizierungsmethode im Projekt festgelegt ist, gibt der Aufruf dieser API den Fehler „AUTHENTICATION_SUPPORT_ERROR“ zurück.

Wenn der Benutzer nicht authentifiziert ist, wird der Fehler „Ungültiger Authentifizierungsstatus“ zurückgegeben.

Wenn die Viewer offline sind und die Anmeldung daher nicht aktualisiert werden kann, wird der Fehler „NETWORK_ERROR“ zurückgegeben.

Wenn keine Authentifizierungseinstellungen abgerufen werden können, verwenden Geräte-Viewer zwischengespeicherte Authentifizierungseinstellungen.

success: Rückruffunktion bei Erfolg

error: Rückruffunktion bei Fehler

Diese Methode gibt die Abonnementsinformationen für die aktuelle Veröffentlichung und das aktuelle Gerät zurück. Nach 60 API-Anforderungen innerhalb von einer Minute geben alle folgenden Anforderungen dieser API einen Fehler zurück, bis seit der ersten Anforderung eine Minute vergangen ist.

Desktop Web Viewer unterstützt diese API nicht und gibt immer einen Fehler zurück.

collectionName (Zeichenfolge): Der Name der Sammlung.

success (Funktion): Rückruffunktion bei Erfolg

error (Funktion): Rückruffunktion bei Fehler

Bei Erfolg: Ein Array mit Offer-Objekten

Bei Fehler: Fehler mit eingefügter Codeeigenschaft

collectionName muss mit dem im Portal gefundenen Namen übereinstimmen.

Wenn die angeforderte Entität nicht gefunden wird oder die Entität eingeschränkt und nicht sichtbar ist, wird ein Fehler zurückgegeben.

Zwischengespeicherte Angebote für die angeforderte Entität werden zurückgegeben, sofern verfügbar. Andernfalls erfolgt eine Netzwerkanforderung an den Berechtigungsdienst, um die Angebote abzurufen.

Nach 60 Netzwerkanforderungen an den Berechtigungsdienst innerhalb von einer Minute geben alle folgenden Anforderungen dieser API einen Fehler zurück, bis seit der ersten Anforderung eine Minute vergangen ist.

Desktop Web Viewer unterstützt diese API nicht und gibt immer einen Fehler zurück.

productId (Zeichenfolge): Die productId des Kaufangebots.

success (Funktion): Rückruffunktion bei Erfolg

error (Funktion): Rückruffunktion bei Fehler

Bei Erfolg: Es wird eine Kaufanforderung initiiert.

Bei Fehler: Ruft Fehlercode auf.

success (Funktion): Rückruffunktion bei Erfolg

error (Funktion): Rückruffunktion bei Fehler

Bei Erfolg: Hiermit wird das Wiederherstellen einer Kaufanforderung initiiert.

Bei Fehler: Ruft Fehlercode auf.

Diese Methode initiiert das Wiederherstellen vorheriger Kaufvorgänge für den Benutzer.

Nach 5 API-Anforderungen innerhalb von einer Minute geben alle folgenden Anforderungen dieser API einen Fehler zurück, bis seit der ersten Anforderung eine Minute vergangen ist.