Référence de l’API SDK iOS/tvOS (héritée) iostvos-sdk-api-reference

Introduction intro

Cette page décrit les méthodes et les fonctions de rappel exposées par le client natif iOS/tvOS pour l’authentification Adobe Pass. Les méthodes et fonctions de rappel décrites ici sont définies dans les fichiers d’en-tête AccessEnabler.h et EntitlementDelegate.h ; vous pouvez les retrouver dans le SDK AccessEnabler d’iOS à l’adresse suivante : [SDK directory]/AccessEnabler/headers/api/

Documentation associée :

Référence d’API apis

init:softwareStatement initWithSoftwareStatement

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : instancie l'objet AccessEnabler. Il doit y avoir une seule instance AccessEnabler par instance d'application.

Disponibilité : v3.0+

Paramètres:

Haut de la page…

init - [OBSOLÈTE] init

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : instancie l'objet AccessEnabler. Il doit y avoir une seule instance AccessEnabler par instance d'application.

Disponibilité : v1.0+ Jusqu’au : v3.0

Paramètres: Aucun

Haut de la page…

setOptions:options setOptions

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : configure les options globales de SDK. Il accepte un NSDictionary comme argument. Les valeurs du dictionnaire seront transmises au serveur avec chaque appel réseau effectué par le SDK.

Remarque : les valeurs seront transmises au serveur indépendamment du flux actuel (authentification/autorisation). Si vous souhaitez modifier les valeurs, vous pouvez appeler cette méthode à tout moment.

Disponibilité : v2.3.0+

Paramètres:

Haut de la page…

setRequestor:requestorID, setRequestor:requestorID:serviceProviders: setReqV3

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : établit l’identité du programmeur. Chaque programmeur se voit attribuer un ID unique lors de l’enregistrement avec l’Adobe pour le système d’authentification Adobe Pass. Lorsque vous traitez des jetons SSO et distants, l'état d'authentification peut changer lorsque l'application est en arrière-plan, setRequestor peut être appelé à nouveau lorsque l'application est amenée au premier plan afin de se synchroniser avec l'état du système (récupérer un jeton distant si SSO est activé ou supprimer le jeton local si une déconnexion s'est produite en attendant).

La réponse du serveur contient une liste de fichiers MVPD ainsi que des informations de configuration associées à l’identité du programmeur. La réponse du serveur est utilisée en interne par le code AccessEnabler. Seul le statut de l’opération (c’est-à-dire SUCCÈS/ÉCHEC) est présenté à votre application via le rappel setRequestorComplete:.

Si le paramètre urls n’est pas utilisé, l’appel réseau résultant cible l’URL du fournisseur de services par défaut : l’environnement RELEASE/production d’Adobe.

Si une valeur est fournie pour le paramètre urls, l’appel réseau résultant cible toutes les URL fournies dans le paramètre urls. Toutes les demandes de configuration sont déclenchées simultanément dans des threads distincts. Le premier répondant est prioritaire lors de la compilation de la liste des MVPD. Pour chaque MVPD de la liste, AccessEnabler mémorise l’URL du fournisseur d’accès associé. Toutes les demandes de droits suivantes sont dirigées vers l’URL associée au fournisseur de services qui a été associé au MVPD cible pendant la phase de configuration.

Disponibilité : v3.0+

Disponibilité : v3.0+

Paramètres:

Rappels déclenchés : setRequestorComplete:

Haut de la page…

setRequestor:setSignedRequestorId:, setRequestor:setSignedRequestorId:serviceProviders: - [ OBSOLÈTE ] setReq

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : établit l’identité du programmeur. Chaque programmeur se voit attribuer un ID unique lors de l’enregistrement avec l’Adobe pour le système d’authentification Adobe Pass. Lorsque vous traitez avec des jetons SSO et distants, l'état d'authentification peut changer lorsque l'application est en arrière-plan, setRequestor peut être appelé à nouveau lorsque l'application est mise en premier plan afin de se synchroniser avec l'état du système (récupérer un jeton distant si SSO est activé ou supprimer le jeton local si une déconnexion s'est produite en attendant).

