Riferimento API per iOS/tvOS SDK iostvos-sdk-api-reference

Introduzione intro

Questa pagina descrive i metodi e le funzioni di callback esposti dal client nativo iOS/tvOS per l’autenticazione di Adobe Pass. I metodi e le funzioni di callback qui descritti sono definiti nei file di intestazione AccessEnabler.h e EntitlementDelegate.h. Sono disponibili nell'SDK di iOS AccessEnabler qui: [SDK directory]/AccessEnabler/headers/api/

Documentazione associata:

Riferimento API apis

init:softwareStatement initWithSoftwareStatement

File: AccessEnabler/headers/AccessEnabler.h

Descrizione: crea istanze dell'oggetto AccessEnabler. Deve essere presente una singola istanza di AccessEnabler per ogni istanza dell'applicazione.

Disponibilità: v3.0+

Parametri:

Torna all'inizio…

init - [OBSOLETO] init

File: AccessEnabler/headers/AccessEnabler.h

Descrizione: crea istanze dell'oggetto AccessEnabler. Deve essere presente una singola istanza di AccessEnabler per ogni istanza dell'applicazione.

Disponibilità: v1.0+ Fino a: v3.0

Parametri: Nessuno

Torna all'inizio…

setOptions:opzioni setOptions

File: AccessEnabler/headers/AccessEnabler.h

Descrizione: configura le opzioni SDK globali. Accetta un NSDictionary come argomento. I valori del dizionario vengono passati al server insieme a ogni chiamata di rete effettuata dall'SDK.

Nota: i valori verranno passati al server indipendentemente dal flusso corrente (autenticazione/autorizzazione). Se desideri modificare i valori, puoi chiamare questo metodo in qualsiasi momento.

Disponibilità: v2.3.0+

Parametri:

Torna all'inizio…

setRequestor:requestorID, setRequestor:requestorID:serviceProviders: setReqV3

File: AccessEnabler/headers/AccessEnabler.h

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 AccessEnabler. Solo lo stato dell'operazione (ovvero OPERAZIONE RIUSCITA/NON RIUSCITA) viene presentato all'applicazione tramite il callback setRequestorComplete:.

Se il parametro urls non viene utilizzato, la chiamata di rete risultante esegue il targeting dell'URL predefinito del provider di servizi: l'ambiente Adobe RELEASE/production.

Se viene fornito un valore per il parametro urls, la chiamata di rete risultante eseguirà il targeting di tutti gli URL forniti nel parametro urls. 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, AccessEnabler 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.

Disponibilità: v3.0+

Disponibilità: v3.0+

Parametri:

Callback attivati: setRequestorComplete:

Torna all'inizio…

setRequestor:setSignedRequestorId:, setRequestor:setSignedRequestorId:serviceProviders: - [OBSOLETO] setReq

File: AccessEnabler/headers/AccessEnabler.h

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 AccessEnabler. Solo lo stato dell'operazione (ovvero OPERAZIONE RIUSCITA/NON RIUSCITA) viene presentato all'applicazione tramite il callback setRequestorComplete:.

Se il parametro urls non viene utilizzato, la chiamata di rete risultante esegue il targeting dell'URL predefinito del provider di servizi: l'ambiente Adobe RELEASE/production.

Se viene fornito un valore per il parametro urls, la chiamata di rete risultante eseguirà il targeting di tutti gli URL forniti nel parametro urls. 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, AccessEnabler 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.

Disponibilità: v1.0+ Fino a: v3.0

Disponibilità: v1.0+ Fino a: v3.0

Parametri:

Note: Se chiamata senza il parametro serviceProviders, la libreria recupererà la configurazione dal provider di servizi predefinito, ovvero https://sp.auth.adobe.com per il profilo di produzione o https://sp.auth-staging.adobe.com per il profilo di gestione temporanea. Se viene fornito il parametro serviceProviders, deve essere una matrice di URL. Le informazioni di configurazione vengono recuperate da tutti gli endpoint specificati e unite. Se esistono informazioni duplicate in risposte diverse del provider di servizi, il conflitto viene risolto a favore del server con la risposta più rapida (ovvero, il server con il tempo di risposta più breve ha la precedenza).

Callback attivati: setRequestorComplete:

Torna all'inizio…

setRequestor:setSignedRequestorId:secret:publicKey, setRequestor:setSignedRequestorId:serviceProviders:secret:publicKey - [OBSOLETO] setReq_tvos

File: AccessEnabler/headers/AccessEnabler.h

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. Questa impostazione deve essere eseguita una sola volta durante il ciclo di vita dell'applicazione.

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 AccessEnabler. Solo lo stato dell'operazione (ovvero OPERAZIONE RIUSCITA/NON RIUSCITA) viene presentato all'applicazione tramite il callback setRequestorComplete:.

Se il parametro urls non viene utilizzato, la chiamata di rete risultante esegue il targeting dell'URL predefinito del provider di servizi: l'ambiente Adobe RELEASE/production.

Se viene fornito un valore per il parametro urls, la chiamata di rete risultante eseguirà il targeting di tutti gli URL forniti nel parametro urls. 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, AccessEnabler 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.

- (void) setRequestor:(NSString *)requestorID
    signedRequestorID:(NSString *)signedRequestorID
               secret:(NSString *)secret
            publicKey:(NSString *)publicKey;

Disponibilità: v2.0+ Fino a: v3.0

- (void) setRequestor:(NSString *)requestorID
    signedRequestorID:(NSString *)signedRequestorID
     serviceProviders:(NSArray *)urls

Disponibilità: v2.0+ Fino a: v3.0

Parametri:

