Referencia de la API del SDK para iOS/tvOS iostvos-sdk-api-reference

Introducción intro

En esta página se describen los métodos y las funciones de llamada de retorno expuestos por el cliente nativo de iOS/tvOS para la autenticación de Adobe Pass. Los métodos y las funciones de devolución de llamada descritos aquí se definen en los archivos de encabezado AccessEnabler.h y EntitlementDelegate.h; puede encontrarlos en el SDK de iOS AccessEnabler aquí: [SDK directory]/AccessEnabler/headers/api/

Documentación asociada:

Referencia de API apis

init:softwareStatement initWithSoftwareStatement

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: crea una instancia del objeto AccessEnabler. Debe haber una sola instancia de AccessEnabler por cada instancia de aplicación.

Disponibilidad: v3.0+

Parámetros:

Volver al principio…

init - [OBSOLETO] init

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: crea una instancia del objeto AccessEnabler. Debe haber una sola instancia de AccessEnabler por cada instancia de aplicación.

Disponibilidad: v1.0+ Hasta: v3.0

Parámetros: Ninguno

Volver al principio…

setOptions:opciones setOptions

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: configura las opciones globales del SDK. Acepta un NSDictionary como argumento. Los valores del diccionario se pasarán al servidor junto con cada llamada de red que realice el SDK.

Nota: Los valores se pasarán al servidor independientemente del flujo actual (autenticación/autorización). Si desea cambiar los valores, puede llamar a este método en cualquier momento.

Disponibilidad: v2.3.0+

Parámetros:

Volver al principio…

setRequestor:requestorID, setRequestor:requestorID:serviceProviders: setReqV3

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: establece la identidad del programador. A cada programador se le asigna un ID único al registrarse con el Adobe en el sistema de autenticación de Adobe Pass. Cuando se trata de SSO y tokens remotos, el estado de autenticación puede cambiar cuando la aplicación está en segundo plano, se puede volver a llamar a setRequestor cuando la aplicación se pone en primer plano para sincronizar con el estado del sistema (recupere un token remoto si el SSO está habilitado o elimine el token local si se ha cerrado la sesión mientras tanto).

La respuesta del servidor contiene una lista de MVPD junto con información de configuración adjunta a la identidad del programador. El código AccessEnabler utiliza internamente la respuesta del servidor. Solo el estado de la operación (es decir, SUCCESS/FAIL) se presenta a su aplicación a través de la llamada de retorno setRequestorComplete:.

Si no se usa el parámetro urls, la llamada de red resultante se dirigirá a la dirección URL del proveedor de servicios predeterminado: el entorno de producción/VERSIÓN de Adobe.

Si se proporciona un valor para el parámetro urls, la llamada de red resultante se dirigirá a todas las direcciones URL proporcionadas en el parámetro urls. Todas las solicitudes de configuración se activan simultáneamente en subprocesos independientes. El primer respondedor tiene prioridad al compilar la lista de MVPD. Para cada MVPD de la lista, AccessEnabler recuerda la dirección URL del proveedor de servicios asociado. Todas las solicitudes de derechos subsiguientes se dirigen a la URL asociada al proveedor de servicios emparejado con la MVPD de destino durante la fase de configuración.

Disponibilidad: v3.0+

Disponibilidad: v3.0+

Parámetros:

Llamadas de retorno activadas: setRequestorComplete:

Volver al principio…

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

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: establece la identidad del programador. A cada programador se le asigna un ID único al registrarse con el Adobe en el sistema de autenticación de Adobe Pass. Cuando se trata de SSO y tokens remotos, el estado de autenticación puede cambiar cuando la aplicación está en segundo plano. Se puede volver a llamar a setRequestor cuando la aplicación se pone en primer plano para sincronizar con el estado del sistema (recupere un token remoto si está habilitado el SSO o elimine el token local si se ha cerrado la sesión mientras tanto).

La respuesta del servidor contiene una lista de MVPD junto con información de configuración adjunta a la identidad del programador. El código AccessEnabler utiliza internamente la respuesta del servidor. Solo el estado de la operación (es decir, SUCCESS/FAIL) se presenta a su aplicación a través de la llamada de retorno setRequestorComplete:.

Si no se usa el parámetro urls, la llamada de red resultante se dirigirá a la dirección URL del proveedor de servicios predeterminado: el entorno de producción/VERSIÓN de Adobe.

Si se proporciona un valor para el parámetro urls, la llamada de red resultante se dirigirá a todas las direcciones URL proporcionadas en el parámetro urls. Todas las solicitudes de configuración se activan simultáneamente en subprocesos independientes. El primer respondedor tiene prioridad al compilar la lista de MVPD. Para cada MVPD de la lista, AccessEnabler recuerda la dirección URL del proveedor de servicios asociado. Todas las solicitudes de derechos subsiguientes se dirigen a la URL asociada al proveedor de servicios emparejado con la MVPD de destino durante la fase de configuración.

Disponibilidad: v1.0+ Hasta: v3.0

Disponibilidad: v1.0+ Hasta: v3.0

Parámetros:

Notas: Si se llama sin el parámetro serviceProviders, la biblioteca recuperará la configuración del proveedor de servicios predeterminado (es decir, https://sp.auth.adobe.com para el perfil de producción o https://sp.auth-staging.adobe.com para el perfil de ensayo). Si se proporciona el parámetro serviceProviders, debe ser una matriz de direcciones URL. La información de configuración se recupera de todos los extremos especificados y se combina. Si existe información duplicada en diferentes respuestas del proveedor de servicios, el conflicto se resuelve en favor del servidor que responde más rápido (es decir, el servidor con el tiempo de respuesta más corto tiene prioridad).

Llamadas de retorno activadas: setRequestorComplete:

Volver al principio…

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

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: establece la identidad del programador. A cada programador se le asigna un ID único al registrarse con el Adobe en el sistema de autenticación de Adobe Pass. Esta configuración solo debe realizarse una vez durante el ciclo de vida de la aplicación.

La respuesta del servidor contiene una lista de MVPD junto con información de configuración adjunta a la identidad del programador. El código AccessEnabler utiliza internamente la respuesta del servidor. Solo el estado de la operación (es decir, SUCCESS/FAIL) se presenta a su aplicación a través de la llamada de retorno setRequestorComplete:.

Si no se usa el parámetro urls, la llamada de red resultante se dirigirá a la dirección URL del proveedor de servicios predeterminado: el entorno de producción/VERSIÓN de Adobe.

Si se proporciona un valor para el parámetro urls, la llamada de red resultante se dirigirá a todas las direcciones URL proporcionadas en el parámetro urls. Todas las solicitudes de configuración se activan simultáneamente en subprocesos independientes. El primer respondedor tiene prioridad al compilar la lista de MVPD. Para cada MVPD de la lista, AccessEnabler recuerda la dirección URL del proveedor de servicios asociado. Todas las solicitudes de derechos subsiguientes se dirigen a la URL asociada al proveedor de servicios emparejado con la MVPD de destino durante la fase de configuración.

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

Disponibilidad: v2.0+ Hasta: v3.0

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

Disponibilidad: v2.0+ Hasta: v3.0

Parámetros:

Si se llama sin el parámetro serviceProviders, la biblioteca recuperará la configuración del proveedor de servicios predeterminado (es decir, https://sp.auth.adobe.com para el perfil de producción o https://sp.auth-staging.adobe.com para el perfil de ensayo). Si se proporciona el parámetro serviceProviders, debe ser una matriz de direcciones URL. La información de configuración se recupera de todos los extremos especificados y se combina. Si existe información duplicada en diferentes respuestas del proveedor de servicios, el conflicto se resuelve en favor del servidor que responde más rápido (es decir, el servidor con el tiempo de respuesta más corto tiene prioridad).

Llamadas de retorno activadas: setRequestorComplete:

Volver al principio…

setRequestorComplete: setReqComplete

Archivo: AccessEnabler/headers/EntitlementDelegate.h

Descripción La devolución de llamada desencadenada por AccessEnabler informa a la aplicación de que la fase de configuración ha finalizado. Esto indica que la aplicación puede empezar a emitir solicitudes de derechos. La aplicación no puede emitir solicitudes de asignación de derechos hasta que se complete la fase de configuración.

- (void) setRequestorComplete:(int)status;

Disponibilidad: v1.0+

Parámetros:

Activado por:

setRequestor:setSignedRequestorId:, setRequestor:setSignedRequestorId:serviceProviders:

Volver al principio…

checkAuthentication checkAuthN

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: comprueba el estado de autenticación del usuario actual.
Para ello, busca un token de autenticación válido en la biblioteca local de
espacio de almacenamiento de token. Este método no realiza llamadas de red y se recomienda llamarlo en el subproceso principal.
La aplicación la utiliza para consultar el estado de autenticación del usuario y
actualice la interfaz de usuario en consecuencia (es decir, actualice la interfaz de usuario de inicio de sesión/cierre de sesión). El
el estado de autenticación se comunica a la aplicación a través de
la llamada de retorno setAuthenticationStatus:errorCode:.

- (void) checkAuthentication;

Disponibilidad: v1.0+

Parámetros: Ninguno

Llamadas de retorno activadas:
setAuthenticationStatus:errorCode:

Volver al principio…

getAuthentication, getAuthentication:withData: getAuthN

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: inicia el flujo de trabajo de autenticación completo. Se inicia comprobando el estado de autenticación. Si no se ha autenticado ya, se inicia el flujo de autenticación estado-máquina:

A medida que las credenciales del usuario se verifican en la página de inicio de sesión de MVPD, la aplicación debe supervisar las operaciones de redirección múltiples que se producen mientras el usuario se autentica en la página de inicio de sesión de MVPD. Cuando se especifican las credenciales correctas, el control WebView se redirige a una dirección URL personalizada definida por la constante ADOBEPASS_REDIRECT_URL. WebView no pretende cargar esta dirección URL. La aplicación debe interceptar esta URL e interpretar este evento como una señal de que la fase de inicio de sesión ha finalizado. Luego debe entregar el control a AccessEnabler para completar el flujo de autenticación (llamando al método handleExternalURL).

Por último, el estado de autenticación se comunica a la aplicación a través de la llamada de retorno setAuthenticationStatus:errorCode:.

- (void) getAuthentication;

Disponibilidad: v1.0+

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

Disponibilidad: v1.9+

Parámetros:

Llamadas de retorno activadas: setAuthenticationStatus:errorCode:, displayProviderDialog:, sendTrackingData:forEventType:

Volver al principio…

getAuthentication:filter, getAuthentication:withData:andFilter getAuthN_filter

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: inicia el flujo de trabajo de autenticación completo. Se inicia comprobando el estado de autenticación. Si no se ha autenticado ya, se inicia el flujo de autenticación estado-máquina:

Por último, el estado de autenticación se comunica a la aplicación a través de la llamada de retorno setAuthenticationStatus:errorCode:.

Disponibilidad: v2.4+

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

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

Parámetros:

Disponibilidad: v2.0 - v2.3.1

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

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

Parámetros:

Llamadas de retorno activadas: setAuthenticationStatus:errorCode:, presentTvProviderDialog, dismissTvProviderDialog

Volver al principio…

displayProviderDialog: dispProvDialog

Archivo: AccessEnabler/headers/EntitlementDelegate.h

Descripción La llamada de retorno desencadenada por AccessEnabler para informar a la aplicación de que es necesario crear una instancia de los elementos de la interfaz de usuario apropiados para permitir que el usuario seleccione la MVPD deseada. La llamada de retorno proporciona una lista de objetos MVPD con información adicional que puede ayudar a crear correctamente el panel de la interfaz de usuario de selección (como la URL que señala al logotipo de MVPD, un nombre para mostrar descriptivo, etc.)

Una vez que el usuario ha seleccionado la MVPD deseada, la aplicación de capa superior debe reanudar el flujo de autenticación llamando a setSelectedProvider: y pasándole el ID de la MVPD correspondiente a la selección del usuario.

Anulando el flujo de autenticación. En este punto, el usuario tiene la posibilidad de presionar el botón "Atrás", lo que equivale a anular el flujo de autenticación. En ese caso, la aplicación debe llamar al método setSelectedProvider:, pasando null como parámetro, para dar al AccessEnabler la oportunidad de restablecer su equipo de estado de autenticación.

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

Disponibilidad: v1.0+

Parámetros:

Activado por: getAuthentication, getAuthentication:withData:,getAuthorization:, getAuthorization:withData:

Volver al principio…

setSelectedProvider: setSelProv

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: Su aplicación llama a este método para informar al Habilitador de acceso de la selección de MVPD del usuario. La aplicación puede utilizar este método para seleccionar o cambiar el proveedor de servicios utilizado para la autenticación.

Si la MVPD seleccionada es una MVPD TempPass, se autenticará automáticamente con esa MVPD sin necesidad de llamar posteriormente a getAuthentication().

Tenga en cuenta que esto no es posible en el caso del pase temporal promocional, en el que se proporcionan parámetros adicionales en el método getAuthentication().

Al pasar null como parámetro, Access Enabler supone que el usuario ha cancelado el flujo de autenticación (es decir, ha presionado el botón "Atrás"), y responde restableciendo el estado-máquina de autenticación y llamando a la llamada de retorno setAuthenticationStatus:errorCode: con el código de error AccessEnabler.PROVIDER_NOT_SELECTED_ERROR.

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

Disponibilidad: v1.0+

Parámetros: Ninguno

Llamadas de retorno activadas: setAuthenticationStatus:errorCode:, sendTrackingData:forEventType:, navigateToUrl:

Volver al principio…

navigationToUrl: nav2url

Archivo: AccessEnabler/headers/EntitlementDelegate.h

Descripción: La devolución de llamada desencadenada por AccessEnabler para solicitar a su aplicación que cree una instancia de un controlador UIWebView/WKWebView y que cargue la dirección URL proporcionada en el parámetro url de la devolución de llamada. La devolución de llamada pasa el parámetro url que representa la dirección URL del extremo de autenticación o la dirección URL del extremo de cierre de sesión.

A medida que el controlador UIWebView/WKWebView pasa por varias redirecciones, su aplicación debe supervisar la actividad del controlador y detectar el momento en que carga una dirección URL personalizada específica definida por la constante ADOBEPASS_REDIRECT_URL i.e. adobepass://ios.app). Tenga en cuenta que esta dirección URL personalizada específica no es válida y no está pensada para que el controlador la cargue. Su aplicación debe interpretarlo únicamente como una señal de que el flujo de autenticación o cierre de sesión se ha completado y de que es seguro cerrar el controlador. Cuando el controlador carga esta dirección URL personalizada específica, la aplicación debe cerrar UIWebView/WKWebView y llamar al método de API handleExternalURL:url de AccessEnabler.

Nota: Tenga en cuenta que en el caso del flujo de autenticación, este es un punto en el que el usuario tiene la capacidad de presionar el botón "Atrás", lo que equivale a anular el flujo de autenticación. En este caso, la aplicación debe llamar al método setSelectedProvider: pasando nil como parámetro y dando la oportunidad al AccessEnabler de restablecer su equipo de estado de autenticación.

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

Disponibilidad: v1.0+

Parámetros:

Activado por: setSelectedProvider:

Volver al principio…

navigateToUrl:useSVC: nav2urlSVC

Archivo: AccessEnabler/headers/EntitlementDelegate.h

Descripción: La devolución de llamada se activó mediante AccessEnabler en lugar de la devolución de llamada navigateToUrl: en el caso de que la aplicación habilitara previamente la administración manual de Safari View Controller (SVC) mediante la llamada setOptions(["handleSVC":true"]), y solo en el caso de las MVPD que requieran Safari View Controller (SVC). Para todas las demás MVPD se llamará a la devolución de llamada navigateToUrl:. Consulte la compatibilidad con SFSafariViewController en el SDK 3.2+ de iOS para obtener detalles sobre cómo se debe administrar Safari View Controller (SVC).

De forma similar a la llamada de retorno navigateToUrl:, AccessEnabler activa la llamada navigateToUrl:useSVC: para solicitar a su aplicación que cree una instancia de un controlador SFSafariViewController y que cargue la URL proporcionada en el parámetro url de la llamada de retorno. La devolución de llamada pasa el parámetro url que representa la dirección URL del extremo de autenticación o la dirección URL del extremo de cierre de sesión, y el parámetro useSVC que especifica que la aplicación debe usar un SFSafariViewController.

A medida que el controlador SFSafariViewController pasa por varias redirecciones, su aplicación debe supervisar la actividad del controlador y detectar el momento en que carga una dirección URL personalizada específica definida por su application's custom scheme (por ejemplo **​ **adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com). Tenga en cuenta que esta dirección URL personalizada específica no es válida y no está pensada para que el controlador la cargue. Su aplicación debe interpretarlo únicamente como una señal de que el flujo de autenticación o cierre de sesión se ha completado y de que es seguro cerrar el controlador. Cuando el controlador carga esta dirección URL personalizada específica, la aplicación debe cerrar SFSafariViewController y llamar al método de API handleExternalURL:url de AccessEnabler.

Nota: Tenga en cuenta que en el caso del flujo de autenticación, este es un punto en el que el usuario tiene la capacidad de presionar el botón "Atrás", lo que equivale a anular el flujo de autenticación. En este caso, la aplicación debe llamar al método setSelectedProvider: pasando nil como parámetro y dando la oportunidad al AccessEnabler de restablecer su equipo de estado de autenticación.

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

Disponibilidad: ​v 3.2+

Parámetros:

Activado por: ​ setOptions: antes de setSelectedProvider:

Volver al principio…

handleExternalURL:url handleExternalURL

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: su aplicación llama a este método para completar el flujo de autenticación o cierre de sesión. Se debe llamar a este método justo después de que la aplicación detecte el momento en que se redirige el controlador UIWebView/WKWebView or SFSafariViewController a una dirección URL personalizada específica. Si la aplicación necesita usar un controlador SFSafariViewController la dirección URL personalizada específica está definida por su application's custom scheme (p. ej.adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com); de lo contrario, esta dirección URL personalizada específica está definida por la constante ADOBEPASS_REDIRECT_URL es decir, adobepass://ios.app.

En el caso del flujo de autenticación, AccessEnabler completa el flujo recuperando el token de autenticación del servidor back-end y almacenándolo localmente en el almacenamiento de tokens. AccessEnabler informará a su aplicación de que el flujo de autenticación se ha completado llamando a la devolución de llamada setAuthenticationStatus() con un código de estado de 1, lo que indica que se ha realizado correctamente. Si hay un error durante la ejecución de estos pasos, la llamada de retorno setAuthenticationStatus() se activa con un código de estado de 0, lo que indica un error de autenticación, así como un código de error correspondiente.

 (void) handleExternalURL:(NSString *)url;

Disponibilidad: v3.0+

Parámetros:

Llamadas de retorno activadas: setAuthenticationStatus:errorCode, sendTrackingData:forEventType:

Volver al principio…

getAuthenticationToken - [OBSOLETO] getAuthNToken

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: completa el flujo de autenticación al solicitar el token de autenticación del servidor back-end. Su aplicación debería llamar a este método únicamente en respuesta a un evento en el que el control WebView que aloja la página de inicio de sesión de MVPD se redirija a la dirección URL personalizada definida por la constante ADOBEPASS_REDIRECT_URL.

- (void) getAuthenticationToken;

Disponibilidad: v1.0+ Hasta: v3.0

Parámetros: Ninguno

Llamadas de retorno activadas: setAuthenticationStatus:errorCode,sendTrackingData:forEventType:

Volver al principio…

</br

setAuthenticationStatus:errorCode: setAuthNStatus

Archivo: AccessEnabler/headers/EntitlementDelegate.h

Descripción La llamada de retorno desencadenada por AccessEnabler informa a la aplicación del estado del flujo de autenticación. Hay muchos lugares donde este flujo puede fallar, ya sea como resultado de la interacción del usuario o debido a otros escenarios imprevistos (es decir, problemas de conectividad de red, etc.). Esta llamada de retorno informa a la aplicación del estado de éxito/error del flujo de autenticación, a la vez que proporciona información adicional sobre el motivo del error, cuando es necesario.

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

Disponibilidad: v1.0+

Parámetros:

Activado por: checkAuthentication, getAuthentication, getAuthentication:withData:, checkAuthorization:, checkAuthorization:withData:

Volver al principio…

checkPreauthorizedResources: checkPreauth

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: La aplicación utiliza este método para determinar si el usuario ya tiene autorización para ver recursos protegidos específicos. El propósito principal de este método es recuperar información para utilizarla en la decoración de la interfaz de usuario (por ejemplo, para indicar el estado de acceso con los iconos de bloqueo y desbloqueo).

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

Disponibilidad: v1.3+

Parámetros:

Devolución de llamada desencadenada: preauthorizedResources:

Volver al principio…

checkPreauthorizedResources:cache: checkPreauthCache

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: La aplicación utiliza este método para determinar si el usuario ya tiene autorización para ver recursos protegidos específicos. El propósito principal de este método es recuperar información para utilizarla en la decoración de la interfaz de usuario (por ejemplo, para indicar el estado de acceso con los iconos de bloqueo y desbloqueo). El parámetro cache controla si la caché interna se usa para resolver recursos.

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

Disponibilidad: v3.1+

Parámetros:

Devolución de llamada desencadenada: preauthorizedResources:

Volver al principio…

preauthorizedResources: preauthResources

Archivo: AccessEnabler/headers/EntitlementDelegate.h

Descripción: Llamada de retorno desencadenada por checkPreauthorizedResources:. Proporciona una lista de recursos que el usuario ya tiene autorización para ver.

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

Disponibilidad: v1.3+

Parámetros:

Activado por: checkPreauthorizedResources:

Volver al principio…

checkAuthorization:, checkAuthorization:withData: checkAuthZ

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: La aplicación utiliza este método para comprobar el estado de autorización. Se inicia comprobando primero el estado de autenticación. Si no se autentica, se activa la devolución de llamada tokenRequestFailed:errorCode:errorDescription: y se cierra el método. Si el usuario está autenticado, también almacena en déclencheur el flujo de autorización. Ver detalles del método getAuthorization:.

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

Disponibilidad: v1.0+

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

Disponibilidad: v1.9+

Parámetros:

Llamadas de retorno activadas:

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

Volver al principio…

getAuthorization:, getAuthorization:withData: getAuthZ

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: La aplicación utiliza este método para iniciar el flujo de autorización. Si el usuario aún no se ha autenticado, también inicia el flujo de autenticación. Si el usuario se autentica, AccessEnabler procede a emitir solicitudes para el token de autorización (si no hay ningún token de autorización válido en la caché de token local) y para el token de medios de corta duración. Una vez obtenido el token de medios corto, el flujo de autorización se considera completo. La llamada de retorno setToken:forResource: se activa y el token de medios corto se entrega como parámetro a la aplicación. Si, por cualquier motivo, la autorización falla, la llamada de retorno de tokenRequestFailed:forEventType: se activa y se proporcionan el código o los detalles del error.

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

Disponibilidad: v1.0+

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

Disponibilidad: v1.9+

Parámetros:

Llamadas de retorno activadas: tokenRequestFailed:errorCode:errorDescription:, setToken:forResource:,sendTrackingData:forEventType:

Se desencadenaron llamadas de retorno adicionales:
Este método también puede almacenar en déclencheur las siguientes llamadas de retorno (si también se inicia el flujo de autenticación): setAuthenticationStatus:errorCode:, displayProviderDialog:

Volver al principio…

setToken:forResource: setToken

Archivo: AccessEnabler/headers/EntitlementDelegate.h

Descripción La llamada de retorno desencadenada por AccessEnabler informa a la aplicación de que el flujo de autorización se completó correctamente. El token de medios de corta duración también se entrega como parámetro.

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

Disponibilidad: v1.0+

Parámetros:

Activado por: checkAuthorization:, checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:

Volver al principio…

tokenRequestFailed:errorCode:errorDescription: tokenReqFailed

Archivo: AccessEnabler/headers/EntitlementDelegate.h

Descripción Llamada de retorno desencadenada por AccessEnabler que informa a la aplicación de capa superior de que el flujo de autorización ha fallado.

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

Disponibilidad: v1.0+

Parámetros:

Activado por: checkAuthorization:, checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:

Volver al principio…

cierre de sesión logout

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: su aplicación llama a este método para iniciar el flujo de cierre de sesión. El cierre de sesión es el resultado de una serie de operaciones de redirección HTTP debido al hecho de que el usuario debe cerrar la sesión tanto desde los servidores de autenticación de Adobe Pass como desde los servidores de MVPD. Dado que este flujo no se puede completar con una simple solicitud HTTP emitida por la biblioteca AccessEnabler, es necesario crear una instancia de un controlador UIWebView/WKWebView or SFSafariViewController para poder seguir las operaciones de redirección HTTP.

El flujo de cierre de sesión difiere del flujo de autenticación en que el usuario no tiene que interactuar con el controlador UIWebView/WKWebView or SFSafariViewController de ninguna manera. Por lo tanto, Adobe recomienda hacer que el control sea invisible (es decir, oculto) durante el proceso de cierre de sesión.

Se utiliza un patrón similar al flujo de autenticación. El AccessEnabler de iOS déclencheur la llamada de retorno navigateToUrl: o navigateToUrl:useSVC: para crear un controlador UIWebView/WKWebView or SFSafariViewController y cargar la URL proporcionada en el parámetro url de la llamada de retorno. Dirección URL del extremo de cierre de sesión en el servidor back-end. Para el AccessEnabler de tvOS, no se llama ni a la devolución de llamada navigateToUrl: ni a la devolución de llamada navigateToUrl:useSVC:.

A medida que pasa por varias redirecciones, la aplicación debe supervisar la actividad del controlador UIWebView/WKWebView or SFSafariViewController y detectar el momento en que carga una dirección URL personalizada específica. Tenga en cuenta que esta dirección URL personalizada específica no es válida y no está pensada para que el controlador la cargue. Su aplicación debe interpretarlo únicamente como una señal de que el flujo de cierre de sesión se ha completado y de que es seguro cerrar el controlador. Cuando el controlador carga esta dirección URL personalizada específica, la aplicación debe cerrar el controlador y llamar al método de API handleExternalURL:url de AccessEnabler. Si la aplicación necesita usar un controlador SFSafariViewController la dirección URL personalizada específica está definida por su application's custom scheme (p. ej.adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com); de lo contrario, esta dirección URL personalizada específica está definida por la constante ADOBEPASS_REDIRECT_URL es decir, adobepass://ios.app.

Al final, AccessEnabler llamará a la llamada de retorno setAuthenticationStatus() con un código de estado de 0, lo que indica que el flujo de cierre de sesión se ha realizado correctamente.

Nota: Si el usuario ha iniciado sesión con Apple SSO, se activará el estado de VSA203. En este caso, se debe indicar al usuario que también cierre la sesión desde la configuración del sistema. Si no se hace esto, se volverá a autenticar cuando se reinicie la aplicación.

- (void) logout;

Disponibilidad: v1.0+

Parámetros: Ninguno

Llamadas de retorno activadas: navigateToUrl:, setAuthenticationStatus:errorCode:

Volver al principio…

getSelectedProvider getSelProv

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: Utilice este método para determinar el proveedor seleccionado actualmente.

- (void) getSelectedProvider;

Disponibilidad: v1.0+

Parámetros: Ninguno

Llamadas de retorno activadas: selectedProvider:

Volver al principio…

selectedProvider selProv

Archivo: AccessEnabler/headers/EntitlementDelegate.h

Descripción La llamada de retorno desencadenada por AccessEnabler que envía información sobre la MVPD seleccionada actualmente a la aplicación.

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

Disponibilidad: v1.0+

Parámetros:

Activado por: getSelectedProvider

Volver al principio…

getMetadata: getMeta

Archivo: AccessEnabler/headers/AccessEnabler.h

Descripción: Utilice este método para recuperar información expuesta como metadatos por la biblioteca AccessEnabler. La aplicación puede obtener acceso a estos datos proporcionando un parámetro de entrada key basado en diccionario.

Hay dos tipos de metadatos disponibles para los programadores:

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

Disponibilidad: v1.0+

Parámetros:

Llamadas de retorno activadas: setMetadataStatus:encrypted:forKey:andArguments:

Más información: Metadatos de usuario

Volver al principio…

presentTVProviderDialog presentTvDialog

Archivo: AccessEnabler/headers/EntitlementDelegate.h

Descripción La llamada de retorno desencadenada por AccessEnabler después de llamar agetAuthentication() si el solicitante actual admite al menos una MVPD compatible con SSO.

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

Disponibilidad: v2.0+

Parámetros:

Activado por: getAuthentication

Más información: Inicio de sesión único de iOS/tvOS

Volver al principio…

dismissTVProviderDialog dismissTvDialog

Archivo: AccessEnabler/headers/EntitlementDelegate.h

Descripción La llamada de retorno desencadenada por AccessEnabler después de que el usuario cierre el cuadro de diálogo de SSO de Apple.

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

Disponibilidad: v2.0+

Parámetros:

Desencadenado por: acción del usuario

Más información: Inicio de sesión único de iOS/tvOS

Volver al principio…

setMetadataStatus:encrypted:forKey:andArguments: setMetaStatus

Archivo: AccessEnabler/headers/EntitlementDelegate.h

Descripción La llamada de retorno desencadenada por AccessEnabler que entrega los metadatos solicitados mediante una llamada de getMetadata:.

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

Disponibilidad: v1.0+

Parámetros:

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

Activado por: getMetadata:

Más información: Metadatos de usuario

Volver al principio…

MVPD mvpd

Archivo: AccessEnabler/headers/model/MVPD.h

Descripción Describe el objeto MVPD. Se puede utilizar para obtener información sobre las propiedades de la MVPD.

Disponibilidad: v1.0+ [La propiedad boardingStatus está disponible en v2.2]

Propiedades:

Volver al principio…

Seguimiento de eventos tracking

AccessEnabler almacena en déclencheur una llamada de retorno adicional que no está necesariamente relacionada con los flujos de derechos. La implementación de la función de devolución de llamada sendTrackingData() es opcional, pero permite a la aplicación realizar un seguimiento de eventos específicos y compilar estadísticas como el número de intentos de autenticación/autorización correctos/fallidos.

sendTrackingData sendTracking

Archivo: AccessEnabler/headers/EntitlementDelegate.h

Descripción La llamada de retorno desencadenada por AccessEnabler indica a la aplicación la ocurrencia de varios eventos, como la finalización o el error de los flujos de autenticación o autorización. Con la autenticación de Adobe Pass 1.6, el tipo de dispositivo, el tipo de cliente de AccessEnabler y el sistema operativo se registran en sendTrackingData(). La llamada de retorno sendTrackingData() sigue siendo compatible con versiones anteriores.

Llamada de retorno: seguimiento de eventos

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

Disponibilidad: v1.0+

Nota: El tipo de dispositivo y el sistema operativo se derivan mediante el uso de una biblioteca Java pública (http://java.net/projects/user-agent-utils) y la cadena del agente de usuario. Tenga en cuenta que esta información se proporciona solo como una forma grosera de desglosar las métricas operativas en categorías de dispositivos, pero que ese Adobe no puede responsabilizarse de los resultados incorrectos. Utilice la nueva funcionalidad en consecuencia.

Parámetros:

Activado por: checkAuthentication, getAuthentication, getAuthentication:withData:, checkAuthorization:, checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:, setSelectedProvider:

Instrucciones para interpretar los valores de la matriz data: