Anforderungen

Grundlagen

  • Grundlagen von AEM Mobile
  • Grundlagen des Erstellens und Veröffentlichens von Inhalten über das On-Demand-Portal
  • Kenntnisse in JavaScript 

Erforderliche Produkte

  • AEM Mobile

Einführung

Bei Experience Manager Mobile-spezifischen Cordova-kompatiblen Zusatzmodulen handelt es sich um eine Gruppe von JavaScript-APIs, die den Zugriff auf bestimmte Daten im Zusammenhang mit der Anwendung und dem gerade angezeigten Artikel bereitstellen. Wenn Sie Cordova-Zusatzmodule für AEM Mobile mit Artikeln verwenden möchten, haben Sie hierzu zwei Möglichkeiten: Entweder wählen Sie über das On-Demand-Dienste-Portal in den Artikeleigenschaften die Option „Erweiterungsfunktionen aktivieren“ oder Sie setzen über die On-Demand Services API in den Artikelentitäts-Metadaten den Parameter isTrustedContent auf „true“.

Die AEM Mobile-spezifischen Cordova-kompatiblen Zusatzmodule verwenden den Namespace cq.mobile, um Konflikte mit anderen Cordova-Zusatzmodulen zu vermeiden. Die API besteht aus mehreren Modulen, wobei es sich bei jedem Modul um ein Singleton mit einer bestimmten Anzahl von Methoden und Eigenschaften handelt.

Weitere Informationen zur Verwendung der Cordova-Haupt-APIs finden Sie unter Verwenden von Cordova-Zusatzmodulen in AEM Mobile.

Die Cordova-kompatiblen Zusatzmodule sind in „Kontext“, „Gerät“, „Anwendung“ und „Benutzer“ unterteilt.

 

Cordova-Beispiele

Video zur GetEntity API

Video zur GetEntity API

Kontext-APIs

Eigenschaften: Kontext

Das Kontextmodul erlaubt den Zugriff auf Entitätsinformationen im entsprechenden Kontext.

Verfügbarkeit

Dieses Zusatzmodul definiert das globale cq.mobile.context-Objekt. Es ist erst nach dem deviceready-Ereignis verfügbar.

Name Typ Flüchtig Kommentare
cq.mobile.context.collection Entität1 Nein Kann leer (null) sein, wenn der aktuelle Kontext ein verwaister Kontext ist.
cq.mobile.context.entity Entität1 Nein

Gibt die Entität im Gültigkeitsbereich zurück.

Gültigkeitsbereiche:

  • Inhalts-WebView – Der in der Webansicht angezeigte Inhalt.
  • Überlagerungs-WebView – Der Inhalt, zu dem die Überlagerung gehört.
  • Dynamische Banner-WebView – Das dynamische Banner, zu dem die Webansicht gehört.
cq.mobile.context.nextEntity Entität1 Nein

Kann leer (null) sein, wenn dies die letzte Entität ist.

Hinweis: Bei einem dynamischen Banner ist die nächste Entität die dem dynamischen Banner nachfolgende Entität in der Durchsuchen-Ansicht. Dabei muss es sich nicht um die nächste Entität im Element-Array der übergeordneten Sammlung handeln. Hier besteht ein Unterschied zum Aufruf der Funktion „nextEntity“ von einem Artikel aus. Dabei wird die Reihenfolge des Element-Arrays der übergeordneten Sammlung zurückgegeben, der deren untergeordnete Elemente enthält.

cq.mobile.context.previousEntity Entität1 Nein

Kann leer (null) sein, wenn dies die erste Entität ist.

Die Hinweise zur Funktion „nextEntity“ gelten auch für dynamische Banner.

cq.mobile.context.type Zeichenfolge Nein Mögliche Werte: „article“, „overlay“, „dynamicBanner“

1 Die Entität enthält folgende Felder, wie im nächsten Abschnitt beschrieben: id, metadata, rootPath und type

Eigenschaften: Entity