Se chiamata senza il parametro serviceProviders, la libreria recupererà la configurazione dal provider di servizi predefinito (ovvero https://sp.auth.adobe.com per il profilo di produzione o https://sp.auth-staging.adobe.com per il profilo di staging). Se viene fornito il parametro serviceProviders, deve essere una matrice di URL. Le informazioni di configurazione vengono recuperate da tutti gli endpoint specificati e unite. Se esistono informazioni duplicate in risposte diverse del provider di servizi, il conflitto viene risolto a favore del server con la risposta più rapida (ovvero, il server con il tempo di risposta più breve ha la precedenza).

Callback attivati: setRequestorComplete:

Torna all'inizio…

setRequestorComplete: setReqComplete

File: AccessEnabler/headers/EntitlementDelegate.h

Descrizione callback attivato da AccessEnabler 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.

- (void) setRequestorComplete:(int)status;

Disponibilità: v1.0+

Parametri:

Attivato da:

setRequestor:setSignedRequestorId:, setRequestor:setSignedRequestorId:serviceProviders:

Torna all'inizio…

checkAuthentication checkAuthN

File: AccessEnabler/headers/AccessEnabler.h

Descrizione: verifica lo stato di autenticazione dell'utente corrente.
A tale scopo, cerca un token di autenticazione valido nella directory locale
spazio di archiviazione dei token. Questo metodo non esegue chiamate di rete e si consiglia di chiamarlo sul thread principale.
Viene utilizzato dall’applicazione per eseguire una query sullo stato di autenticazione dell’utente e
aggiorna di conseguenza l’interfaccia utente (ad esempio, aggiorna l’interfaccia utente di accesso/disconnessione). Il
lo stato di autenticazione viene comunicato all’applicazione tramite
il callback setAuthenticationStatus:errorCode:.

- (void) checkAuthentication;

Disponibilità: v1.0+

Parametri: Nessuno

Callback attivati:
setAuthenticationStatus:errorCode:

Torna all'inizio…

getAuthentication, getAuthentication:withData: getAuthN

File: AccessEnabler/headers/AccessEnabler.h

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:

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 dalla costante ADOBEPASS_REDIRECT_URL. 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 ad AccessEnabler per completare il flusso di autenticazione chiamando il metodo handleExternalURL.

Infine, lo stato di autenticazione viene comunicato all'applicazione tramite il callback setAuthenticationStatus:errorCode:.

- (void) getAuthentication;

Disponibilità: v1.0+

- (void) getAuthentication:(BOOL)forceAuthn:
                  withData:(NSDictionary* )data;

Disponibilità: v1.9+

Parametri:

Callback attivati: setAuthenticationStatus:errorCode:, displayProviderDialog:, sendTrackingData:forEventType:

Torna all'inizio…

getAuthentication:filter, getAuthentication:withData:andFilter getAuthN_filter

File: AccessEnabler/headers/AccessEnabler.h

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:

Infine, lo stato di autenticazione viene comunicato all'applicazione tramite il callback setAuthenticationStatus:errorCode:.

Disponibilità: v2.4+

- (void) getAuthentication:(NSDictionary *)filter;

- (void) getAuthentication:(BOOL)forceAuthn:
                  withData:(NSDictionary* )data
                 andFilter:(NSDictionary *)filter;

Parametri:

Disponibilità: v2.0 - v2.3.1

- (void) getAuthentication:(NSArray *)filter;

- (void) getAuthentication:(BOOL)forceAuthn:
                  withData:(NSDictionary* )data
                 andFilter:(NSArray *)filter;

Parametri:

Callback attivati: setAuthenticationStatus:errorCode:, presentTvProviderDialog, dismissTvProviderDialog

Torna all'inizio…

displayProviderDialog: dispProvDialog

File: AccessEnabler/headers/EntitlementDelegate.h

Descrizione Il callback è stato attivato da AccessEnabler per informare l'applicazione che è necessario creare un'istanza degli elementi dell'interfaccia utente appropriati per consentire all'utente di selezionare il 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 dell'MVPD corrispondente alla selezione dell'utente.

Interruzione del flusso di autenticazione - Questo è un punto in cui l'utente può premere il pulsante "Indietro", che equivale all'interruzione del flusso di autenticazione. In questo scenario, è necessario che l'applicazione chiami il metodo setSelectedProvider:, passando null come parametro, per consentire ad AccessEnabler di reimpostare il computer dello stato di autenticazione.

- (void) displayProviderDialog:(NSArray *)mvpds;

Disponibilità: v1.0+

Parametri:

Attivato da: getAuthentication, getAuthentication:withData:,getAuthorization:, getAuthorization:withData:

Torna all'inizio…

setSelectedProvider: setSelProv

File: AccessEnabler/headers/AccessEnabler.h

Descrizione: questo metodo viene chiamato dall'applicazione per informare 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 null come parametro, Access Enabler presume che l'utente abbia annullato il flusso di autenticazione (ovvero ha premuto il pulsante "Indietro") e risponde reimpostando lo stato-computer di autenticazione e richiamando il callback setAuthenticationStatus:errorCode: con il codice di errore AccessEnabler.PROVIDER_NOT_SELECTED_ERROR.

- (void) setSelectedProvider:(NSString *)mvpdId;

Disponibilità: v1.0+

Parametri: Nessuno

Callback attivati: setAuthenticationStatus:errorCode:,sendTrackingData:forEventType:, navigateToUrl:

Torna all'inizio…

navigateToUrl: nav2url

File: AccessEnabler/headers/EntitlementDelegate.h

Descrizione: callback attivato da AccessEnabler per richiedere all'applicazione di creare un'istanza di un controller UIWebView/WKWebView e di caricare l'URL fornito nel parametro url del callback. Il callback passa il parametro url che rappresenta l'URL dell'endpoint di autenticazione o l'URL dell'endpoint di disconnessione.

Poiché il controller UIWebView/WKWebView viene sottoposto a diversi reindirizzamenti, l'applicazione deve monitorare l'attività del controller e rilevare il momento in cui carica un URL personalizzato specifico definito dalla costante ADOBEPASS_REDIRECT_URL (ovvero adobepass://ios.app). Questo URL personalizzato specifico non è valido e non è destinato al controller per caricarlo effettivamente. Deve essere interpretato solo dall'applicazione come un segnale che il flusso di autenticazione o disconnessione è stato completato e che è sicuro chiudere il controller. Quando il controller carica questo URL personalizzato specifico, l'applicazione deve chiudere UIWebView/WKWebView e chiamare il metodo API handleExternalURL:url di AccessEnabler.

Nota: Tieni presente che nel caso del flusso di autenticazione si tratta di un punto in cui l'utente può premere il pulsante "Indietro", che equivale all'interruzione del flusso di autenticazione. In questo caso, è necessario che l'applicazione chiami il metodo setSelectedProvider: passando nil come parametro e dando la possibilità ad AccessEnabler di reimpostare il computer dello stato di autenticazione.

- (void) navigateToUrl:(NSString *)url;

Disponibilità: v1.0+

Parametri:

Attivato da: setSelectedProvider:

Torna all'inizio…

navigateToUrl:useSVC: nav2urlSVC

File: AccessEnabler/headers/EntitlementDelegate.h

Descrizione: callback attivato da AccessEnabler anziché dal callback navigateToUrl: nel caso in cui l'applicazione abbia precedentemente abilitato la gestione manuale di Safari View Controller (SVC) tramite la chiamata setOptions(["handleSVC":true"]) e solo nel caso di MVPD che richiedono Safari View Controller (SVC). Per tutti gli altri MVPD verrà chiamato il callback navigateToUrl:. Per informazioni dettagliate sulla gestione di Safari View Controller (SVC), vedere il supporto di SFSafariViewController nell'SDK iOS 3.2+.

Simile al callback navigateToUrl:, il navigateToUrl:useSVC: viene attivato da AccessEnabler per richiedere all'applicazione di creare un'istanza di un controller SFSafariViewController e caricare l'URL fornito nel parametro url del callback. Il callback passa il parametro url che rappresenta l'URL dell'endpoint di autenticazione o l'URL dell'endpoint di disconnessione e il parametro useSVC che specifica che l'applicazione deve utilizzare un SFSafariViewController.

Poiché il controller SFSafariViewController viene sottoposto a diversi reindirizzamenti, l'applicazione deve monitorare l'attività del controller e rilevare il momento in cui carica un URL personalizzato specifico definito dal application's custom scheme (ad esempio **​ **adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com). Questo URL personalizzato specifico non è valido e non è destinato al controller per caricarlo effettivamente. Deve essere interpretato solo dall'applicazione come un segnale che il flusso di autenticazione o disconnessione è stato completato e che è sicuro chiudere il controller. Quando il controller carica questo URL personalizzato specifico, l'applicazione deve chiudere SFSafariViewController e chiamare il metodo API handleExternalURL:url di AccessEnabler.

Nota: Tieni presente che nel caso del flusso di autenticazione si tratta di un punto in cui l'utente può premere il pulsante "Indietro", che equivale all'interruzione del flusso di autenticazione. In questo caso, è necessario che l'applicazione chiami il metodo setSelectedProvider: passando nil come parametro e dando la possibilità ad AccessEnabler di reimpostare il computer dello stato di autenticazione.

@optional
​- (void) navigateToUrl:(NSString *)url useSVC:(BOOL)useSVC;

Disponibilità: ​v 3.2+

Parametri:

Attivato da: ​ setOptions: prima di setSelectedProvider:

Torna all'inizio…

handleExternalURL:url handleExternalURL

File: AccessEnabler/headers/AccessEnabler.h

Descrizione: Questo metodo viene chiamato dall'applicazione per completare il flusso di autenticazione o disconnessione. Questo metodo deve essere chiamato subito dopo che l'applicazione rileva il momento in cui il controller UIWebView/WKWebView or SFSafariViewController viene reindirizzato a un URL personalizzato specifico. Nel caso in cui l'applicazione debba utilizzare un controller SFSafariViewController , l'URL personalizzato specifico è definito da application's custom scheme (ad esempio adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com), altrimenti questo URL personalizzato specifico è definito dalla costante ADOBEPASS_REDIRECT_URL (ad esempio adobepass://ios.app).

Nel caso del flusso di autenticazione, AccessEnabler completa il flusso recuperando il token di autenticazione dal server back-end e archiviandolo localmente nell'archivio dei token. AccessEnabler informerà l'applicazione che il flusso di autenticazione è stato completato chiamando il callback setAuthenticationStatus() con il codice di stato 1, che indica l'esito positivo. Se si verifica un errore durante l'esecuzione di questi passaggi, il callback setAuthenticationStatus() viene attivato con il codice di stato 0, che indica un errore di autenticazione, nonché un codice di errore corrispondente.

 (void) handleExternalURL:(NSString *)url;

Disponibilità: v3.0+

Parametri:

Callback attivati: setAuthenticationStatus:errorCode, sendTrackingData:forEventType:

Torna all'inizio…

getAuthenticationToken - [OBSOLETO] getAuthNToken

File: AccessEnabler/headers/AccessEnabler.h

Descrizione: completa il flusso di autenticazione richiedendo il token di autenticazione al 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 dalla costante ADOBEPASS_REDIRECT_URL.

- (void) getAuthenticationToken;

Disponibilità: v1.0+ Fino a: v3.0

Parametri: Nessuno

Callback attivati: setAuthenticationStatus:errorCode,sendTrackingData:forEventType:

Torna all'inizio…

</br

setAuthenticationStatus:errorCode: setAuthNStatus

File: AccessEnabler/headers/EntitlementDelegate.h

Descrizione callback attivato da AccessEnabler 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.

- (void) setAuthenticationStatus:(int)status
                       errorCode:(NSString *)code;

Disponibilità: v1.0+

Parametri:

Attivato da: checkAuthentication, getAuthentication, getAuthentication:withData:, checkAuthorization:, checkAuthorization:withData:

Torna all'inizio…

checkPreauthorizedResources: checkPreauth

File: AccessEnabler/headers/AccessEnabler.h

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 consiste nel recuperare informazioni da utilizzare per decorare l'interfaccia utente (ad esempio, per indicare lo stato di accesso con le icone di blocco e sblocco).

- (void) checkPreauthorizedResources:(NSArray *)resources;

Disponibilità: v1.3+

Parametri:

Callback attivato: preauthorizedResources:

Torna all'inizio…

checkPreauthorizedResources:cache: checkPreauthCache

File: AccessEnabler/headers/AccessEnabler.h

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). Il parametro cache controlla se la cache interna viene utilizzata per la risoluzione delle risorse.

- (void) checkPreauthorizedResources:(NSArray *)resources cache:(BOOL)cache;

Disponibilità: v3.1+

Parametri:

Callback attivato: preauthorizedResources:

Torna all'inizio…

risorse preautorizzate: preauthResources

File: AccessEnabler/headers/EntitlementDelegate.h

Descrizione: richiamata attivata da checkPreauthorizedResources:. Fornisce un elenco delle risorse che l’utente è già autorizzato a visualizzare.

- (void) checkPreauthorizedResources:(NSArray *)resources;

Disponibilità: v1.3+

Parametri:

Attivato da: checkPreauthorizedResources:

Torna all'inizio…

checkAuthorization:, checkAuthorization:withData: checkAuthZ

File: AccessEnabler/headers/AccessEnabler.h

Descrizione: Questo metodo viene utilizzato dall'applicazione per verificare lo stato dell'autorizzazione. Viene innanzitutto verificato lo stato di autenticazione. Se non è autenticato, il callback tokenRequestFailed:errorCode:errorDescription: viene attivato e il metodo viene chiuso. Se l’utente è autenticato, attiva anche il flusso di autorizzazione. Visualizzare i dettagli sul metodo getAuthorization:.

- (void) checkAuthorization:(NSString *)resource;

Disponibilità: v1.0+

- (void) checkAuthorization:(NSString *)resource:
                   withData:(NSDictionary *)data;

Disponibilità: v1.9+

Parametri:

Callback attivati:

tokenRequestFailed:errorCode:errorDescription:,setToken:forResource:, sendTrackingData:forEventType:, setAuthenticationStatus:errorCode:

Torna all'inizio…

getAuthorization:, getAuthorization:withData: getAuthZ

File: AccessEnabler/headers/AccessEnabler.h

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, AccessEnabler 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 callback setToken:forResource: viene attivato e il token multimediale breve viene distribuito come parametro all'applicazione. Se per qualsiasi motivo l'autorizzazione non riesce, viene attivato il callback tokenRequestFailed:forEventType: e vengono forniti il codice di errore o i dettagli.

- (void) getAuthorization:(NSString *)resource;

Disponibilità: v1.0+

- (void) getAuthorization:(NSString *)resource:
                 withData:(NSDictionary *)data;

Disponibilità: v1.9+

Parametri:

Callback attivati: tokenRequestFailed:errorCode:errorDescription:, setToken:forResource:,sendTrackingData:forEventType:

Callback aggiuntivi attivati:
Questo metodo può anche attivare i seguenti callback (se viene avviato anche il flusso di autenticazione): setAuthenticationStatus:errorCode:, displayProviderDialog:

Torna all'inizio…

setToken:forResource: setToken

File: AccessEnabler/headers/EntitlementDelegate.h

Descrizione callback attivato da AccessEnabler che informa l'applicazione che il flusso di autorizzazione è stato completato correttamente. Anche il token multimediale di breve durata viene distribuito come parametro.

- (void) setToken:(NSString *)token
      forResource:(NSString *)resource;

Disponibilità: v1.0+

Parametri:

Attivato da: checkAuthorization: , checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:

Torna all'inizio…

tokenRequestFailed:errorCode:errorDescription: tokenReqFailed

File: AccessEnabler/headers/EntitlementDelegate.h

Descrizione Callback attivato da AccessEnabler che informa l'applicazione di livello superiore che il flusso di autorizzazione non è riuscito.

- (void) tokenRequestFailed:(NSString *)resource
                  errorCode:(NSString *)code
           errorDescription:(NSString *)description;

Disponibilità: v1.0+

Parametri:

Attivato da: checkAuthorization:, checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:

Torna all'inizio…

logout logout

File: AccessEnabler/headers/AccessEnabler.h

Descrizione: Questo metodo viene chiamato dall'applicazione per avviare il flusso di disconnessione. 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. Poiché non è possibile completare il flusso con una semplice richiesta HTTP emessa dalla libreria AccessEnabler, è necessario creare un'istanza di un controller UIWebView/WKWebView or SFSafariViewController per poter seguire le operazioni di reindirizzamento HTTP.

Il flusso di disconnessione è diverso dal flusso di autenticazione in quanto l'utente non è tenuto a interagire in alcun modo con il controller UIWebView/WKWebView or SFSafariViewController. Pertanto, Adobe consiglia di rendere il controllo invisibile (ovvero nascosto) durante la procedura di disconnessione.

Viene utilizzato un modello simile al flusso di autenticazione. IOS AccessEnabler attiva il callback navigateToUrl: o navigateToUrl:useSVC: per creare un controller UIWebView/WKWebView or SFSafariViewController e caricare l'URL fornito nel parametro url del callback. Questo è l'URL dell'endpoint di disconnessione sul server back-end. Per tvOS AccessEnabler non viene chiamato né il callback navigateToUrl: né quello navigateToUrl:useSVC:.

Durante l'esecuzione di diversi reindirizzamenti, l'applicazione deve monitorare l'attività del controller UIWebView/WKWebView or SFSafariViewController e rilevare il momento in cui carica un URL personalizzato specifico. Questo URL personalizzato specifico non è valido e non è destinato al controller per caricarlo effettivamente. Deve essere interpretato solo dall'applicazione come un segnale che il flusso di logout è stato completato e che è sicuro chiudere il controller. Quando il controller carica questo URL personalizzato specifico, l'applicazione deve chiudere il controller e chiamare il metodo API handleExternalURL:url di AccessEnabler. Nel caso in cui l'applicazione debba utilizzare un controller SFSafariViewController , l'URL personalizzato specifico è definito da application's custom scheme (ad esempio adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com), altrimenti questo URL personalizzato specifico è definito dalla costante ADOBEPASS_REDIRECT_URL (ad esempio adobepass://ios.app).

Alla fine AccessEnabler chiamerà il callback setAuthenticationStatus() con il codice di stato 0, che indica il completamento del flusso di logout.

Nota: se l'utente ha eseguito l'accesso con Apple SSO, verrà attivato lo stato di VSA203. In questo caso, l'utente deve essere informato di disconnettersi anche dalle impostazioni di sistema. In caso contrario, verrà eseguita una nuova autenticazione al riavvio dell'applicazione.

- (void) logout;

Disponibilità: v1.0+

Parametri: Nessuno

Callback attivati: navigateToUrl:, setAuthenticationStatus:errorCode:

Torna all'inizio…

getSelectedProvider getSelProv

File: AccessEnabler/headers/AccessEnabler.h

Descrizione: Utilizzare questo metodo per determinare il provider attualmente selezionato.

- (void) getSelectedProvider;

Disponibilità: v1.0+

Parametri: Nessuno

Callback attivati: selectedProvider:

Torna all'inizio…

selectedProvider selProv

File: AccessEnabler/headers/EntitlementDelegate.h

Descrizione callback attivato dall'AccessEnabler che consegna all'applicazione le informazioni sull'MVPD attualmente selezionato.

- (void) selectedProvider:(MVPD *)mvpd;

Disponibilità: v1.0+

Parametri:

Attivato da: getSelectedProvider

Torna all'inizio…

getMetadata: getMeta

File: AccessEnabler/headers/AccessEnabler.h

Descrizione: Utilizzare questo metodo per recuperare informazioni esposte come metadati dalla libreria AccessEnabler. L'applicazione può accedere a questi dati fornendo un parametro di input key basato su dizionario.

Esistono due tipi di metadati disponibili per i programmatori:

- (void) getMetadata:(NSDictionary *)keyDictionary;

Disponibilità: v1.0+

Parametri:

Callback attivati: setMetadataStatus:encrypted:forKey:andArguments:

Ulteriori informazioni: Metadati utente

Torna all'inizio…

presentTVProviderDialog presentTvDialog

File: AccessEnabler/headers/EntitlementDelegate.h

Descrizione Callback attivato da AccessEnabler dopo la chiamatagetAuthentication() se il richiedente corrente supporta almeno un MVPD con supporto SSO.

- (void) presentTvProviderDialog: (UIViewController *) viewController;

Disponibilità: v2.0+

Parametri:

Attivato da: getAuthentication

Ulteriori informazioni: Single Sign-On iOS/tvOS

Torna all'inizio…

dismissTVProviderDialog dismissTvDialog

File: AccessEnabler/headers/EntitlementDelegate.h

Descrizione callback attivato da AccessEnabler dopo la chiusura della finestra di dialogo SSO di Apple.

- (void) dismissTvProviderDialog: (UIViewController *) viewController;

Disponibilità: v2.0+

Parametri:

Attivazione da parte di: azione utente

Ulteriori informazioni: Single Sign-On iOS/tvOS

Torna all'inizio…

setMetadataStatus:encrypted:forKey:andArguments: setMetaStatus

File: AccessEnabler/headers/EntitlementDelegate.h

Descrizione callback attivato da AccessEnabler che distribuisce i metadati richiesti tramite una chiamata getMetadata:.

- (void) setMetadataStatus:(id)metadata
                 encrypted:(bool)encrypted
                    forKey:(int)key
              andArguments:(NSDictionary *)arguments;

Disponibilità: v1.0+

Parametri:

        {
            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"]
            }

Attivato da: getMetadata:

Ulteriori informazioni: Metadati utente

Torna all'inizio…

MVPD mvpd

File: AccessEnabler/headers/model/MVPD.h

Descrizione Descrive l'oggetto MVPD. Può essere utilizzato per ottenere informazioni sulle proprietà dell'MVPD.

Disponibilità: v1.0+ [la proprietà boardingStatus è disponibile dalla v2.2]

Proprietà:

Torna all'inizio…

Tracciamento degli eventi tracking

AccessEnabler attiva un callback aggiuntivo non necessariamente correlato ai flussi di adesione. L'implementazione della funzione di callback sendTrackingData() è facoltativa, 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.

sendTrackingData sendTracking

File: AccessEnabler/headers/EntitlementDelegate.h

Descrizione callback attivato da AccessEnabler che segnala all'applicazione l'occorrenza di vari eventi, ad esempio il completamento/errore dei flussi di autenticazione/autorizzazione. Con Adobe Pass Authentication 1.6, il tipo di dispositivo, il tipo di client AccessEnabler e il sistema operativo sono segnalati da sendTrackingData(). Il callback sendTrackingData() rimane compatibile con le versioni precedenti.

Callback: eventi di tracciamento

(void) sendTrackingData:(NSArray *)data
             forEventType:(int)event;

Disponibilità: v1.0+

Nota: il tipo di dispositivo e il sistema operativo sono derivati dall'utilizzo di una libreria Java pubblica (http://java.net/projects/user-agent-utils) e della stringa dell'agente utente. Tieni presente che queste informazioni vengono fornite solo come metodo grezzo per suddividere le metriche operative in categorie di dispositivi, ma che l’Adobe non può assumersi alcuna responsabilità per risultati errati. Utilizza la nuova funzionalità di conseguenza.

Parametri:

Attivato da: checkAuthentication, getAuthentication, getAuthentication:withData:, checkAuthorization:, checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:, setSelectedProvider:

Istruzioni per l'interpretazione dei valori nell'array data: