Vereisten

Vereiste kennis

  • Kennis van AEM Mobile
  • Kennis van het maken en publiceren van inhoud via de on-demandportal
  • Kennis van JavaScript 

Vereiste producten

  • AEM Mobile

Inleiding

De specifieke plug-ins van Cordova voor Experience Manager Mobile zijn een set JavaScript-API's die toegang bieden tot specifieke gegevens met betrekking tot de toepassing en het huidige artikel dat wordt weergegeven. Als u wilt gebruikmaken van plug-ins van Cordova voor AEM Mobile, moet de optie “Uitbreidingsmogelijkheden inschakelen” zijn geselecteerd in de artikeleigenschappen op de portal voor on-demandservices of moet de parameter isTrustedContent in de entiteitsmetagegevens zijn ingesteld op true via de On-Demand Services API.

De specifieke plug-ins van Cordova voor AEM Mobile gebruiken de naamruimte cq.mobile om conflicten met andere plug-ins van Cordova te voorkomen. De API bestaat uit verschillende modules, waarbij elke module een singleton is met een aantal methoden en eigenschappen.

Zie Plug-ins van Cordova gebruiken in AEM Mobile voor meer informatie over het gebruiken van kern-Cordova-API's.

Plug-ins die geschikt zijn voor Cordova zijn verdeeld in Context, Apparaat, Toepassing en Gebruiker.

 

Cordova-voorbeelden

GetEntity-API (video)

GetEntity-API (video)

Context-API's

Eigenschappen - Context

De contextmodule biedt toegang tot entiteitsinformatie binnen de gegeven context.

Beschikbaarheid

Deze plug-in definieert het algemene object cq.mobile.context. Dit is pas beschikbaar na de gebeurtenis deviceready.

Naam Type Altijd herberekenen Opmerkingen
cq.mobile.context.collection Entiteit1 Nee Kan leeg (null) zijn als de huidige context een verweesde context is.
cq.mobile.context.entity Entiteit1 Nee

Retourneert de entiteit binnen het bereik.

Bereiken:

  • WebView-inhoud: de inhoud die wordt weergegeven in de webweergave.
  • WebView-overlay: de inhoud waartoe de overlay behoort.
  • Dynamische banner van WebView: de dynamische banner waartoe de webweergave behoort.
cq.mobile.context.nextEntity Entiteit1 Nee

Kan leeg (null) zijn als dit de laatste entiteit is.

Opmerking: De volgende entiteit voor een dynamische banner is de entiteit die volgt op de dynamische banner in een bladerweergave, en deze entiteit kan verschillen van de volgende entiteit in de matrix met elementen van de bovenliggende collectie. Dit wijkt af van wat er gebeurt als nextEntity wordt aangeroepen vanuit een artikel (waarmee de volgorde wordt geretourneerd vanuit de matrix met onderliggende elementen van de bovenliggende collectie).

cq.mobile.context.previousEntity Entiteit1 Nee

Kan leeg (null) zijn als dit de eerste entiteit is.

Zie voor dynamische banners de bovenstaande opmerking voor nextEntity.

cq.mobile.context.type Tekenreeks Nee Mogelijke waarden: “article”, “overlay”, “dynamicBanner”

1 De entiteit bevat de volgende velden, zoals beschreven in de volgende sectie: id, metadata, rootPath en type

Eigenschappen - Entiteit

Naam Type Opmerkingen
id Tekenreeks  
metadata Object2 Specifieke metagegevens voor het type entiteit
rootPath Tekenreeks Alleen van toepassing op artikelen en dynamische banners. Geeft de hoofdmap van de entiteit aan die in de huidige context wordt uitgevoerd. Kan worden gebruikt als verwijzing naar andere plug-ins om een pad te ontwikkelen naar een bron binnen de entiteit. (Alleen iOS en Android.)
type Tekenreeks Mogelijke waarden: “collection”, “article”, “banner”, “dynamicBanner”

2 Het object Metadata bevat een afwijkende set velden, afhankelijk van het type entiteit, zoals wordt beschreven in de volgende sectie.

Eigenschappen - Metagegevens

Naam Type Ondersteuning voor Entiteit Opmerkingen
abstract
Tekenreeks Artikel, Collectie, Banner, Dynamische banner  
accessState Tekenreeks Artikel
Mogelijke waarden: “free”, “metered”, “protected”
adCategory Tekenreeks Artikel, Dynamische banner
 
adType Tekenreeks Artikel, Dynamische banner
Mogelijke waarden: “static”, “EFT”
allowDownload Boolean Collectie  
articleText Tekenreeks Artikel
 
author Tekenreeks Artikel
 
authorURL Tekenreeks Artikel
 
availabilityDate Tekenreeks Artikel, Collectie, Banner, Dynamische banner  
advertiser Tekenreeks Artikel, Dynamische banner
 
category Tekenreeks Artikel, Collectie, Banner, Dynamische banner  
created Tekenreeks Artikel, Collectie, Banner, Dynamische banner  
department Tekenreeks Artikel, Collectie, Banner, Dynamische banner  
entityName Tekenreeks Artikel, Collectie, Banner, Dynamische banner  
hideFromBrowsePage Boolean Artikel
 
importance Tekenreeks Artikel, Collectie, Banner, Dynamische banner Mogelijke waarden: “low”, “normal”, “high”
isAd Boolean Artikel, Dynamische banner
 
isIssue Boolean Artikel
 
keywords Matrix van tekenreeksen Artikel, Collectie, Banner, Dynamische banner  
lateralNavigation Boolean Collectie  
modified Tekenreeks Artikel, Collectie, Banner, Dynamische banner  
openTo Tekenreeks Collectie Mogelijke waarden: “browsePage”, “contentView”
productIds Matrix van tekenreeksen Collectie  
published Tekenreeks Artikel, Collectie, Banner, Dynamische banner  
readingPosition Tekenreeks Collectie Mogelijke waarden: “reset”, “retain”
shortAbstract Tekenreeks Artikel, Collectie, Banner, Dynamische banner  
shortTitle Tekenreeks Artikel, Collectie, Banner, Dynamische banner  
socialShareUrl Tekenreeks Artikel, Collectie, Banner, Dynamische banner  
tapAction Tekenreeks Banner  
title Tekenreeks Artikel, Collectie, Banner, Dynamische banner  
url Tekenreeks Artikel, Collectie, Banner, Dynamische banner  
version Tekenreeks Artikel, Collectie, Banner, Dynamische banner  

Methoden

Naam Argumenten Respons Opmerkingen
getEntity
(entityName,
entityType, forceUpdate,
success, error)

entityName:
tekenreeks; de naam van de entiteit

entityType:
tekenreeks; het type entiteit

forceUpdate:
Booleaans; indien 'true' dan altijd een query uitvoeren op de server voor de meest recente versie

success:
functie; de callback in het geval van een succes

error:
functie; de callback in het geval van een fout

indien gelukt: het object Entity

Opmerking: null is een toegestane retourwaarde voor Dynamische banners (omdat dit geen vereiste eigenschap voor dit type entiteit is).

indien mislukt: het object cq.mobile.contextError met ingevulde code-eigenschappen

Ondersteunt Artikel, Banner, Collectie, Dynamische banner

entityName moet overeenkomen met de naam (niet de titel) in de on-demandservices.

entityType moet overeenkomen met waarden in Entity.type

Als forceUpdate Onwaar is en de entiteit in het cachegeheugen staat, wordt die entiteit geretourneerd. Mogelijk is dit niet de meest recente versie van die entiteit.

Als forceUpdate Waar is maar geen verbinding met de server kan worden gemaakt, wordt de bestaande entiteit geretourneerd indien deze beschikbaar is in het cachegeheugen. Als er geen entiteiten in het cachegeheugen bestaan, wordt een netwerkfout geretourneerd.

Als er geen verbinding met de server kan worden gemaakt en de vereiste entiteit niet kan worden gevonden (of wanneer er een beperking geldt en de gebruiker niet is gemachtigd), wordt de fout “Entiteit niet gevonden” geretourneerd.

getEntitlementInfo
(entityOrEntityList,
success, error)

entityOrEntityList:
het object Entity off EntityList; de entiteit(en) waarvoor de machtigingsgegevens worden opgehaald

success:
functie; de callback in het geval van een succes

error:
functie; de callback in het geval van een fout

indien gelukt:

[
{
“entityName” : <entityName1>,
“isEntitled” : Waar of Niet waar
},
{
“entityName” : <entityName2>,
“isEntitled” : Waar of Niet waar
},
]

indien mislukt: het object cq.mobile.contextError met ingevulde code-eigenschappen

Ondersteunt Collectie

Met getEntitlementInfo() worden alleen machtigingsgegevens voor collecties geretourneerd. Als het object Entity wordt goedgekeurd voor een niet-collectie, wordt de fout Onjuist entiteitstype geretourneerd.

Als het object EntityList wordt goedgekeurd, wordt alleen entitlementInfo voor collectie-objecten geretourneerd. Als er geen collecties zijn, is de geretourneerde matrix leeg.

Wanneer u binnen een minuut voor de 26 keer (of vaker) een verzoek naar deze API verzendt, wordt de fout Netwerksnelheidslimiet overschreden geretourneerd.

Als het apparaat offline is, worden machtigingsgegevens uit het cachegeheugen geretourneerd.

Als het apparaat online is maar u geen contact met de machtigingsservice kunt maken, wordt een netwerkfout geretourneerd.

getEntityStatus
(entity, success, error)

entity: De downloadstatus van de collectie.

success: functie. Callback bij voltooiing.

error: functie. Callback bij fout.

indien gelukt:
{ "entityName" : "isSavable" : "progressPercent" : "downloadState" : }

indien mislukt: het object cq.mobile.contextError met ingevulde code-eigenschappen

Ondersteunt Collectie

getEntityStatus() haalt informatie over de downloadstatus voor de collectie-entiteit op.

Statusinformatie:

"entityName": de naam van de collectie-entiteit.

"isSavable": de collectie moet zijn ingesteld als 'downloaden (opslaan) toegestaan' in de collectie-eigenschappen en over voldoende machtigingen beschikken om Waar te retourneren.

"progressPercent": het percentage van de collectie dat momenteel is gedownload tussen 0 en 100 procent. Opmerking: deze waarde is mogelijk niet altijd accuraat als de informatie uit het geheugen is verwijderd. Raadpleeg de downloadstatussen verderop in dit artikel.

Fouten: met getEntityStatus() wordt alleen statusinformatie over de machtigingen voor collecties geretourneerd. Als een Entity-object wordt doorgegeven dat geen collectie is, als het object niet wordt gevonden of als het niet is geïnitialiseerd, wordt een fout geretourneerd. Raadpleeg de lijst met fouten verderop in dit artikel.

saveEntity(entity, isSilent, success, error)

entity: De collectie die moet worden gedownload en opgeslagen.

isSilent: BOOL (alleen Android). Indien 'Waar' wordt de entiteit zonder melding opgeslagen op de achtergrond.

success: functie. Callback bij voltooiing.

error: functie. Callback bij fout.

indien gelukt: { "rawEntity" : "downloadPercent" : "downloadState" }

indien mislukt: Fout met ingevulde code-eigenschap

Ondersteunt Collectie

saveEntity() downloadt de opgegeven collectie-entiteit en slaat deze op. Dit is het equivalent van klikken op de downloadknop in de interface.

Callback bij voltooiing: de callback bij voltooiing retourneert het entiteitsobject dat wordt opgeslagen. De callback bij voltooiing wordt telkens aangeroepen wanneer er een voortgangsupdate van de download is. De voortgang kan worden bijgehouden via de retourwaarden "downloadPercent" en "downloadState". Als het opslaan/downloaden is gestart, wordt de collectiedownload de huidige actieve download. Als een andere collectie wordt gedownload, wordt die collectie de actieve download en wordt de eerste collectie onderbroken. Nadat de tweede collectie is gedownload, moet het downloaden van de eerste collectie worden hervat en moet de status weer 'actief' worden.

Fouten: saveEntity() downloadt alleen collecties. Als een Entity-object wordt doorgegeven dat geen collectie is, als de collectie niet wordt gevonden of als de download wordt geannuleerd, wordt een fout geretourneerd. Raadpleeg de lijst met fouten verderop in dit artikel.

archiveEntity(entity, success, error)

entity: Entiteitsobject. De entiteit die moet worden gearchiveerd (opslaan ongedaan gemaakt)

success: functie. Callback bij voltooiing.

error: functie. Callback bij fout.

indien gelukt: een Entity-object

indien mislukt: een fout met ingevulde code-eigenschap

Ondersteunt Collectie

archiveEntity() archiveert (in tegenstelling tot saveEntity()) de opgegeven collectie-entiteit. Dit is het equivalent van tikken op het vinkje in de interface. Als de collectie helemaal is gedownload en opgeslagen, markeert archiveEntity de collectie als niet-permanent, waardoor deze mag worden verwijderd. Als de collectie actief wordt gedownload of in de wachtrij staat om te worden gedownload, wordt de download geannuleerd en wordt de reeds gedownloade inhoud gemarkeerd als 'mag worden verwijderd'.

Success: het gearchiveerde Entity-object wordt geretourneerd.

Fouten: archiveEntity() archiveert alleen collecties. Als een Entity-object wordt doorgegeven dat geen collectie is of als de collectie niet wordt gevonden, wordt een fout geretourneerd.

getSavedEntities(success, error)

success: functie. Callback bij voltooiing.

error: functie. Callback bij fout.

indien gelukt: een matrix met Entity-objecten

indien mislukt: fout met ingevulde code-eigenschap

Ondersteunt Collectie

getSavedEntities() retourneert een matrix met Entity-objecten die volledig zijn gedownload of in de wachtrij staan om te worden gedownload en die worden opgeslagen.

getBackgroundImage
(width, height, success, error)

width: getal, de gewenste breedte

height: getal, de gewenste hoogte

success: functie. Callback bij voltooiing.

error: functie. Callback bij fout.

indien gelukt: een bestands-URL naar de achtergrondafbeelding als argument voor de callback voor voltooid

indien mislukt: het object cq.mobile.contextError met ingevulde code-eigenschappen

Ondersteunt Collectie

De Runtime-viewer schaalt de afbeelding niet. In plaats daarvan wordt de afbeeldingsgrootte weergegeven die het dichtst bij de opgegeven grootte ligt.

Vraagt naar het achtergrondbeeld van de On-Demand Services als dit niet in cache is opgeslagen op het apparaat. In de meeste gevallen blijft de afbeelding in cache opgeslagen voor de nabije toekomst.

Als de aanroep wordt geprobeerd voor entiteiten van een ander type dan Collectie, wordt de callback voor fout aangeroepen.

getThumbnailImage
(width, height, success, error)

width: getal, de gewenste breedte

height: getal, de gewenste hoogte

success: functie. Callback bij voltooiing.

error: functie. Callback bij fout.

indien gelukt: een bestands-URL naar de miniatuurafbeelding als argument voor de callback voor voltooid

indien mislukt: het object cq.mobile.contextError met ingevulde code-eigenschappen

Ondersteunt Artikel, Banner, Collectie, Dynamische banner

De Runtime-viewer schaalt de afbeelding niet. In plaats daarvan wordt de afbeeldingsgrootte weergegeven die het dichtst bij de opgegeven grootte ligt.

Vraagt naar de miniatuurafbeelding van de on demand-services als de afbeelding niet in cache is opgeslagen op het apparaat. In de meeste gevallen blijft de afbeelding in cache opgeslagen voor de nabije toekomst.

 

getSocialSharingImage
(width, height, success, error)

width: getal, de gewenste breedte

height: getal, de gewenste hoogte

success: functie. Callback bij voltooiing.

error: functie. Callback bij fout.

indien gelukt: een bestands-URL naar de afbeelding voor sociaal delen als argument voor de callback voor voltooid

indien mislukt: het object cq.mobile.contextError met ingevulde code-eigenschappen

Ondersteunt Artikel

De Runtime-viewer schaalt de afbeelding niet. In plaats daarvan wordt de afbeeldingsgrootte weergegeven die het dichtst bij de opgegeven grootte ligt.

Vraagt naar de afbeelding voor sociaal delen van de on demand-services als de afbeelding niet in cache is opgeslagen op het apparaat. In de meeste gevallen blijft de afbeelding in cache opgeslagen voor de nabije toekomst.

Als de aanroep wordt geprobeerd voor entiteiten van een ander type dan Collectie, wordt de callback voor fout aangeroepen.

getChildren(success, error)

success:
functie. Callback bij voltooiing.

error:
functie. Callback bij fout.

indien gelukt: het object EntityList

indien mislukt: het object cq.mobile.contextError met ingevulde code-eigenschappen

Ondersteunt Collectie

De EntityList bevat alle niet-beperkte onderliggende entiteiten in het cachegeheugen voor deze collectie. Als het cachegeheugen geen entiteiten bevat, wordt de eerste serverpagina met onderliggende elementen gedownload.

getContentLocation(success, error)

success: functie. Callback bij voltooiing.

error: functie. Callback bij fout.

indien gelukt: het ContentLocation-object wordt geretourneerd

Ondersteunt Artikel

Het ContentLocation-object bevat pageNumber en totalPageCount.
De waarde voor pageNumber is op nul gebaseerd, dus 0 is de eerste pagina van het artikel. Deze waarden geven de fysieke locatie van de inhoud in het artikel aan. Voor HTML-artikelen heeft totalPageCount de waarde 1 en pageNumber de waarde 0.

Zie Systemen van derden integreren met AEM Mobile voor meer informatie over deze eigenschappen van metagegevens.

Eigenschappen - EntityList

Naam Type Opmerkingen
entiteiten Matrix Lijst met entiteiten. Mogelijke entiteiten: “article”, “collection”, “banner”.
hasNextPage Boolean Indien 'Waar' dan staan er meer entiteiten in de lijst. Gebruik de methode getNextPage() om de volgende pagina met entiteiten uit de lijst op te halen.

Methoden

Naam Argumenten Respons Ondersteuning voor Entiteit Opmerkingen
getNextPage
(success, error)

success:
functie. Callback bij voltooiing.

error:
functie. Callback bij fout.

indien gelukt: de eigenschap entities bevat extra Entity-items en de eigenschap hasNextPage wordt bijgewerkt

indien mislukt: het object cq.mobile.contextError met ingevulde code-eigenschappen

Collectie

Als getNextPage() wordt aangeroepen als hasNextPage is ingesteld op false, wordt de fout Geen entiteitspagina's meer geretourneerd.

De geretourneerde entiteiten worden niet beperkt. De beperkte informatie is mogelijk gewijzigd sinds de laatste keer dat getNextPage() is aangeroepen. In dat geval wordt de fout Entiteitspagina verouderd geretourneerd. U moet getEntity() aanroepen voor de collectie zodat de bijgewerkte collectie wordt opgehaald. Ook moet u getChildren() aanroepen met deze bijgewerkte collectie.

Eigenschappen: Contextfout

cq.mobile.contextError is een opsommingsobject dat alle ondersteunde foutcodes voor contextmethoden definieert.

Naam Waarde
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

 

Eigenschappen: Downloadstatus

cq.mobile.downloadState is een opsommingsobject dat alle ondersteunde foutcodes voor downloadmethoden voor collecties definieert.

Naam Waarde
cq.mobile.downloadState.NONE
0
cq.mobile.downloadState.DOWNLOAD_PAUSED
1
cq.mobile.downloadState.DOWNLOAD_ACTIVE
2
cq.mobile.downloadState.DOWNLOAD_COMPLETE
3

 

Apparaat-API's

De apparaatmodule levert de waarde vanuit de systeemeigen code. Houd er rekening mee dat deze eigenschappen zich in een andere naamruimte bevinden dan de apparaatplug-in van Cordova (window.cq.mobile.device versus window.device).

Beschikbaarheid

De volgende eigenschappen worden toegevoegd naast de apparaatplug-ins van Cordova.

Eigenschappen - Apparaat

Naam Type Altijd herberekenen
Opmerkingen
cq.mobile.device.class Tekenreeks Nee Mogelijke waarden: Phone, Tablet (Windows geeft alleen Tablet aangezien telefoons niet worden ondersteund)
cq.mobile.device.vendorId Tekenreeks Nee Alleen iOS (zie IdentifierForVendor in de ontwikkelaarshandleiding voor iOS)

Toepassings-API's

Beschikbaarheid

Deze plug-in definieert het algemene object cq.mobile.application. Dit is pas beschikbaar na de gebeurtenis deviceready.

Eigenschappen - Toepassing

Naam Type Altijd herberekenen Opmerkingen
cq.mobile.application.id Tekenreeks Nee Voorbeeld: com.adobe.create
cq.mobile.application.pushNotificationToken Tekenreeks Nee Token voor pushmelding voor het apparaat (apparaattoken op iOS, Registratie-id op Android; Windows-viewer heeft pushmeldingen niet geïmplementeerd, dus tot dat gebeurt, is de waarde “undefined”)
cq.mobile.application.runtimeVersion Tekenreeks Nee Voorbeeld: 2015.5.1
cq.mobile.application.version Tekenreeks Nee De versie van de app, bijvoorbeeld 1.0.4.
cq.mobile.application.isAppSearchEnabled Boolean Ja
Controleren of Zoeken is ingeschakeld
cq.mobile.application.isSocialSharingEnabled Boolean Ja Controleren of Sociaal delen is ingeschakeld

Gebruikers-API's

Beschikbaarheid

De plug-in definieert het algemene object cq.mobile.user. Dit is pas beschikbaar na de gebeurtenis deviceready.

Gebeurtenissen

Naam Opmerkingen
isauthenticatedchanged De gebeurtenis wordt geactiveerd wanneer de gebruiker de verificatiestatus wijzigt. Clients moeten een query voor het gebruikersobject uitvoeren voor de meest recente status.
authtokenchanged De gebeurtenis wordt geactiveerd wanneer de gebruikersverificatietoken wordt gewijzigd. Clients moeten een query voor het gebruikersobject uitvoeren voor de meest recente status.

Eigenschappen - Toepassing

Naam Type Altijd herberekenen Opmerkingen
cq.mobile.user.authToken Tekenreeks Ja  
cq.mobile.user.isAuthenticated Boolean Ja  

Methoden

Naam Argumenten Respons Opmerkingen
setAuthToken(authToken, success, error)

authToken: tekenreeks, de aangevraagde waarde voor authToken

success: functie. Callback bij voltooiing.

error: functie. Callback bij fout.

indien gelukt: roept de callback voor succes aan zonder parameters

indien mislukt: roept callback voor fout aan met codeset cq.mobile.userError

Deze aanroep wordt alleen correct uitgevoerd voor projecten waarvoor een algemene configuratie voor de identiteitsprovider of een provider voor directe machtiging (geen identiteitsprovider) is ingesteld. Anders wordt een ondersteuningsfout voor verificatie geretourneerd wanneer deze API wordt aangeroepen.

Als de aanroep van setAuthToken mislukt vanwege een bepaalde reden (er wordt een 502-, 503- of 504-fout geretourneerd), wordt in het beste geval eenmaal een nieuwe poging gedaan met de viewer. Als de nieuwe poging mislukt of als er geen nieuwe poging wordt uitgevoerd, wordt een netwerkfout geretourneerd.
Elke aanvraag naar deze API die wordt verzonden terwijl een eerdere aanvraag in behandeling is, retourneert een fout met de melding dat de netwerksnelheidslimiet is overschreden totdat de eerdere aanvraag is voltooid of een fout heeft geretourneerd.

De elfde aanvraag naar deze API binnen een periode van één minuut retourneert een fout met de melding dat de netwerksnelheidslimiet is overschreden, net als elke volgende aanvraag na de elfde aanvraag, tot er één minuut is verstreken sinds de eerste aanvraag.

launchSignInUX(error) error: functie. Callback bij fout. indien mislukt: roept callback voor fout aan met codeset cq.mobile.userError

Als de verificatie verloopt via een machtigingsserver, wordt het systeemeigen dialoogvenster voor aanmelden weergegeven.

Als verificatie verloopt via een identiteitsprovider, wordt de verificatie-URL weergegeven in een webweergave op apparaatviewers of wordt de gebruiker omgeleid naar de verificatie-URL van de bureaubladwebviewer.

Als er in het project geen verificatie is opgegeven, wordt met het aanroepen van deze API een verificatieondersteuningsfout geretourneerd.

Als de gebruiker al is geverifieerd, wordt de fout Ongeldige verificatiestatus geretourneerd.

Als u met de webviewer geen verificatie-instellingen kunt ophalen, wordt een netwerkfout geretourneerd.

Gebruikers kunnen zich nog altijd afmelden bij apparaatviewers wanneer ze offline zijn.

signOut(error) error: functie. Callback bij fout. indien mislukt: roept callback voor fout aan met codeset cq.mobile.userError

Met deze optie wordt de gebruiker afgemeld en wordt de afmeldingsstatus vernieuwd en weergegeven in de gebruikersinterface.

Als er in het project geen verificatie is opgegeven, wordt met het aanroepen van deze API een verificatieondersteuningsfout geretourneerd.

Als de gebruiker al is geverifieerd, wordt de fout Ongeldige verificatiestatus geretourneerd.

Als de webviewer niet kan afmelden, wordt een netwerkfout geretourneerd.

Apparaatviewers gebruiken gecachte verificatie-instellingen als de verificatie-instellingen niet kunnen worden opgehaald.

refreshSignIn(success, error)

success: functie. Callback bij voltooiing.

error: functie. Callback bij fout.

indien gelukt: roept de callback voor succes aan zonder parameters

indien mislukt: roept callback voor fout aan met codeset cq.mobile.userError

Gebruik deze API om de aanmelding van de gebruiker alleen te vernieuwen wanneer u vaststelt dat de huidige sessie niet langer geldig is. Deze API vernieuwt de aanmelding alleen in de twee volgende scenario's:

1) Het project is ingesteld met een machtigingsservice maar zonder aangepaste verificatie. Als deze API wordt aangeroepen, resulteert dit in een aanroep voor renewAuthToken op de machtigingsservice.

2) Het project is ingesteld met een OAuth-identiteitsprovider die een vernieuwingstoken levert. Als deze API wordt aangeroepen, wordt geprobeerd om de vernieuwingstoken te gebruiken om de aanmeldingssessie te vernieuwen.

In beide scenario's kan het vernieuwen mislukken. Als dit gebeurt, wordt de gebruiker niet afgemeld.

In alle andere scenario's, waaronder het scenario waarin deze API wordt aangeroepen in een project dat is ingesteld met een SAML- of OAuth-identiteitsprovider die vernieuwen niet ondersteunt, mislukt deze vernieuwing en wordt de gebruiker afgemeld en weer naar de startpagina voor de gebruiker geleid.

Als er in het project geen verificatie is opgegeven, wordt met het aanroepen van deze API een verificatieondersteuningsfout geretourneerd.

Als de gebruiker niet is geverifieerd, wordt een fout met een ongeldige verificatiestatus geretourneerd.

Als de viewers offline zijn en het aanmelden niet kan worden vernieuwd, wordt een netwerkfout geretourneerd.

Apparaatviewers gebruiken gecachte verificatie-instellingen als de verificatie-instellingen niet kunnen worden opgehaald.

Opmerking:

De code “UNKNOWN_ERROR” wordt geretourneerd in de callback voor de fout wanneer er een onverwachte fout optreedt bij een van deze API-aanroepen.

 

Eigenschappen - Gebruikersfout

cq.mobile.userError is een opsommingsobject dat alle ondersteunde foutcodes voor gebruikersmethoden definieert.

Naam Waarde
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

Entitlement API's

Beschikbaarheid

Deze plug-in definieert een algemeen machtigingsobject dat methoden biedt met betrekking tot machtiging en aankoop. Deze is pas beschikbaar na de gebeurtenis deviceready.

Eigenschappen: Aanbieding

Naam Type Opmerkingen
productId Tekenreeks De product-/abonnements-id die wordt weergegeven in de sectie Producten en abonnementen van de portal.
label Tekenreeks De product-/abonnementsnaam die wordt weergegeven in de sectie Producten en abonnementen van de portal. Deze is null als de gebruiker deze niet instelt.
description Tekenreeks De beschrijving van het product/abonnement die wordt weergegeven in de sectie Producten en abonnementen van de portal. Deze is null als de gebruiker deze niet instelt.
price Tekenreeks De prijs die wordt geretourneerd door de desbetreffende winkel. Null als het product gratis is.
offerType Tekenreeks Kan "subscription" of "product" zijn.

Eigenschappen: Info over abonnement

Naam Type Opmerkingen
subscriptionOffers Matrix Een matrix van Offer-objecten. Als deze leeg is, heeft de gebruiker een actief abonnement.
subscriptionState Object Een subscriptionState-object.

Eigenschappen: Status van abonnement

Naam Type Opmerkingen
isSubscriber
Boolean Is Waar als de gebruiker op enig moment abonnee is geweest. Let op dat subscriptionState.isSubscriber identiek is aan subscriptionState.store.isSubscriber en subscriptionState.integrator.isSubscriber.
isActiveSubscriber
Boolean Is Waar als de gebruiker een actief abonnement heeft.
store Object Een Store-object dat de abonnementsstatus voor de productwinkel bevat.
integrator Object Een Integrator-object dat de abonnementsstatus voor de machtigingsintegrator bevat.

Eigenschappen: Winkel

Naam Type Opmerkingen
isSubscriber
Boolean Is Waar als de gebruiker op enig moment abonnee is geweest.
isActiveSubscriber
Boolean Is Waar als de gebruiker een actief abonnement heeft.
expirationDate Getal De tijdstempel in milliseconden sinds de verloopdatum. Deze waarde kan null zijn als het abonnement (via de winkel of machtigingsintegrator) geen verloopdatum heeft.
subscriptionType Tekenreeks Kan "allAccess" of "standard" zijn. Alleen geldig als isSubscriber Waar is.
id Tekenreeks Product-id van het abonnementsproduct in de winkel.

Eigenschappen: Integrator

Naam Type Opmerkingen
isSubscriber
Boolean Is Waar als de gebruiker op enig moment abonnee is geweest.
isActiveSubscriber
Boolean Is Waar als de gebruiker een actief abonnement heeft.
expirationDate Getal De tijdstempel in milliseconden sinds de verloopdatum. Deze waarde kan null zijn als het abonnement (via de winkel of machtigingsintegrator) geen verloopdatum heeft.
customData Tekenreeks customData wordt niet ingesteld als isSubscriber Onwaar is. Als isSubscriber Waar is, kan customData wel of niet zijn ingesteld. customData kan worden geretourneerde door de integrator. Dit is bedoeld voor gegevens die transparant zijn voor Adobe en alleen nuttig zijn voor de klant.

Methoden

Naam Argumenten Respons Opmerkingen
getSubscriptionInfo(success, error)

success: De callback bij voltooiing

error: De callback bij een fout

indien gelukt: Een SubscriptionInfo-object.

Deze methode retourneert de abonnementsgegevens voor de huidige publicatie en het huidige apparaat. Als binnen één minuut 60 API-aanvragen zijn gedaan, retourneert elke volgende aanvraag van deze API een fout totdat er één minuut is verstreken sinds de eerste aanvraag.

De bureaubladwebviewer ondersteunt deze API niet en retourneert altijd een fout.

getOffers(collectionName, success, error)

collectionName: Tekenreeks, de naam van de collectie

success: functie. Callback bij voltooiing.

error: functie. Callback bij fout.

indien gelukt: een matrix met Offer-objecten

indien mislukt: een fout met ingevulde code-eigenschap

collectionName moet overeenkomen met een naam in de portal.

Als de gevraagde entiteit niet kan worden gevonden of beperkt is en niet zichtbaar is, wordt een fout geretourneerd.

Aanbiedingen in de cache voor de gevraagde entiteit worden geretourneerd indien beschikbaar. Zo niet, dan vindt een netwerkaanvraag aan de machtigingsservice plaats om de aanbiedingen op te halen.

Als binnen één minuut 60 netwerkaanvragen aan de machtigingsservice zijn gedaan, resulteert elke volgende aanvraag van deze API in een fout totdat er één minuut is verstreken sinds de eerste aanvraag.

De bureaubladwebviewer ondersteunt deze API niet en retourneert altijd een fout.

purchaseOffer(productId, success, error)

productId: Tekenreeks, de product-id van de aanbieding die wordt gekocht

success: functie. Callback bij voltooiing.

error: functie. Callback bij fout.

indien gelukt: er wordt een aankoopaanvraag gestart

bij fout: Foutcode wordt aangeroepen

Deze methode start een aankoopaanvraag.
restorePurchases(successCallback, errorCallback)

success: functie. Callback bij voltooiing.

error: functie. Callback bij fout.

indien gelukt: een verzoek om het herstellen van een aankoop wordt gestart

bij fout: Foutcode wordt aangeroepen

Deze methode start het herstellen van vorige aankopen voor de gebruiker.

Als binnen één minuut 5 API-aanvragen zijn gedaan, retourneert elke volgende aanvraag van deze API een fout totdat er één minuut is verstreken sinds de eerste aanvraag.

Fouten: Machtigingen

cq.mobile.entitlementError is een opsommingsobject dat alle ondersteunde foutcodes voor machtigingsmethoden definieert.

Naam Waarde
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

Wijzigingenlogboek

16 maart 2017

API-informatie voor het downloaden van collectie-entiteiten toegevoegd.

API-informatie voor kopen en machtigingen toegevoegd.

10 januari 2017

cq.mobile.application.isAppSearchEnabled en cq.mobile.application.isSocialSharingEnabled toegevoegd (zie sectie Toepassing)

9 augustus 2016

getLocationContent toegevoegd (zie sectie Context)

30 juni 2016

setAuthToken toegevoegd (zie sectie Gebruiker)

23 juni 2016

Mogelijkheid toegevoegd om de collectiestructuur van de on-demandservices te verplaatsen:

  • De metagegevens van de entiteit worden bijgewerkt met ondersteuning voor banners (zie tabblad Context).
  • getEntity() is toegevoegd om een verzoek in te dienen voor de entiteit artikel/banner/collectie (zie tabblad Context).
  • getEntitlementInfo() toegevoegd om een verzoek in te dienen voor machtigingsgegevens voor de collectie (zie tabblad Context).
  • getChildren() toegevoegd om een verzoek in te dienen voor de lijst met directe onderliggende entiteiten voor de collectie (zie tabblad Context).
  • getNextPage() toegevoegd om een verzoek in te dienen voor de volgende pagina met entiteiten uit de lijst die is geretourneerd door getChildren() (zie tabblad Context).
  • Opsommingsobjecten toegevoegd om foutcodes te definiëren voor de methoden die worden gebruikt in cq.mobile.context en cq.mobile.user (zie tabblad Context en Gebruiker).

 

Dit werk is gelicentieerd onder de Creative Commons Naamsvermelding/Niet-commercieel/Gelijk delen 3.0 Unported-licentie  De voorwaarden van Creative Commons zijn niet van toepassing op Twitter™- en Facebook-berichten.

Juridische kennisgevingen   |   Online privacybeleid