Name Typ Kommentare
id Zeichenfolge  
metadata Objekt2 Für den Entitätstyp spezifische Metadaten
rootPath Zeichenfolge Gilt nur für Artikel und dynamische Banner. Stellt den Stammpfad der Entität dar, die im aktuellen Kontext ausgeführt wird. Kann als Verweis auf andere Zusatzmodule verwendet werden, um einen Pfad zu einer Ressource in der Entität zu erstellen (nur iOS und Android).
type Zeichenfolge Mögliche Werte: „collection“, „article“, „banner“, „dynamicBanner“

2 Das metadata-Objekt enthält verschiedene Felder, abhängig vom Elementtyp, wie im nächsten Abschnitt beschrieben.

Eigenschaften: Metadata

Name Typ Unterstützung für Entität Kommentare
abstract
Zeichenfolge Artikel, Sammlung, Banner, dynamisches Banner  
accessState Zeichenfolge Artikel
Mögliche Werte: „free“, „metered“, „protected“
adCategory Zeichenfolge Artikel, dynamisches Banner
 
adType Zeichenfolge Artikel, dynamisches Banner
Mögliche Werte: „static“, „EFT“
allowDownload Boolesch Sammlung  
articleText Zeichenfolge Artikel
 
author Zeichenfolge Artikel
 
authorURL Zeichenfolge Artikel
 
availabilityDate Zeichenfolge Artikel, Sammlung, Banner, dynamisches Banner  
advertiser Zeichenfolge Artikel, dynamisches Banner
 
category Zeichenfolge Artikel, Sammlung, Banner, dynamisches Banner  
created Zeichenfolge Artikel, Sammlung, Banner, dynamisches Banner  
department Zeichenfolge Artikel, Sammlung, Banner, dynamisches Banner  
entityName Zeichenfolge Artikel, Sammlung, Banner, dynamisches Banner  
hideFromBrowsePage Boolesch Artikel
 
importance Zeichenfolge Artikel, Sammlung, Banner, dynamisches Banner Mögliche Werte: „low“, „normal“, „high“
isAd Boolesch Artikel, dynamisches Banner
 
isIssue Boolesch Artikel
 
keywords Zeichenfolgenarray Artikel, Sammlung, Banner, dynamisches Banner  
lateralNavigation Boolesch Sammlung  
modified Zeichenfolge Artikel, Sammlung, Banner, dynamisches Banner  
openTo Zeichenfolge Sammlung Mögliche Werte: „browsePage“, „contentView“
productIds Zeichenfolgenarray Sammlung  
published Zeichenfolge Artikel, Sammlung, Banner, dynamisches Banner  
readingPosition Zeichenfolge Sammlung Mögliche Werte: „reset“, „retain“
shortAbstract Zeichenfolge Artikel, Sammlung, Banner, dynamisches Banner  
shortTitle Zeichenfolge Artikel, Sammlung, Banner, dynamisches Banner  
socialShareUrl Zeichenfolge Artikel, Sammlung, Banner, dynamisches Banner  
tapAction Zeichenfolge Banner  
title Zeichenfolge Artikel, Sammlung, Banner, dynamisches Banner  
url Zeichenfolge Artikel, Sammlung, Banner, dynamisches Banner  
version Zeichenfolge Artikel, Sammlung, Banner, dynamisches Banner  

Methoden

Name Argumente Antwort Kommentare
getEntity
(entityName,
entityType, forceUpdate,
success, error)

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.

getEntitlementInfo
(entityOrEntityList,
success, error)

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.

getEntityStatus
(entity, success, error)

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.

saveEntity(entity, isSilent, success, error)

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.

archiveEntity(entity, success, error)

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.

getSavedEntities(success, error)

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.

getBackgroundImage
(width, height, success, error)

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.

getThumbnailImage
(width, height, success, error)

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.

 

getSocialSharingImage
(width, height, success, error)

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.

getChildren(success, error)

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.

getContentLocation(success, error)

success (Funktion): Rückruffunktion bei Erfolg

error (Funktion): Rückruffunktion bei Fehler

Bei Erfolg: gibt ein ContentLocation-Objekt zurück

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.

Weitere Informationen zu diesen Metadateneigenschaften finden Sie unter Integration von Drittanbietersystemen mit AEM Mobile.

Eigenschaften: EntityList

Name Typ Kommentare
entities Array Liste der Entitäten. Mögliche Entitäten: „article“, „collection“, „banner“
hasNextPage Boolesch Bei „true“ sind mehrere Entitäten in der Liste vorhanden. Verwenden Sie die Methode getNextPage(), um die nächste Listenseite mit Entitäten abzurufen.

Methoden

Name Argumente Antwort Unterstützt Entität. Kommentare
getNextPage
(success, error)

success
(Funktion): Rückruffunktion bei Erfolg

error
(Funktion): Rückruffunktion bei Fehler

Bei Erfolg: die Entitätseigenschaft enthält zusätzliche Entity-Elemente und die hasNextPage-Eigenschaft wird aktualisiert.

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

Sammlung

Wenn hasNextPage den Wert „false“ hat und getNextPage() aufgerufen wird, wird der Fehler „NO_MORE_ENTITY_PAGES_ERROR“ zurückgegeben.

Die zurückgegebenen Entitäten sind nicht eingeschränkt. Die eingeschränkten Informationen können sich geändert haben, seitdem getNextPage() zuletzt aufgerufen wurde. In diesem Fall wird der Fehler „ENTITY_PAGE_OUT_OF_DATE_ERROR“ zurückgegeben. Führen Sie getEntity() für die Sammlung aus, um die aktualisierte Sammlung abzurufen. Rufen Sie anschließend getChildren() mit dieser aktualisierten Sammlung auf.

Eigenschaften: contextError

cq.mobile.contextError ist ein Aufzählungsobjekt, das alle unterstützten Fehlercodes für context-Methoden definiert.

Name Wert
cq.mobile.contextError.UNKNOWN_ERROR
0
cq.mobile.contextError.INVALID_ARGUMENT_ERROR
10
cq.mobile.contextError.ENTITY_IMAGE_TYPE_NOT_SUPPORTED_FOR_ENTITY_ERROR
11
cq.mobile.contextError.NETWORK_ERROR
20
cq.mobile.contextError.NETWORK_RATE_LIMIT_EXCEEDED_ERROR
21
cq.mobile.contextError.ENTITY_IMAGE_ENTITY_NOT_FOUND_ERROR
40
cq.mobile.contextError.ENTITY_IMAGE_NETWORK_ERROR
41
cq.mobile.contextError.ENTITY_IMAGE_NOT_FOUND_ERROR
50
cq.mobile.contextError.ENTITY_NOT_FOUND_ERROR
61
cq.mobile.contextError.WRONG_ENTITY_TYPE_ERROR
71
cq.mobile.contextError.NO_MORE_ENTITY_PAGES_ERROR
72
cq.mobile.contextError.ENTITY_PAGE_OUT_OF_DATE_ERROR
73
cq.mobile.contextError.ENTITY_OUT_OF_DATE_ERROR 74
cq.mobile.contextError.ENTITY_SAVE_FAILURE 80
cq.mobile.contextError.ENTITY_SAVE_CANCELLED 80

 

Eigenschaften – Downloadstatus

cq.mobile.downloadState ist ein Aufzählungsobjekt, das alle unterstützten Fehlercodes für Methoden für den Sammlungs-Download definiert.

Name Wert
cq.mobile.downloadState.NONE
0
cq.mobile.downloadState.DOWNLOAD_PAUSED
1
cq.mobile.downloadState.DOWNLOAD_ACTIVE
2
cq.mobile.downloadState.DOWNLOAD_COMPLETE
3

 

Geräte-APIs

Das Gerätemodul stellt den Wert aus dem nativen Code bereit. Beachten Sie, dass diese Eigenschaften sich in einem anderen Namespace als das Cordova-Gerätezusatzmodul befinden (window.cq.mobile.device statt window.device).

Verfügbarkeit

Die folgenden Eigenschaften werden zusätzlich zu den Cordova-Gerätezusatzmodulen hinzugefügt.

Eigenschaften: Device

Name Typ Flüchtig
Kommentare
cq.mobile.device.class Zeichenfolge Nein Mögliche Werte: „Phone“, „Tablet“ (Windows gibt nur „Tablet“ zurück, da Smartphones nicht unterstützt werden.)
cq.mobile.device.vendorId Zeichenfolge Nein Nur iOS (siehe IdentifierForVendor im iOS-Entwicklerhandbuch)

Anwendungs-APIs

Verfügbarkeit

Dieses Zusatzmodul definiert das globale cq.mobile.application-Objekt. Es ist erst nach dem deviceready-Ereignis verfügbar.

Eigenschaften: Application

Name Typ Flüchtig Kommentare
cq.mobile.application.id Zeichenfolge Nein Beispiel: com.adobe.create
cq.mobile.application.pushNotificationToken Zeichenfolge Nein Push-Benachrichtigungstoken für das Gerät (Gerätetoken in iOS, Registrierungs-ID in Android; Windows-Viewer hat keine Push-Benachrichtigung implementiert, sodass der Wert zunächst „undefined“ lautet.)
cq.mobile.application.runtimeVersion Zeichenfolge Nein Beispiel: 2015.5.1
cq.mobile.application.version Zeichenfolge Nein Version der App, z. B. 1.0.4
cq.mobile.application.isAppSearchEnabled Boolesch Ja
Überprüfung, ob die Suche aktiviert ist
cq.mobile.application.isSocialSharingEnabled Boolesch Ja Überprüfung, ob Social Sharing aktiviert ist

Benutzer-APIs

Verfügbarkeit

Dieses Zusatzmodul definiert das globale cq.mobile.user-Objekt. Es ist erst nach dem deviceready-Ereignis verfügbar.

Ereignisse

Name Kommentare
isauthenticatedchanged Dieses Ereignis wird ausgelöst, wenn sich der Authentifizierungsstatus des Benutzers ändert. Clients sollten den aktuellen Status des Benutzerobjekts abfragen.
authtokenchanged Dieses Ereignis wird ausgelöst, wenn sich die Authentifizierungstoken des Benutzers ändern. Clients sollten den aktuellen Status des Benutzerobjekts abfragen.

Eigenschaften: Application

Name Typ Flüchtig Kommentare
cq.mobile.user.authToken Zeichenfolge Ja  
cq.mobile.user.isAuthenticated Boolesch Ja  

Methoden

Name Argumente Antwort Kommentare
setAuthToken(authToken, success, error)

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.

launchSignInUX(error) error (Funktion): Rückruffunktion bei Fehler Bei Fehler: Rückruffunktion bei Fehler wird mit dem Codesatz „cq.mobile.userError“ aufgerufen

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.

signOut(error) error (Funktion): Rückruffunktion bei Fehler Bei Fehler: Rückruffunktion bei Fehler wird mit dem Codesatz „cq.mobile.userError“ aufgerufen

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.

refreshSignIn(success, error)

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.

Hinweis:

Wenn bei einem dieser API-Aufrufe ein unerwarteter Fehler auftritt, wird der Code „UNKNOWN_ERROR“ in der Rückruffunktion für Fehler zurückgegeben.

 

Eigenschaften: userError

cq.mobile.userError ist ein Aufzählungsobjekt, das alle unterstützten Fehlercodes für user-Methoden definiert.

Name Wert
cq.mobile.userError.UNKNOWN_ERROR
0
cq.mobile.userError.INVALID_ARGUMENT_ERROR
10
cq.mobile.userError.AUTHENTICATION_SUPPORT_ERROR
11
cq.mobile.userError.INVALID_AUTHENTICATION_STATE
12
cq.mobile.userError.NETWORK_ERROR
41
cq.mobile.userError.NETWORK_RATE_LIMIT_EXCEEDED_ERROR
42
cq.mobile.userError.UNAUTHORIZED
43

Berechtigungs-APIs

Verfügbarkeit

Dieses Zusatzmodul definiert ein globales Berechtigungsobjekt, das Methoden für Berechtigungen und Kaufvorgänge bereitstellt. Es ist erst nach dem deviceready-Ereignis verfügbar.

Eigenschaften – Angebot

Name Typ Kommentare
productId Zeichenfolge Die Produkt-/Abonnement-ID, die im Abschnitt „Produkte und Abonnements“ im Portal angezeigt wird.
label Zeichenfolge Der Produkt-/Abonnementname, der im Abschnitt „Produkte und Abonnements“ im Portal angezeigt wird. Dieser Wert ist null, wenn er nicht vom Benutzer festgelegt wird.
description Zeichenfolge Die Produkt-/Abonnementbeschreibung, die im Abschnitt „Produkte und Abonnements“ im Portal angezeigt wird. Dieser Wert ist null, wenn er nicht vom Benutzer festgelegt wird.
price Zeichenfolge Der Preis, der vom entsprechenden Store zurückgegeben wird. Null, wenn das Produkt kostenlos ist.
offerType Zeichenfolge Kann „subscription“ oder „product“ sein.

Eigenschaften – Abonnementsinformationen

Name Typ Kommentare
subscriptionOffers Array Ein Array mit Offer-Objekten. Leer, wenn der Benutzer über ein aktives Abonnement verfügt.
subscriptionState Objekt Ein subscriptionState-Objekt.

Eigenschaften – Abonnementsstatus

Name Typ Kommentare
isSubscriber
Boolesch „True“, wenn der Benutzer zu irgendeinem Zeitpunkt Abonnent war. Beachten Sie, dass subscriptionState.isSubscriber identisch mit subscriptionState.store.isSubscriber und subscriptionState.integrator.isSubscriber ist.
isActiveSubscriber
Boolesch „True“, wenn der Benutzer über ein aktives Abonnement verfügt.
store Objekt Store-Objekt mit dem Abonnementsstatus für den Produkt-Store.
integrator Objekt Integrator-Objekt, das den Abonnementsstatus für den Berechtigungs-Integrator enthält.

Eigenschaften – Store

Name Typ Kommentare
isSubscriber
Boolesch „True“, wenn der Benutzer zu irgendeinem Zeitpunkt Abonnent war.
isActiveSubscriber
Boolesch „True“, wenn der Benutzer über ein aktives Abonnement verfügt.
expirationDate Zahl Der Zeitstempel in Millisekunden seit dem Ablaufdatum. Dieser Wert kann null sein, wenn das Abonnement (vom Store oder Berechtigungs-Integrator) kein Ablaufdatum hat.
subscriptionType Zeichenfolge Kann „allAccess“ oder „standard“ lauten. Nur gültig, wenn isSubscriber den Wert „true“ aufweist.
id Zeichenfolge Produkt-ID des Abonnementsprodukts im Store.

Eigenschaften – Integrator

Name Typ Kommentare
isSubscriber
Boolesch „True“, wenn der Benutzer zu irgendeinem Zeitpunkt Abonnent war.
isActiveSubscriber
Boolesch „True“, wenn der Benutzer über ein aktives Abonnement verfügt.
expirationDate Zahl Der Zeitstempel in Millisekunden seit dem Ablaufdatum. Dieser Wert kann null sein, wenn das Abonnement (vom Store oder Berechtigungs-Integrator) kein Ablaufdatum hat.
customData Zeichenfolge customData wird nicht festgelegt, wenn ein nebengeordneter isSubscriber den Wert „false“ aufweist. Wenn isSubscriber den Wert „true“ aufweist, kann dies festgelegt werden oder nicht. customData kann vom Integrator zurückgegeben werden. Hierin sollen Daten enthalten sein, die transparent für Adobe und nur für den Kunden von Bedeutung sind.

Methoden

Name Argumente Antwort Kommentare
getSubscriptionInfo(success, error)

success: Rückruffunktion bei Erfolg

