Riferimento API dell'SDK per Android android-sdk-api-reference
Introduzione intro
Questo documento descrive i metodi e i callback esposti dall’SDK per Android per l’autenticazione di Adobe Pass, supportati con le versioni di autenticazione di Adobe Pass 1.7 e successive. I metodi e le funzioni di callback qui descritti sono definiti nei file di intestazione AccessEnabler.h e EntitlementDelegate.h.
Fare riferimento a https://tve.zendesk.com/hc/en-us/articles/204963219-Android-Native-AccessEnabler-Library per la versione più recente dell’SDK per Android AccessEnabler.
Nota: Il team di autenticazione di Adobe Pass ti incoraggia a utilizzare solo l’autenticazione di Adobe Pass pubblico API:
- Sono disponibili API pubbliche e completamente testato su tutti i tipi di client supportati. Per qualsiasi funzione pubblica, ci assicuriamo che ogni tipo di client abbia una versione corrispondente dei metodi associati.
- Le API pubbliche devono essere il più stabili possibile, per supportare la compatibilità con le versioni precedenti e garantire che le integrazioni dei partner non si interrompano. Tuttavia, per non-API pubbliche, ci riserviamo il diritto di cambiare la loro firma in qualsiasi momento futuro. Se incontri un flusso particolare che non può essere supportato tramite una combinazione delle chiamate API di autenticazione di Adobe Pass pubbliche correnti, l’approccio migliore è quello di farcelo sapere. Tenendo conto delle tue esigenze, possiamo modificare le API pubbliche e fornire una soluzione stabile.
API Android api
- getInstance
- setOptions
- setRequestor
- setRequestorComplete
- checkAuthentication
- getAuthentication
- displayProviderDialog
- setSelectedProvider
- navigateToUrl
- getAuthenticationToken
- setAuthenticationStatus
- preautorizza
- checkAuthorization
- getAuthorization
- setToken
- tokenRequestFailed
- logout
- getSelectedProvider
- selectedProvider
- getMetadata
- setMetadataStatus
- getVersion
Factory.getInstance getInstance
Descrizione: Crea istanze dell'oggetto Access Enabler. Deve essere presente una singola istanza di Access Enabler per ogni istanza dell'applicazione.
lanci AccessEnablerException
statico pubblico AccessEnabler getInstance(Context appContext, String env_url, String softwareStatement, String redirectUrl)
lanci AccessEnablerException
Disponibilità: v3.1.2+
Parametri:
- appContext: contesto dell’applicazione Android.
- env_url: per eseguire test utilizzando l’ambiente di staging Adobe, env_url può essere impostato su "sp.auth-staging.adobe.com"
Obsoleto:
public static AccessEnabler getInstance(Context appContext)
throws AccessEnablerException
setRequestor setRequestor
Descrizione: Stabilisce l'identità del programmatore. A ciascun programmatore viene assegnato un ID univoco al momento della registrazione all’Adobe per il sistema di autenticazione di Adobe Pass. Quando si tratta di token SSO e remoti, lo stato di autenticazione può cambiare quando l'applicazione è in background, setRequestor può essere richiamato nuovamente quando l'applicazione viene portata in primo piano per sincronizzarsi con lo stato del sistema (recuperare un token remoto se SSO è abilitato o eliminare il token locale se nel frattempo si è verificato un logout).
La risposta del server contiene un elenco di MVPD insieme ad alcune informazioni di configurazione collegate all'identità del programmatore. La risposta del server viene utilizzata internamente dal codice di Access Enabler. Solo lo stato dell’operazione (ovvero SUCCESS/FAIL) viene presentato all’applicazione tramite il callback setRequestorComplete().
Se il url non viene utilizzato, la chiamata di rete risultante esegue il targeting dell’URL predefinito del fornitore di servizi: l’ambiente Adobe Release/Production.
Se per il campo url , la chiamata di rete risultante esegue il targeting di tutti gli URL forniti nel url parametro. Tutte le richieste di configurazione vengono attivate contemporaneamente in thread separati. Il primo responder ha la precedenza quando si compila l’elenco degli MVPD. Per ogni MVPD nell'elenco, Access Enabler ricorda l'URL del provider di servizi associato. Tutte le richieste di adesione successive vengono indirizzate all’URL associato al provider di servizi che è stato associato all’MVPD di destinazione durante la fase di configurazione.
public void setRequestor(String requestorId)Disponibilità: v3.0+
public void setRequestor(String requestorId, ArrayList<String> urls)Parametri:
-
requestorID: ID univoco associato al programmatore. Trasmetti l’ID univoco assegnato da Adobe al sito quando ti sei registrato per la prima volta con il servizio di autenticazione di Adobe Pass.
-
signedRequestorID: copia dell’ID richiedente con firma digitale nella chiave privata. .
-
url: parametro facoltativo; per impostazione predefinita, viene utilizzato il provider di servizi Adobe (http://sp.auth.adobe.com/). Questo array consente di specificare gli endpoint per i servizi di autenticazione e autorizzazione forniti da Adobe (a scopo di debug possono essere utilizzate istanze diverse). È possibile utilizzare questa opzione per specificare più istanze del provider di servizi di autenticazione di Adobe Pass. In tal caso, l'elenco MVPD è composto dagli endpoint di tutti i fornitori di servizi. Ogni MVPD è associato al provider di servizi più veloce, ovvero il provider che ha risposto per primo e che supporta tale MVPD.
Callback attivati: setRequestorComplete()
Obsoleto:
void pubblico setRequestor(String requestorId, String signedRequestorId)
void pubblico setRequestor (String requestorId, String signedRequestorId, ArrayList)<string> url)
setRequestorComplete setRequestorComplete
Descrizione: Callback attivato dall'Access Enabler che informa l'applicazione del completamento della fase di configurazione. Questo è un segnale che l’app può iniziare a emettere richieste di adesione. L’applicazione non può inviare richieste di adesione fino al completamento della fase di configurazione.
Disponibilità: v1.0+
Parametri:
-
stato: può assumere uno dei seguenti valori:
-
SDK >= 3.4.0
AccessEnablerConstants.ACCESS_ENABLER_STATUS_SUCCESS- fase di configurazione completataAccessEnablerConstants.ACCESS_ENABLER_STATUS_ERROR- fase di configurazione non riuscita
-
SDK < 3,4
AccessEnabler.ACCESS_ENABLER_STATUS_SUCCESS- fase di configurazione completataAccessEnabler.ACCESS_ENABLER_STATUS_ERROR- fase di configurazione non riuscita
-
Attivato da: setRequestor()
setOptions setOptions
Descrizione: Configura le opzioni SDK globali. Accetta un Mappa<string string=""> come argomento. I valori della mappa verranno passati al server insieme a ogni chiamata di rete effettuata dall'SDK.
I valori vengono passati al server indipendentemente dal flusso corrente (autenticazione/autorizzazione). Se desideri modificare i valori, puoi chiamare questo metodo in qualsiasi momento.
Disponibilità: v1.9.2+
Parametri:
-
opzioni: una mappa<string string=""> contenente le opzioni SDK globali. Attualmente, sono disponibili le seguenti opzioni:
- applicationProfile : può essere utilizzato per creare configurazioni server basate su questo valore.
- ap_vi : ID Experience Cloud (visitorID). Questo valore può essere utilizzato in seguito per i rapporti di analisi avanzata.
- ap_ai - Advertising ID
- device_info - Informazioni per il cliente come qui descritto: Passaggio della connessione e dell'applicazione del dispositivo di informazioni client.
checkAuthentication checkAuthN
Descrizione: Controlla lo stato di autenticazione. A tale scopo, cerca un token di autenticazione valido nello spazio di archiviazione dei token locale. Questo metodo non esegue chiamate di rete e si consiglia di chiamarlo sul thread principale. Viene utilizzata dall’applicazione per eseguire una query sullo stato di autenticazione dell’utente e aggiornare di conseguenza l’interfaccia utente (ad esempio, aggiornare l’interfaccia utente di accesso/disconnessione). Lo stato di autenticazione viene comunicato all’applicazione tramite setAuthenticationStatus() callback.
Se un MVPD supporta la funzione "Autenticazione per richiedente", è possibile memorizzare su un dispositivo più token di autenticazione. Per informazioni dettagliate su questa funzione, vedi Linee guida per la memorizzazione in cache nella Panoramica tecnica Android.
Disponibilità: v1.0+
Parametri: Nessuno
Callback attivati: setAuthenticationStatus()
getAuthentication getAuthN
Descrizione: Avvia il flusso di lavoro di autenticazione completo. Viene avviato controllando lo stato di autenticazione. Se non è già autenticato, viene avviato il computer dello stato del flusso di autenticazione:
- Se l’ultimo tentativo di autenticazione ha avuto esito positivo, la fase di selezione MVPD viene saltata e il navigateToUrl() callback attivato. L'applicazione utilizza questo callback per creare un'istanza del controllo WebView che presenta all'utente la pagina di accesso di MVPD.
- Se l’ultimo tentativo di autenticazione non ha avuto esito positivo o se l’utente si è esplicitamente disconnesso, il displayProviderDialog() callback attivato. L'applicazione utilizza questo callback per visualizzare l'interfaccia utente di selezione MVPD. Inoltre, l’app deve riprendere il flusso di autenticazione informando la libreria di Access Enabler della selezione MVPD dell’utente tramite setSelectedProvider() metodo.
Poiché le credenziali dell'utente vengono verificate nella pagina di accesso MVPD, l'applicazione deve monitorare le operazioni di reindirizzamento multiple che si verificano mentre l'utente si autentica nella pagina di accesso di MVPD. Quando vengono immesse le credenziali corrette, il controllo WebView viene reindirizzato a un URL personalizzato definito da AccessEnabler.ADOBEPASS_REDIRECT_URL costante. Questo URL non deve essere caricato da WebView. L’applicazione deve intercettare questo URL e interpretare questo evento come un segnale del completamento della fase di accesso. Deve quindi passare il controllo all’Access Enabler per completare il flusso di autenticazione (chiamando il getAuthenticationToken() metodo).
Se un MVPD supporta la funzione "Autenticazione per richiedente", è possibile memorizzare su un dispositivo più token di autenticazione (uno per programmatore). Per informazioni dettagliate su questa funzione, vedi Linee guida per la memorizzazione in cache nella Panoramica tecnica Android.
Infine, lo stato di autenticazione viene comunicato all’applicazione tramite setAuthenticationStatus() callback.
Disponibilità: v1.0+
Disponibilità: v1.8+
Parametri:
- forceAuthn: flag che specifica se avviare il flusso di autenticazione, indipendentemente dal fatto che l’utente sia già autenticato o meno.
- dati: una mappa costituita da coppie chiave-valore da inviare al servizio di pass Pay-TV. Adobe può utilizzare questi dati per abilitare funzionalità future senza modificare l’SDK.
Callback attivati: setAuthenticationStatus(), displayProviderDialog(), navigateToUrl(), sendTrackingData()
displayProviderDialog displayProviderDialog
Descrizione Callback attivato da Access Enabler per informare l'applicazione che è necessario creare un'istanza degli elementi dell'interfaccia utente appropriati per consentire all'utente di selezionare l'MVPD desiderato. Il callback fornisce un elenco di oggetti MVPD con informazioni aggiuntive che possono aiutare a creare correttamente il pannello dell'interfaccia utente di selezione (come l'URL che punta al logo MVPD, il nome visualizzato intuitivo, ecc.)
Dopo che l’utente ha selezionato l’MVPD desiderato, l’applicazione di livello superiore deve riprendere il flusso di autenticazione chiamando setSelectedProvider() e trasmettendogli l’ID del MVPD corrispondente alla selezione dell’utente.
Tieni presente che è un punto in cui l’utente può premere il pulsante "Indietro", che equivale all’interruzione del flusso di autenticazione. In questo caso, l’applicazione deve chiamare
setSelectedProvider() metodo, passaggio nulle come parametro, per dare all’Access Enabler l’opportunità di reimpostare il computer dello stato di autenticazione.public void displayProviderDialog(ArrayList<Mvpd> mvpds)Disponibilità: v1.0+
Parametri:
- mvpds: elenco di oggetti MVPD contenenti informazioni relative a MVPD che l’applicazione può utilizzare per creare gli elementi dell’interfaccia utente di selezione MVPD.
Attivato da: getAuthentication(), getAuthorization()
setSelectedProvider setSelectedProvider
Descrizione: Questo metodo viene richiamato dall'applicazione per informare l'Access Enabler della selezione MVPD dell'utente. È possibile utilizzare questo metodo per selezionare o modificare il provider di servizi utilizzato per l'autenticazione.
Se l’MVPD selezionato è un MVPD TempPass, si autenticherà automaticamente con tale MVPD senza dover chiamare in seguito getAuthentication().
Tieni presente che questo non è possibile per il Passaggio temporaneo promozionale in cui vengono forniti parametri aggiuntivi sul metodo getAuthentication().
Quando si passa nulle come parametro, Access Enabler presuppone che l’utente abbia annullato il flusso di autenticazione (ovvero premuto il pulsante "Indietro") e risponde reimpostando lo stato-computer di autenticazione e chiamando setAuthenticationStatus() callback con AccessEnablerConstants.PROVIDER_NOT_SELECTED_ERROR codice di errore.
Disponibilità: v1.0+
Parametri: Nessuno
Callback attivati: setAuthenticationStatus(), sendTrackingData(), navigateToUrl()
navigateToUrl navigagteToUrl
Obsoleto: A partire da Android SDK 3.0, navigateToUrl viene utilizzato solo se la scheda personalizzata Chrome non è presente sul dispositivo
Descrizione: Callback attivato da Access Enabler, che informa l'applicazione che è necessario presentare all'utente la pagina di accesso MVPD per immettere le credenziali. Access Enabler trasmette come parametro l'URL della pagina di accesso MVPD. L'applicazione deve creare un'istanza di un controllo WebView e indirizzarlo a questo URL. Inoltre, l'applicazione deve monitorare gli URL caricati dal controllo WebView e intercettare l'operazione di reindirizzamento dell'URL personalizzato definito dal AccessEnabler.ADOBEPASS_REDIRECT_URL (deprecated) costante. In questo caso, l'applicazione deve chiudere o nascondere il controllo WebView e restituire il controllo alla libreria Access Enabler chiamando getAuthenticationToken() metodo. L’Access Enabler completa il flusso di autenticazione recuperando il token di autenticazione dal server back-end e archiviandolo localmente nell’archivio dei token.
Tieni presente che è un punto in cui l’utente può premere il pulsante "Indietro", che equivale all’interruzione del flusso di autenticazione. In questo caso, l’applicazione deve chiamare setSelectedProvider() metodo di passaggio nulle come parametro e dando la possibilità all’Access Enabler di reimpostare il proprio computer dello stato di autenticazione.
Disponibilità: v1.0+
Parametri:
- url: URL che punta alla pagina di accesso di MVPD
Attivato da: getAuthentication(), setSelectedProvider()
getAuthenticationToken getAuthNToken
Obsoleto: A partire da Android SDK 3.0, poiché per l’autenticazione viene utilizzata la scheda personalizzata Chrome, questo metodo non viene più utilizzato dall’applicazione.
Descrizione: Completa il flusso di autenticazione richiedendo il token di autenticazione dal server back-end. Questo metodo deve essere chiamato dall'applicazione solo in risposta all'evento in cui il controllo WebView che ospita la pagina di accesso MVPD viene reindirizzato all'URL personalizzato definito da AccessEnabler.ADOBEPASS_REDIRECT_URL costante.
Disponibilità: v1.0+
Parametri:
- cookie: cookie impostati sul dominio di destinazione (consulta l’applicazione demo nell’SDK per un’implementazione di riferimento).
Callback attivati: setAuthenticationStatus(), sendTrackingData()
setAuthenticationStatus setAuthNStatus
Descrizione: Callback attivato dall'Access Enabler che informa l'applicazione dello stato del flusso di autenticazione. In molti casi questo flusso può non riuscire, a causa dell’interazione dell’utente o di altri scenari imprevisti (ad esempio, problemi di connettività di rete, ecc.). Questo callback informa l’applicazione dello stato di esito positivo/negativo del flusso di autenticazione, fornendo al contempo informazioni aggiuntive sul motivo dell’errore, quando necessario.
Disponibilità: v1.0+
Parametri:
-
stato: può assumere uno dei seguenti valori:
AccessEnablerConstants.ACCESS_ENABLER_STATUS_SUCCESS- flusso di autenticazione completatoAccessEnablerConstants.ACCESS_ENABLER_STATUS_ERROR- flusso di autenticazione non riuscito
-
codice: motivo dell’errore. Se stato è
AccessEnablerConstants.ACCESS_ENABLER_STATUS_SUCCESS, quindi codice è una stringa vuota (definita daAccessEnablerConstants.USER_AUTHENTICATEDcostante). In caso di errore, questo parametro può assumere uno dei seguenti valori:AccessEnablerConstants.USER_NOT_AUTHENTICATED_ERROR: utente non autenticato. In risposta al checkAuthentication() chiamata al metodo quando non è presente alcun token di autenticazione valido nella cache dei token locale.AccessEnablerConstants.PROVIDER_NOT_SELECTED_ERROR- AccessEnabler ha reimpostato il computer dello stato di autenticazione dopo il passaggio dell'applicazione di livello superiore nulle asetSelectedProvider()per interrompere il flusso di autenticazione. Presumibilmente l’utente ha annullato il flusso di autenticazione (ovvero ha premuto il pulsante "Indietro").AccessEnablerConstants.GENERIC_AUTHENTICATION_ERROR- Flusso di autenticazione non riuscito per motivi quali la non disponibilità della rete o l'annullamento esplicito del flusso di autenticazione da parte dell'utente.
Attivato da: checkAuthentication(), getAuthentication(), checkAuthorization()
checkPreauthorizedResources checkPreauth
Obsoleto: A partire da Android SDK 3.6, l'API di preautorizzazione sostituisce checkPreauthorizedResources, fornendo codici di errore estesi.
Descrizione: Questo metodo viene utilizzato dall’applicazione per determinare se l’utente è già autorizzato a visualizzare risorse protette specifiche. Lo scopo principale di questo metodo è quello di recuperare informazioni da utilizzare per decorare l’interfaccia utente (ad esempio, per indicare lo stato di accesso con le icone di blocco e sblocco).
public void checkPreauthorizedResources(ArrayList<String> resources)Disponibilità: v1.3+
Parametri: Il resources Il parametro è un array di risorse per cui deve essere controllata l'autorizzazione. Ogni elemento dell’elenco deve essere una stringa che rappresenta l’ID della risorsa. L’ID risorsa è soggetto alle stesse limitazioni dell’ID risorsa in getAuthorization() deve essere un valore concordato tra il programmatore e l’MVPD o un frammento RSS del contenuto multimediale.
Callback attivato: preauthorizedResources()
checkPreauthorizedResources checkPreauth2
Obsoleto: A partire da Android SDK 3.6, l'API di preautorizzazione sostituisce checkPreauthorizedResources, fornendo codici di errore estesi.
Descrizione: Questo metodo viene utilizzato dall’applicazione per determinare se l’utente è già autorizzato a visualizzare risorse protette specifiche. Lo scopo principale di questo metodo è quello di recuperare informazioni da utilizzare per decorare l’interfaccia utente (ad esempio, per indicare lo stato di accesso con le icone di blocco e sblocco).
public void checkPreauthorizedResources(ArrayList<String> resources, boolean cache)Disponibilità: v3.1+
Parametri: Il resources Il parametro è un array di risorse per cui deve essere controllata l'autorizzazione. Ogni elemento dell’elenco deve essere una stringa che rappresenta l’ID della risorsa. L’ID risorsa è soggetto alle stesse limitazioni dell’ID risorsa in getAuthorization() deve essere un valore concordato tra il programmatore e l’MVPD o un frammento RSS del contenuto multimediale.
Il cache parametro specifica se è possibile utilizzare o meno la risposta di preautorizzazione memorizzata nella cache. Per impostazione predefinita, la cache è true, l'SDK restituirà una risposta precedentemente memorizzata nella cache, se disponibile.
Callback attivato: preauthorizedResources()
risorse preautorizzate preauthResources
Obsoleto: A partire da Android SDK 3.6, l'API di preautorizzazione sostituisce checkPreauthorizedResources, fornendo codici di errore estesi. Il callback preauthorizedResources non verrà chiamato sulla nuova API.
Descrizione: Callback attivato da checkPreauthorizedResources(). Fornisce un elenco delle risorse che l’utente è già autorizzato a visualizzare.
public void checkPreauthorizedResources(ArrayList<String> resources)Disponibilità: v1.3+
Parametri: Il resources Il parametro è un array di risorse per le quali l’utente è già autorizzato a visualizzare.
Attivato da: checkPreauthorizedResources()
checkAuthorization
Descrizione: Questo metodo viene utilizzato dall'applicazione per controllare lo stato di autorizzazione. Viene innanzitutto verificato lo stato di autenticazione. Se non autenticato, il setTokenRequestFailed() viene attivato il callback e il metodo viene chiuso. Se l’utente è autenticato, attiva anche il flusso di autorizzazione. Vedi i dettagli su getAuthorization() metodo.
Disponibilità: v1.0+
Disponibilità: v1.8+
Parametri:
- resourceId: ID della risorsa per la quale l’utente richiede l’autorizzazione.
- dati: una mappa costituita da coppie chiave-valore da inviare al servizio di pass Pay-TV. Adobe può utilizzare questi dati per abilitare funzionalità future senza modificare l’SDK.
Callback attivati: tokenRequestFailed(), setToken(),sendTrackingData(), setAuthenticationStatus()
getAuthorization
Descrizione: Questo metodo viene utilizzato dall'applicazione per avviare il flusso di autorizzazione. Se l’utente non è già autenticato, avvia anche il flusso di autenticazione. Se l’utente viene autenticato, Access Enabler procede con il rilascio di richieste per il token di autorizzazione (se non è presente alcun token di autorizzazione valido nella cache dei token locale) e per il token multimediale di breve durata. Una volta ottenuto il token multimediale breve, il flusso di autorizzazione viene considerato completo. Il setToken() il callback viene attivato e il token multimediale breve viene distribuito come parametro all’applicazione. Se, per qualsiasi motivo, l'autorizzazione non riesce, il tokenRequestFailed() viene attivato il callback e vengono forniti il codice di errore e i dettagli.
Disponibilità: v1.0+
Disponibilità: v1.8+
Parametri:
- resourceId: ID della risorsa per la quale l’utente richiede l’autorizzazione.
- dati: una mappa costituita da coppie chiave-valore da inviare al servizio di pass Pay-TV. Adobe può utilizzare questi dati per abilitare funzionalità future senza modificare l’SDK.
Callback attivati: tokenRequestFailed(), setToken(), sendTrackingData()
Questo metodo può anche attivare i seguenti callback (se viene avviato anche il flusso di autenticazione): setAuthenticationStatus(), displayProviderDialog(), navigateToUrl()
NOTA: se possibile, utilizza checkAuthorization() invece di getAuthorization(). Il metodo getAuthorization() avvierà un flusso di autenticazione completo (se l’utente non è autenticato) e ciò potrebbe comportare una complicata implementazione da parte del programmatore.
setToken setToken
Descrizione: Callback attivato da Access Enabler che informa l'applicazione che il flusso di autorizzazione è stato completato correttamente. Anche il token multimediale di breve durata viene distribuito come parametro.
Disponibilità: v1.0+
Parametri:
- token: token multimediale di breve durata
- resourceId: risorsa per la quale è stata ottenuta l’autorizzazione
Attivato da: checkAuthorization(), getAuthorization()
tokenRequestFailed tokenRequestFailed
Descrizione: Callback attivato da Access Enabler che informa l'applicazione di livello superiore che il flusso di autorizzazione non è riuscito.
String errorCode, String errorDescription)
Disponibilità: v1.0+
Parametri:
-
resourceId: risorsa per la quale è stata ottenuta l’autorizzazione
-
errorCode: codice di errore associato allo scenario di errore. Valori possibili:
AccessEnablerConstants.USER_NOT_AUTHORIZED_ERROR- L'utente non è stato in grado di autorizzare per la risorsa specificata
-
errorDescription: ulteriori dettagli sullo scenario di errore. Se questa stringa descrittiva non è disponibile per alcun motivo, Adobe Pass Authentication invia una stringa vuota ("").
Questa stringa può essere utilizzata da un MVPD per trasmettere messaggi di errore personalizzati o messaggi relativi alle vendite. Ad esempio, se a un abbonato viene negata l’autorizzazione per una risorsa, l’MVPD potrebbe inviare un messaggio del tipo: "Attualmente non hai accesso a questo canale nel pacchetto. Se desideri aggiornare il pacchetto, fai clic qui." Il messaggio viene passato dall’autenticazione di Adobe Pass tramite questo callback al programmatore, che ha la possibilità di visualizzarlo o ignorarlo. L’autenticazione di Adobe Pass può inoltre utilizzare questo parametro per fornire una notifica della condizione che potrebbe aver causato un errore. Ad esempio, "Si è verificato un errore di rete durante la comunicazione con il servizio di autorizzazione del provider".
Attivato da: checkAuthorization(), getAuthorization()
logout logout
Descrizione: Utilizzare questo metodo per avviare il flusso di logout. La disconnessione è il risultato di una serie di operazioni di reindirizzamento HTTP dovute al fatto che l’utente deve essere disconnesso sia dai server di autenticazione di Adobe Pass che dai server MVPD. Di conseguenza, questo flusso non può essere completato con una semplice richiesta HTTP emessa dalla libreria di Access Enabler. L’SDK utilizza schede personalizzate di Chrome per eseguire le operazioni di reindirizzamento HTTP. Questo flusso sarà visibile all’utente e al termine verrà chiuso
Disponibilità: v1.0+
Parametri: Nessuno
Callback attivati:
navigateToUrl()per la versione SDK precedente alla 3.0setAuthenticationStatus()per la versione SDK > 3.0
getSelectedProvider getSelectedProvider
Descrizione: Utilizzare questo metodo per determinare il provider attualmente selezionato.
Disponibilità: v1.0+
Parametri: Nessuno
Callback attivati: selectedProvider()
selectedProvider
Descrizione: Callback attivato dall'Access Enabler che fornisce all'applicazione informazioni sull'MVPD attualmente selezionato.
Disponibilità: v1.0+
Parametri:
- mvpd: oggetto contenente informazioni sull’MVPD attualmente selezionato
Attivato da: getSelectedProvider()
getMetadata getMetadata
Descrizione: Utilizzare questo metodo per recuperare informazioni esposte come metadati dalla libreria di Access Enabler. L'applicazione può accedere a queste informazioni fornendo un oggetto MetadataKey composito.
public void getMetadata(MetadataKey metadataKey)Disponibilità: v1.0+
Esistono due tipi di metadati disponibili per i programmatori:
- Metadati statici (TTL del token di autenticazione, TTL del token di autorizzazione e ID dispositivo)
- Metadati utente (informazioni specifiche dell’utente, come ID utente e codice postale; trasmessi da un MVPD al dispositivo di un utente durante i flussi di autenticazione e/o autorizzazione)
Parametri:
-
metadataKey: struttura di dati che incapsula una variabile chiave e args, con il seguente significato:
-
Se la chiave è
METADATA_KEY_USER_METAe contiene un oggetto SerializableNameValuePair con nome =METADATA_ARG_USER_METAe valore =[metadata_name], quindi viene eseguita la query per i metadati dell’utente. L’elenco corrente dei tipi di metadati utente disponibili:-
zip- CAP -
householdID- Identificatore della famiglia. Se un MVPD non supporta i conti secondari, questo sarà identico auserID. -
maxRating- Classificazione genitoriale massima per l'utente -
userID: identificatore utente. Se un MVPD supporta gli account secondari e l'utente non è l'account principale,userIDsarà diverso dahouseholdID. -
channelID- Un elenco di canali che l’utente ha il diritto di visualizzare
-
-
Se la chiave è
METADATA_KEY_DEVICE_IDquindi viene eseguita la query per ottenere l’id dispositivo corrente. Tieni presente che questa funzione è disabilitata per impostazione predefinita e i programmatori devono contattare l’Adobe per informazioni sull’abilitazione e sulle tariffe. -
Se la chiave è
METADATA_KEY_TTL_AUTHZe contiene un oggetto SerializableNameValuePair con nome =METADATA_ARG_RESOURCE_IDe valore =[resource_id], quindi viene eseguita la query per ottenere la scadenza del token di autorizzazione associato alla risorsa specificata. -
Se la chiave è
METADATA_KEY_TTL_AUTHNviene quindi eseguita la query per ottenere la data di scadenza del token di autenticazione.
-
METADATA_KEY_USER_META, METADATA_KEY_DEVICE_ID, METADATA_KEY_TTL_AUTHZ, METADATA_KEY_TTL_AUTHN sono disponibili su com.adobe.adobepass.accessenabler.api.profile.UserProfileService.Callback attivati: setMetadataStatus()
Ulteriori informazioni: Metadati utente
setMetadataStatus setMetadaStatus
Descrizione: Callback attivato dall'Access Enabler che distribuisce i metadati richiesti tramite un getMetadata() chiamare.
public void setMetadataStatus(MetadataKey key, MetadataStatus result)Disponibilità: v1.0+
Parametri:
-
chiave: oggetto MetadataKey contenente la chiave per la quale viene richiesto il valore dei metadati e i parametri associati (consulta applicazione demo per un’implementazione di riferimento).
-
risultato: oggetto composito contenente i metadati richiesti. L’oggetto dispone dei seguenti campi:
-
simpleResult: elemento String che rappresenta il valore dei metadati quando è stata effettuata la richiesta per il valore TTL di autenticazione, TTL di autorizzazione o ID dispositivo. Questo valore è nullo se la richiesta è stata effettuata per i metadati utente.
-
userMetadataResult: un oggetto che contiene la rappresentazione Java di un payload di metadati utente JSON.
Ad esempio:
-
'{
"street": "Main Avenue",
"buildings": ["150", "320"]
}'
è tradotto in Java come:
Map("street" -> "Main Avenue", "buildings" -> List("150", "320")))
La struttura effettiva degli oggetti metadati utente è simile alla seguente:
{
updated: 1334243471,
encrypted: ["encryptedProp"],
data: {
zip: ["12345", "34567"],
maxRating: {
"MPAA": "PG-13",
"VCHIP": "TV-Y",
"URL": "http://exam.pl/e/manage/ratings"
},
householdID: "3456",
userID: "BgSdasfsdk23/dsaf3+saASesadgfsShggssd=",
channelID: ["channel-1", "channel-2"]
}
}
Questo valore è nullo quando la richiesta è stata effettuata per metadati semplici (TTL di autenticazione, TTL di autorizzazione o ID dispositivo).
- crittografato: valore booleano che specifica se i metadati recuperati sono crittografati o meno. Questo parametro è significativo solo per le richieste di metadati utente, non ha significato per i metadati statici (ad esempio, TTL di autenticazione) che vengono sempre ricevuti non crittografati. Se questo parametro è impostato su True, spetta al programmatore ottenere il valore dei metadati utente non crittografati eseguendo una decrittografia RSA utilizzando la chiave privata dell'inserimento nella whitelist (la stessa chiave privata utilizzata per la firma dell'ID richiedente nella
setRequestorchiamata).
Attivato da: getMetadata()
Ulteriori informazioni: Metadati utente
getVersion getVersion
Descrizione: Questo metodo può essere utilizzato per recuperare la versione della libreria AccessEnabler.
public static String getVersion()Tracciamento degli eventi tracking
L’Access Enabler attiva un callback aggiuntivo che non è necessariamente correlato ai flussi di adesione. Implementazione della funzione di callback di tracciamento degli eventi denominata sendTrackingData() è facoltativo, ma consente all’applicazione di tenere traccia di eventi specifici e di compilare statistiche quali il numero di tentativi di autenticazione/autorizzazione riusciti/non riusciti. Di seguito è riportata la specifica per sendTrackingData() callback:
sendTrackingData sendTrackingData
Descrizione: Callback attivato dall'Access Enabler che segnala all'applicazione il verificarsi di vari eventi come il completamento/il fallimento dei flussi di autenticazione/autorizzazione. Il tipo di dispositivo, il tipo di client Access Enabler e il sistema operativo vengono inoltre segnalati da sendTrackingData().
-
Valori possibili per il tipo di dispositivo:
computertabletmobilegameconsoleunknown
-
Valori possibili per il tipo di client Access Enabler:
flashhtml5iosandroid
public void sendTrackingData(Event event, ArrayList<String> data)Disponibilità: v1.0+
Parametri:
-
evento: l’evento di cui viene tenuto traccia. Esistono tre possibili tipi di eventi di tracciamento:
- authorizationDetection: ogni volta che viene restituita una richiesta di token di autorizzazione (il tipo di evento è
EVENT_AUTHZ_DETECTION) - authenticationDetection: ogni volta che si verifica un controllo di autenticazione (il tipo di evento è
EVENT_AUTHN_DETECTION) - mvpdSelection: quando l’utente seleziona un MVPD nel modulo di selezione MVPD (il tipo di evento è
EVENT_MVPD_SELECTION)
- authorizationDetection: ogni volta che viene restituita una richiesta di token di autorizzazione (il tipo di evento è
-
dati: dati aggiuntivi associati all’evento segnalato. Questi dati vengono presentati sotto forma di elenco di valori.
Di seguito sono riportate le istruzioni per l’interpretazione dei valori in dati
array:
-
Per tipo di evento
EVENT_AUTHN_DETECTION:- 0 - Indica se la richiesta del token è riuscita (true/false) e se quanto sopra è vero:
- 1 - Stringa ID MVPD
- 2 - GUID (hash MD5)
- 3 - Token già nella cache (true/false)
- 4 - Tipo di dispositivo
- 5 - Tipo di client Access Enabler
- 6 - Tipo di sistema operativo
-
Per tipo di evento
EVENT_AUTHZ_DETECTION- 0 - Se la richiesta del token è stata eseguita correttamente (true/false) e in caso di esito positivo:
- 1 - ID MVPD
- 2 - GUID (hash MD5)
- 3 - Token già nella cache (true/false)
- 4 - Errore
- 5 - Dettagli
- 6 - Tipo di dispositivo
- 7 - Tipo di client Access Enabler
- 8 - Tipo di sistema operativo
-
Per tipo di evento
EVENT_MVPD_SELECTION- 0 - ID del MVPD attualmente selezionato
- 1 - Tipo di dispositivo
- 2 - Tipo di client Access Enabler
- 3 - Tipo di sistema operativo
Attivato da: checkAuthentication(), getAuthentication(), checkAuthorization(), getAuthorization(), setSelectedProvider()