La réponse du serveur contient une liste de fichiers MVPD ainsi que des informations de configuration associées à l’identité du programmeur. La réponse du serveur est utilisée en interne par le code AccessEnabler. Seul le statut de l’opération (c’est-à-dire SUCCÈS/ÉCHEC) est présenté à votre application via le rappel setRequestorComplete:.

Si le paramètre urls n’est pas utilisé, l’appel réseau résultant cible l’URL du fournisseur de services par défaut : l’environnement RELEASE/production d’Adobe.

Si une valeur est fournie pour le paramètre urls, l’appel réseau résultant cible toutes les URL fournies dans le paramètre urls. Toutes les demandes de configuration sont déclenchées simultanément dans des threads distincts. Le premier répondant est prioritaire lors de la compilation de la liste des MVPD. Pour chaque MVPD de la liste, AccessEnabler mémorise l’URL du fournisseur d’accès associé. Toutes les demandes de droits suivantes sont dirigées vers l’URL associée au fournisseur de services qui a été associé au MVPD cible pendant la phase de configuration.

Disponibilité : v1.0+ Jusqu’au : v3.0

Disponibilité : v1.0+ Jusqu’au : v3.0

Paramètres:

Notes : si elle est appelée sans le paramètre serviceProviders, la bibliothèque récupère la configuration du fournisseur de services par défaut (c’est-à-dire https://sp.auth.adobe.com pour le profil de production ou https://sp.auth-staging.adobe.com pour le profil d’évaluation). Si le paramètre serviceProviders est fourni, il doit s’agir d’un tableau d’URL. Les informations de configuration sont récupérées à partir de tous les points d’entrée spécifiés et sont fusionnées. S'il existe des informations en double dans les différentes réponses du fournisseur de services, le conflit est résolu en faveur du serveur qui répond le plus rapidement (c'est-à-dire que le serveur qui a le temps de réponse le plus court est prioritaire).

Rappels déclenchés : setRequestorComplete:

Haut de la page…

setRequestor:setSignedRequestorId:secret:publicKey, setRequestor:setSignedRequestorId:serviceProviders:secret:publicKey - [ OBSOLÈTE ] setReq_tvos

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : établit l’identité du programmeur. Chaque programmeur se voit attribuer un ID unique lors de l’enregistrement avec l’Adobe pour le système d’authentification Adobe Pass. Ce réglage ne doit être effectué qu'une seule fois pendant le cycle de vie de l'application.

La réponse du serveur contient une liste de fichiers MVPD ainsi que des informations de configuration associées à l’identité du programmeur. La réponse du serveur est utilisée en interne par le code AccessEnabler. Seul le statut de l’opération (c’est-à-dire SUCCÈS/ÉCHEC) est présenté à votre application via le rappel setRequestorComplete:.

Si le paramètre urls n’est pas utilisé, l’appel réseau résultant cible l’URL du fournisseur de services par défaut : l’environnement RELEASE/production d’Adobe.

Si une valeur est fournie pour le paramètre urls, l’appel réseau résultant cible toutes les URL fournies dans le paramètre urls. Toutes les demandes de configuration sont déclenchées simultanément dans des threads distincts. Le premier répondant est prioritaire lors de la compilation de la liste des MVPD. Pour chaque MVPD de la liste, AccessEnabler mémorise l’URL du fournisseur d’accès associé. Toutes les demandes de droits suivantes sont dirigées vers l’URL associée au fournisseur de services qui a été associé au MVPD cible pendant la phase de configuration.

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

Disponibilité : v2.0+ Jusqu’au : v3.0

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

Disponibilité : v2.0+ Jusqu’au : v3.0

Paramètres:

Si elle est appelée sans le paramètre serviceProviders, la bibliothèque récupère la configuration auprès du fournisseur de services par défaut (à savoir, https://sp.auth.adobe.com pour le profil de production ou https://sp.auth-staging.adobe.com pour le profil d’évaluation). Si le paramètre serviceProviders est fourni, il doit s’agir d’un tableau d’URL. Les informations de configuration sont récupérées à partir de tous les points d’entrée spécifiés et sont fusionnées. S'il existe des informations en double dans les différentes réponses du fournisseur de services, le conflit est résolu en faveur du serveur qui répond le plus rapidement (c'est-à-dire que le serveur qui a le temps de réponse le plus court est prioritaire).

Rappels déclenchés : setRequestorComplete:

Haut de la page…

setRequestorComplete : setReqComplete

Fichier: AccessEnabler/headers/EntitlementDelegate.h

Description Rappel déclenché par AccessEnabler qui informe votre application que la phase de configuration est terminée. Il s’agit d’un signal indiquant que l’application peut commencer à émettre des demandes de droits. Aucune demande de droits ne peut être émise par l’application tant que la phase de configuration n’est pas terminée.

- (void) setRequestorComplete:(int)status;

Disponibilité : v1.0+

Paramètres :

Déclenché par :

setRequestor:setSignedRequestorId:, setRequestor:setSignedRequestorId:serviceProviders:

Haut de la page…

checkAuthentication checkAuthN

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : vérifie le statut d’authentification de l’utilisateur actuel.
Pour ce faire, il recherche un jeton d’authentification valide dans le fichier local
espace de stockage des jetons. Cette méthode n’effectue aucun appel réseau et nous vous recommandons de l’appeler sur le thread principal.
Il est utilisé par l’application pour interroger le statut d’authentification de l’utilisateur et
mettez à jour l’interface utilisateur en conséquence (c’est-à-dire, mettez à jour l’interface utilisateur de connexion/déconnexion). Le
le statut d’authentification est communiqué à l’application via .
le rappel setAuthenticationStatus:errorCode:.

- (void) checkAuthentication;

Disponibilité : v1.0+

Paramètres: Aucun

Rappels déclenchés :
setAuthenticationStatus:errorCode:

Haut de la page…

getAuthentication, getAuthentication:withData: getAuthN

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : démarre le workflow d’authentification complet. Il commence par vérifier le statut de l’authentification. S’il n’est pas déjà authentifié, la machine d’état du flux d’authentification est démarrée :

Comme les informations d’identification de l’utilisateur sont vérifiées sur la page de connexion de MVPD, votre application doit surveiller les multiples opérations de redirection qui ont lieu lorsque l’utilisateur s’authentifie sur la page de connexion de MVPD. Lorsque les informations d'identification correctes sont saisies, le contrôle WebView est redirigé vers une URL personnalisée définie par la constante ADOBEPASS_REDIRECT_URL. Cette URL ne doit pas être chargée par le WebView. L’application doit intercepter cette URL et interpréter cet événement comme un signal indiquant que la phase de connexion est terminée. Il doit ensuite transmettre le contrôle à AccessEnabler pour terminer le flux d’authentification (en appelant la méthode handleExternalURL).

Enfin, le statut d'authentification est communiqué à l'application via le rappel setAuthenticationStatus:errorCode:.

- (void) getAuthentication;

Disponibilité : v1.0+

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

Disponibilité : v1.9+

Paramètres:

Rappels déclenchés : setAuthenticationStatus:errorCode:, displayProviderDialog:, sendTrackingData:forEventType:

Haut de la page…

getAuthentication:filter, getAuthentication:withData:andFilter getAuthN_filter

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : démarre le workflow d’authentification complet. Il commence par vérifier le statut de l’authentification. S’il n’est pas déjà authentifié, la machine d’état du flux d’authentification est démarrée :

Enfin, le statut d'authentification est communiqué à l'application via le rappel setAuthenticationStatus:errorCode:.

Disponibilité : v2.4+

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

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

Paramètres:

Disponibilité : v2.0 - v2.3.1

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

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

Paramètres:

Rappels déclenchés : setAuthenticationStatus:errorCode:, presentTvProviderDialog, dismissTvProviderDialog

Haut de la page…

displayProviderDialog : dispProvDialog

Fichier: AccessEnabler/headers/EntitlementDelegate.h

Description Rappel déclenché par AccessEnabler pour informer l’application que les éléments d’IU appropriés doivent être instanciés pour permettre à l’utilisateur de sélectionner le MVPD souhaité. Le rappel fournit une liste d’objets MVPD avec des informations supplémentaires qui peuvent aider à créer correctement le panneau de l’interface utilisateur de sélection (comme l’URL pointant vers le logo MVPD, le nom d’affichage convivial, etc.)

Une fois que l’utilisateur a sélectionné le MVPD souhaité, l’application de couche supérieure doit reprendre le flux d’authentification en appelant setSelectedProvider: et en lui transmettant l’identifiant du MVPD correspondant à la sélection de l’utilisateur.

Abandon du flux d’authentification - À ce stade, l’utilisateur peut appuyer sur le bouton « Précédent », ce qui équivaut à abandonner le flux d’authentification. Dans ce scénario, votre application doit appeler la méthode setSelectedProvider:, en transmettant null comme paramètre, pour donner à AccessEnabler la possibilité de réinitialiser son ordinateur d'état d'authentification.

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

Disponibilité : v1.0+

Paramètres :

Déclenché par : getAuthentication, getAuthentication:withData:, getAuthorization:, getAuthorization:withData:

Haut de la page…

setSelectedProvider : setSelProv

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : cette méthode est appelée par votre application pour informer Access Enabler de la sélection MVPD de l’utilisateur. L’application peut utiliser cette méthode pour sélectionner ou modifier le fournisseur de services utilisé pour l’authentification.

Si le MVPD sélectionné est un MVPD TempPass, il s’authentifiera automatiquement avec ce MVPD sans avoir à appeler getAuthentication() par la suite.

Notez que cela n’est pas possible pour le transfert temporaire promotionnel où des paramètres supplémentaires sont donnés sur la méthode getAuthentication().

Lors de la transmission du paramètre null, Access Enabler suppose que l’utilisateur a annulé le flux d’authentification (c’est-à-dire qu’il a appuyé sur le bouton « Précédent ») et répond en réinitialisant la machine d’état d’authentification et en appelant le rappel setAuthenticationStatus:errorCode: avec le code d’erreur AccessEnabler.PROVIDER_NOT_SELECTED_ERROR.

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

Disponibilité : v1.0+

Paramètres: Aucun

Rappels déclenchés : setAuthenticationStatus:errorCode:,sendTrackingData:forEventType:, navigateToUrl:

Haut de la page…

navigateToUrl : nav2url

Fichier: AccessEnabler/headers/EntitlementDelegate.h

Description : rappel déclenché par AccessEnabler pour demander à votre application d'instancier un contrôleur UIWebView/WKWebView et de charger l'URL fournie dans le paramètre url du rappel. Le rappel transmet le paramètre url qui représente l’URL du point d’entrée d’authentification ou l’URL du point d’entrée de déconnexion.

Comme le contrôleur UIWebView/WKWebView Controller passe par plusieurs redirections, votre application doit surveiller l'activité du contrôleur et détecter le moment où il charge une URL personnalisée spécifique définie par la ADOBEPASS_REDIRECT_URL constante (c'est-à-dire adobepass://ios.app). Notez que cette URL personnalisée spécifique n'est pas valide et qu'elle n'est pas destinée à être chargée par le contrôleur. Il doit être interprété par votre application uniquement comme un signal indiquant que l’authentification ou le flux de déconnexion est terminé et qu’il est sûr de fermer le contrôleur. Lorsque le contrôleur charge cette URL personnalisée spécifique, votre application doit fermer UIWebView/WKWebView et appeler la méthode handleExternalURL:url API d'AccessEnabler.

Remarque : Notez que dans le cas du flux d’authentification, il s’agit d’un point où l’utilisateur a la possibilité d’appuyer sur le bouton « Précédent », ce qui équivaut à l’abandon du flux d’authentification. Dans un tel scénario, votre application doit appeler la méthode setSelectedProvider: en transmettant nil comme paramètre et en donnant une chance à AccessEnabler de réinitialiser son ordinateur d'état d'authentification.

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

Disponibilité : v1.0+

Paramètres :

Déclenché par : setSelectedProvider:

Haut de la page…

navigateToUrl:useSVC: nav2urlSVC

Fichier: AccessEnabler/headers/EntitlementDelegate.h

Description : rappel déclenché par AccessEnabler au lieu du rappel navigateToUrl: au cas où votre application aurait activé la gestion manuelle du contrôleur de vue Safari (SVC) via l’appel setOptions([« handleSVC »:true »]) et uniquement dans le cas de MVPD nécessitant le contrôleur de vue Safari (SVC). Pour tous les autres MVPD, le rappel navigateToUrl: est appelé. Veuillez consulter la prise en charge SFSafariViewController sur iOS SDK 3.2+ pour plus d’informations sur la manière dont Safari View Controller (SVC) doit être géré.

Tout comme le rappel navigateToUrl:, le navigateToUrl:useSVC: est déclenché par AccessEnabler pour demander à votre application d’instancier un contrôleur de SFSafariViewController et de charger l’URL fournie dans le paramètre url du rappel. Le rappel transmet le paramètre url qui représente l’URL du point d’entrée d’authentification ou l’URL du point d’entrée de déconnexion, ainsi que le paramètre useSVC qui spécifie que l’application doit utiliser un SFSafariViewController.

Comme le contrôleur de SFSafariViewController passe par plusieurs redirections, votre application doit surveiller l'activité du contrôleur et détecter le moment où il charge une URL personnalisée spécifique définie par votre application's custom scheme (par exemple **​ **adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com). Notez que cette URL personnalisée spécifique n'est pas valide et qu'elle n'est pas destinée à être chargée par le contrôleur. Il doit être interprété par votre application uniquement comme un signal indiquant que l’authentification ou le flux de déconnexion est terminé et qu’il est sûr de fermer le contrôleur. Lorsque le contrôleur charge cette URL personnalisée spécifique, votre application doit fermer le SFSafariViewController et appeler la méthode handleExternalURL:url API d'AccessEnabler.

Remarque : Notez que dans le cas du flux d’authentification, il s’agit d’un point où l’utilisateur a la possibilité d’appuyer sur le bouton « Précédent », ce qui équivaut à l’abandon du flux d’authentification. Dans un tel scénario, votre application doit appeler la méthode setSelectedProvider: en transmettant nil comme paramètre et en donnant une chance à AccessEnabler de réinitialiser son ordinateur d'état d'authentification.

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

Disponibilité : ​v 3.2+

Paramètres :

Déclenché par: ​ setOptions: avant setSelectedProvider:

Haut de la page…

handleExternalURL:url handleExternalURL

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : cette méthode est appelée par votre application pour terminer le flux d’authentification ou de déconnexion. Cette méthode doit être appelée juste après que votre application détecte le moment où le contrôleur de UIWebView/WKWebView or SFSafariViewController est redirigé vers une URL personnalisée spécifique. Si votre application doit utiliser un SFSafariViewController contrôleur, l’URL personnalisée spécifique est définie par votre application's custom scheme (par exemple, adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com). Dans le cas contraire, cette URL personnalisée spécifique est définie par la ADOBEPASS_REDIRECT_URL constante (par exemple, adobepass://ios.app).

Dans le cas du flux d’authentification, AccessEnabler termine le flux en récupérant le jeton d’authentification du serveur principal et en le stockant localement dans le stockage des jetons. AccessEnabler informe votre application que le flux d’authentification est terminé en appelant le rappel setAuthenticationStatus() avec un code d’état de 1, indiquant la réussite. En cas d’erreur lors de l’exécution de ces étapes, le rappel setAuthenticationStatus() est déclenché avec un code d’état de 0 indiquant l’échec de l’authentification, ainsi qu’un code d’erreur correspondant.

 (void) handleExternalURL:(NSString *)url;

Disponibilité : v3.0+

Paramètres:

Rappels déclenchés : setAuthenticationStatus:errorCode, sendTrackingData:forEventType:

Haut de la page…

getAuthenticationToken - [OBSOLÈTE] getAuthNToken

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : termine le flux d’authentification en demandant le jeton d’authentification au serveur principal. Cette méthode ne doit être appelée par votre application qu’en réponse à un événement où le contrôle WebView hébergeant la page de connexion MVPD est redirigé vers l’URL personnalisée définie par la constante ADOBEPASS_REDIRECT_URL.

- (void) getAuthenticationToken;

Disponibilité : v1.0+ Jusqu’au : v3.0

Paramètres: Aucun

Rappels déclenchés : setAuthenticationStatus:errorCode,sendTrackingData:forEventType:

Haut de la page…

</br

setAuthenticationStatus:errorCode: setAuthNStatus

Fichier: AccessEnabler/headers/EntitlementDelegate.h

Description Rappel déclenché par AccessEnabler qui informe l’application du statut du flux d’authentification. Il existe de nombreux cas où ce flux peut échouer, soit en raison de l’interaction de l’utilisateur ou d’autres scénarios imprévus (par exemple, des problèmes de connectivité réseau, etc.). Ce rappel informe l’application de l’état de succès/échec du flux d’authentification, tout en fournissant des informations supplémentaires sur la raison de l’échec, le cas échéant.

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

Disponibilité : v1.0+

Paramètres :

Déclenché par : checkAuthentication, getAuthentication, getAuthentication:withData:, checkAuthorization:, checkAuthorization:withData:

Haut de la page…

checkPreauthorizedResources : checkPreauth

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : cette méthode est utilisée par l’application pour déterminer si l’utilisateur est déjà autorisé à afficher des ressources protégées spécifiques. L’objectif principal de cette méthode est de récupérer des informations à utiliser pour décorer la de l’interface utilisateur (par exemple, en indiquant le statut d’accès avec des icônes de verrouillage et de déverrouillage).

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

Disponibilité : v1.3+

Paramètres:

Rappel déclenché : preauthorizedResources:

Haut de la page…

checkPreauthorizedResources:cache: checkPreauthCache

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : cette méthode est utilisée par l’application pour déterminer si l’utilisateur est déjà autorisé à afficher des ressources protégées spécifiques. L’objectif principal de cette méthode est de récupérer des informations à utiliser pour décorer l’interface utilisateur (par exemple, en indiquant le statut d’accès avec des icônes de verrouillage et de déverrouillage). Le paramètre cache contrôle si le cache interne est utilisé pour résoudre les ressources.

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

Disponibilité : v3.1+

Paramètres:

Rappel déclenché : preauthorizedResources:

Haut de la page…

preauthorizedResources : preauthResources

Fichier: AccessEnabler/headers/EntitlementDelegate.h

Description : rappel déclenché par checkPreauthorizedResources:. Fournit une liste des ressources que l’utilisateur est déjà autorisé à afficher.

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

Disponibilité : v1.3+

Paramètres:

Déclenché par : checkPreauthorizedResources:

Haut de la page…

checkAuthorization:, checkAuthorization:withData: checkAuthZ

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : cette méthode est utilisée par l’application pour vérifier le statut de l’autorisation. Il commence par vérifier d’abord le statut de l’authentification. S’il n’est pas authentifié, le rappel tokenRequestFailed:errorCode:errorDescription: est déclenché et la méthode se ferme. Si l’utilisateur est authentifié, cela déclenche également le flux d’autorisation. Voir les détails sur la méthode getAuthorization:.

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

Disponibilité : v1.0+

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

Disponibilité : v1.9+

Paramètres:

Rappels déclenchés :

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

Haut de la page…

getAuthorization:, getAuthorization:withData: getAuthZ

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : cette méthode est utilisée par l’application pour lancer le flux d’autorisation. Si l’utilisateur n’est pas déjà authentifié, il lance également le flux d’authentification. Si l’utilisateur est authentifié, AccessEnabler émet des demandes pour le jeton d’autorisation (si aucun jeton d’autorisation valide n’est présent dans le cache de jetons local) et pour le jeton de média de courte durée. Une fois le jeton de média court obtenu, le flux d’autorisation est considéré comme terminé. Le rappel setToken:forResource: est déclenché et le jeton de média court est fourni en tant que paramètre à l’application. Si, pour une raison quelconque, l’autorisation échoue, le rappel tokenRequestFailed:forEventType: est déclenché et le code/les détails de l’erreur sont fournis.

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

Disponibilité : v1.0+

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

Disponibilité : v1.9+

Paramètres:

Rappels déclenchés : tokenRequestFailed:errorCode:errorDescription:, setToken:forResource:,sendTrackingData:forEventType:

Rappels supplémentaires déclenchés :
Cette méthode peut également déclencher les rappels suivants (si le flux d’authentification est également initié) : setAuthenticationStatus:errorCode:, displayProviderDialog:

Haut de la page…

setToken:forResource: setToken

Fichier: AccessEnabler/headers/EntitlementDelegate.h

Description Rappel déclenché par AccessEnabler qui informe votre application que le flux d’autorisation a été terminé avec succès. Le jeton de média de courte durée est également diffusé en tant que paramètre.

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

Disponibilité : v1.0+

Paramètres :

Déclenché par : checkAuthorization: , checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:

Haut de la page…

tokenRequestFailed:errorCode:errorDescription: tokenReqFailed

Fichier: AccessEnabler/headers/EntitlementDelegate.h

Description Rappel déclenché par AccessEnabler qui informe l’application de couche supérieure de l’échec du flux d’autorisation.

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

Disponibilité : v1.0+

Paramètres :

Déclenché par : checkAuthorization:, checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:

Haut de la page…

déconnexion logout

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : cette méthode est appelée par votre application pour lancer le flux de déconnexion. La déconnexion est le résultat d’une série d’opérations de redirection HTTP en raison du fait que l’utilisateur doit être déconnecté des serveurs d’authentification Adobe Pass et des serveurs de MVPD. Comme ce flux ne peut pas être exécuté avec une simple requête HTTP émise par la bibliothèque AccessEnabler, un contrôleur UIWebView/WKWebView or SFSafariViewController doit être instancié pour pouvoir suivre les opérations de redirection HTTP.

Le flux de déconnexion diffère du flux d’authentification dans la mesure où l’utilisateur n’est pas tenu d’interagir de quelque manière que ce soit avec le contrôleur de UIWebView/WKWebView or SFSafariViewController. Par conséquent, Adobe recommande de rendre le contrôle invisible (c’est-à-dire masqué) pendant le processus de déconnexion.

Un motif similaire au flux d’authentification est utilisé. IOS AccessEnabler déclenche le rappel navigateToUrl: ou le navigateToUrl:useSVC: pour créer un contrôleur de UIWebView/WKWebView or SFSafariViewController et charger l’URL fournie dans le paramètre url du rappel. Il s’agit de l’URL du point d’entrée de déconnexion sur le serveur principal. Pour tvOS AccessEnabler, ni le rappel navigateToUrl: ni le rappel navigateToUrl:useSVC: n’est appelé.

Comme il passe par plusieurs redirections, votre application doit surveiller l'activité du contrôleur UIWebView/WKWebView or SFSafariViewController et détecter le moment où il charge une URL personnalisée spécifique. Notez que cette URL personnalisée spécifique n'est pas valide et qu'elle n'est pas destinée à être chargée par le contrôleur. Il doit être interprété par votre application uniquement comme un signal indiquant que le flux de déconnexion est terminé et qu'il est sûr de fermer le contrôleur. Lorsque le contrôleur charge cette URL personnalisée spécifique, votre application doit fermer le contrôleur et appeler la méthode handleExternalURL:url API AccessEnabler. Si votre application doit utiliser un SFSafariViewController contrôleur, l’URL personnalisée spécifique est définie par votre application's custom scheme (par exemple, adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com). Dans le cas contraire, cette URL personnalisée spécifique est définie par la ADOBEPASS_REDIRECT_URL constante (par exemple, adobepass://ios.app).

À la fin, AccessEnabler appelle le rappel setAuthenticationStatus() avec un code d'état de 0, indiquant le succès du flux de déconnexion.

Remarque : si l’utilisateur est connecté à l’aide de l’authentification unique Apple, le statut de VSA203 est déclenché. Si c’est le cas, l’utilisateur doit être invité à se déconnecter également des paramètres système. Si vous ne le faites pas, une nouvelle authentification sera effectuée lors du relancement de l’application.

- (void) logout;

Disponibilité : v1.0+

Paramètres: Aucun

Rappels déclenchés : navigateToUrl:, setAuthenticationStatus:errorCode:

Haut de la page…

getSelectedProvider getSelProv

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : utilisez cette méthode pour déterminer le fournisseur actuellement sélectionné.

- (void) getSelectedProvider;

Disponibilité : v1.0+

Paramètres: Aucun

Rappels déclenchés : selectedProvider:

Haut de la page…

selectedProvider selProv

Fichier: AccessEnabler/headers/EntitlementDelegate.h

Description Rappel déclenché par l’AccessEnabler qui fournit des informations sur le MVPD actuellement sélectionné à l’application.

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

Disponibilité : v1.0+

Paramètres :

Déclenché par : getSelectedProvider

Haut de la page…

getMetadata: getMeta

Fichier: AccessEnabler/headers/AccessEnabler.h

Description : utilisez cette méthode pour récupérer des informations exposées en tant que métadonnées par la bibliothèque AccessEnabler. L’application peut accéder à ces données en fournissant un paramètre d’entrée clé basé sur un dictionnaire.

Les programmeurs ont accès à deux types de métadonnées :

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

Disponibilité : v1.0+

Paramètres:

Rappels déclenchés : setMetadataStatus:encrypted:forKey:andArguments:

Informations supplémentaires : Métadonnées utilisateur

Haut de la page…

presentTVProviderDialog presentTvDialog

Fichier: AccessEnabler/headers/EntitlementDelegate.h

Description Rappel déclenché par AccessEnabler après avoir appelé getAuthentication() si le demandeur actuel prend en charge au moins un MVPD avec prise en charge de l’authentification unique.

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

Disponibilité : v2.0+

Paramètres :

Déclenché par : getAuthentication

Informations supplémentaires : Authentification unique iOS/tvOS

Haut de la page…

dismissTVProviderDialog dismissTvDialog

Fichier: AccessEnabler/headers/EntitlementDelegate.h

Description Rappel déclenché par AccessEnabler après la fermeture de la boîte de dialogue SSO d’Apple par l’utilisateur.

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

Disponibilité : v2.0+

Paramètres :

Déclenché par : action de l’utilisateur

Informations supplémentaires : Authentification unique iOS/tvOS

Haut de la page…

setMetadataStatus:encrypted:forKey:andArguments: setMetaStatus

Fichier: AccessEnabler/headers/EntitlementDelegate.h

Description Rappel déclenché par l’AccessEnabler qui fournit les métadonnées demandées par le biais d’un appel getMetadata:.

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

Disponibilité : v1.0+

Paramètres :

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

Déclenché par : getMetadata:

Informations supplémentaires : Métadonnées utilisateur

Haut de la page…

MVPD mvpd

Fichier: AccessEnabler/headers/model/MVPD.h

Description décrit l’objet MVPD. Peut être utilisé pour obtenir des informations sur les propriétés de MVPD.

Disponibilité : version 1.0+ [la propriété boardingStatus est disponible dans la version 2.2]

Propriétés :

Haut de la page…

Suivi des événements tracking

AccessEnabler déclenche un rappel supplémentaire qui n’est pas nécessairement lié aux flux de droits. L’implémentation de la fonction de rappel sendTrackingData() est facultative, mais elle permet à l’application de suivre des événements spécifiques et de compiler des statistiques telles que le nombre de tentatives d’authentification/d’autorisation réussies/ayant échoué.

sendTrackingData sendTracking

Fichier: AccessEnabler/headers/EntitlementDelegate.h

Description Rappel déclenché par l’AccessEnabler signalant à l’application l’occurrence de divers événements tels que l’achèvement/l’échec des flux d’authentification/d’autorisation. Avec Adobe Pass Authentication 1.6, le type d’appareil, le type de client AccessEnabler et le système d’exploitation sont signalés par sendTrackingData(). Le rappel sendTrackingData() reste rétrocompatible.

Rappel : suivi des événements

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

Disponibilité : v1.0+

Remarque : le type d’appareil et le système d’exploitation sont dérivés à l’aide d’une bibliothèque Java publique (http://java.net/projects/user-agent-utils) et de la chaîne de l’agent utilisateur. Notez que ces informations ne sont fournies qu’à titre approximatif pour ventiler les mesures opérationnelles en catégories d’appareils, mais que l’Adobe ne peut être tenu responsable de résultats incorrects. Veuillez utiliser la nouvelle fonctionnalité en conséquence.

Paramètres :

Déclenché par : checkAuthentication, getAuthentication, getAuthentication:withData:, checkAuthorization:, checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:, setSelectedProvider:

Instructions pour interpréter les valeurs du tableau data :