error: Rückruffunktion bei Fehler

Bei Erfolg: Ein SubscriptionInfo-Objekt.

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.

getOffers(collectionName, success, error)

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.

purchaseOffer(productId, success, error)

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.

Diese Methode initiiert eine Kaufanforderung.
restorePurchases(successCallback, errorCallback)

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.

Fehler – Berechtigung

cq.mobile.entitlementError ist ein Aufzählungsobjekt, das alle unterstützten Fehlercodes für Berechtigungsmethoden definiert.

Name Wert
cq.mobile.entitlementError.UNKNOWN_ERROR 0
cq.mobile.entitlementError.INVALID_ARGUMENT_ERROR
10
cq.mobile.entitlementError.ENTITY_IMAGE_TYPE_NOT_SUPPORTED_FOR_ENTITY_ERROR 11
cq.mobile.entitlementError.INVALID_AUTHENTICATION_STATE 12
cq.mobile.entitlementError.NETWORK_ERROR 20
cq.mobile.entitlementError.NETWORK_RATE_LIMIT_EXCEEDED_ERROR 21
cq.mobile.entitlementError.ENTITY_IMAGE_ENTITY_NOT_FOUND_ERROR
40
cq.mobile.entitlementError.ENTITY_IMAGE_NETWORK_ERROR 41
cq.mobile.entitlementError.ENTITY_IMAGE_NOT_FOUND_ERROR 50
cq.mobile.entitlementError.ENTITY_NOT_FOUND_ERROR 61
cq.mobile.entitlementError.WRONG_ENTITY_TYPE_ERROR 71
cq.mobile.entitlementError.NO_MORE_ENTITY_PAGES_ERROR 72
cq.mobile.entitlementError.ENTITY_PAGE_OUT_OF_DATE_ERROR 73
cq.mobile.entitlementError.ENTITY_OUT_OF_DATE_ERROR 74
cq.mobile.entitlementError.ENTITY_SAVE_FAILURE 80
cq.mobile.entitlementError.ENTITY_SAVE_CANCELLED 81

Änderungsprotokoll

16. März 2017

API-Informationen zum Herunterladen von Sammlungsentitäten hinzugefügt.

API-Informationen für Kaufen und Berechtigungen hinzugefügt.

10. Januar 2017

cq.mobile.application.isAppSearchEnabled und cq.mobile.application.isSocialSharingEnabled hinzugefügt (siehe Anwendungsbereich)

9. August 2016

getLocationContent hinzugefügt (siehe Kontextbereich)

30. Juni 2016

setAuthToken hinzugefügt (siehe Benutzerbereich)

23. Juni 2016

Möglichkeit hinzugefügt, die Sammlungsstruktur der On-Demand-Dienste zu durchlaufen:

  • Entitätsmetadaten mit Unterstützung für Banner hinzugefügt (siehe Registerkarte „Kontext“)
  • Abfragen der Artikel-/Banner-/Sammlungsentität über getEntity() hinzugefügt (siehe Registerkarte „Kontext“)
  • Abfragen der Berechtigungsinformationen der Sammlung über getEntitlementInfo() hinzugefügt (siehe Registerkarte „Kontext“)
  • Abfragen der Liste direkt untergeordneter Entitäten der Sammlung über getChildren() hinzugefügt (siehe Registerkarte „Kontext“)
  • Abfragen der nächsten Seite mit Entitäten der Liste, die von getChildren() zurückgegeben wurde, mit „getNextPage()“ hinzugefügt (siehe Registerkarte „Kontext“)
  • Aufzählungsobjekte hinzugefügt, um die Fehlercodes für die in „cq.mobile.context“ und „cq.mobile.user“ verwendeten Methoden zu definieren (siehe Registerkarten „Kontext“ und „Benutzer“)

 

Dieses Werk unterliegt den Bedingungen der Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License.  Twitter™- und Facebook-Beiträge fallen nicht unter die Bedingungen der Creative Commons-Lizenz.

Rechtliche Hinweise   |   Online-Datenschutzrichtlinie