Referência de API do SDK do iOS/tvOS iostvos-sdk-api-reference

Introdução intro

Esta página descreve os métodos e as funções de retorno de chamada expostos pelo cliente nativo do iOS/tvOS para autenticação da Adobe Pass. Os métodos e as funções de retorno de chamada descritos aqui estão definidos nos arquivos de cabeçalho AccessEnabler.h e EntitlementDelegate.h; você pode encontrá-los no SDK do iOS AccessEnabler aqui: [SDK directory]/AccessEnabler/headers/api/

Documentação associada:

Referência da API apis

init:softwareStatement initWithSoftwareStatement

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: Instancia o objeto AccessEnabler. Deve haver uma única instância AccessEnabler por instância do aplicativo.

Disponibilidade: v3.0+

Parâmetros:

Voltar ao início…

init - [DEPRECATED] init

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: Instancia o objeto AccessEnabler. Deve haver uma única instância AccessEnabler por instância do aplicativo.

Disponibilidade: v1.0+ Até: v3.0

Parâmetros: Nenhum

Voltar ao início…

setOptions:opções setOptions

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: Configura as opções globais do SDK. Ele aceita um NSDictionary como argumento. Os valores do dicionário serão passados para o servidor junto com cada chamada de rede feita pelo SDK.

Observação: os valores serão passados ao servidor independentemente do fluxo atual (autenticação/autorização). Se quiser alterar os valores, você pode chamar esse método a qualquer momento.

Disponibilidade: v2.3.0+

Parâmetros:

Voltar ao início…

setRequestor:requestorID, setRequestor:requestorID:serviceProviders: setReqV3

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: Define a identidade do Programador. Cada programador recebe uma ID exclusiva ao se registrar no Adobe para o sistema de autenticação da Adobe Pass. Ao lidar com SSO e tokens remotos, o estado de autenticação pode mudar quando o aplicativo estiver em segundo plano, setRequestor pode ser chamado novamente quando o aplicativo for trazido para o primeiro plano para sincronizar com o estado do sistema (busque um token remoto se o SSO estiver ativado ou exclua o token local se um logout tiver ocorrido enquanto isso).

A resposta do servidor contém uma lista de MVPDs juntamente com algumas informações de configuração anexadas à identidade do Programador. A resposta do servidor é usada internamente pelo código AccessEnabler. Somente o status da operação (ou seja, SUCESSO/FALHA) é apresentado ao seu aplicativo por meio do retorno de chamada setRequestorComplete:.

Se o parâmetro urls não for usado, a chamada de rede resultante será direcionada para a URL do provedor de serviços padrão: o ambiente de Adobe RELEASE/produção.

Se um valor for fornecido para o parâmetro urls, a chamada de rede resultante será direcionada a todas as URLs fornecidas no parâmetro urls. Todas as solicitações de configuração são acionadas simultaneamente em threads separados. O primeiro respondente tem prioridade ao compilar a lista de MVPDs. Para cada MVPD na lista, o AccessEnabler lembra o URL do provedor de serviços associado. Todas as solicitações de direito subsequentes são direcionadas ao URL associado ao provedor de serviços que foi emparelhado com o MVPD de destino durante a fase de configuração.

Disponibilidade: v3.0+

Disponibilidade: v3.0+

Parâmetros:

Retornos de chamada disparados: setRequestorComplete:

Voltar ao início…

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

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: Define a identidade do Programador. Cada programador recebe uma ID exclusiva ao se registrar no Adobe para o sistema de autenticação da Adobe Pass. Ao lidar com SSO e tokens remotos, o estado de autenticação pode mudar quando o aplicativo estiver em segundo plano, setRequestor pode ser chamado novamente quando o aplicativo for colocado em primeiro plano para sincronizar com o estado do sistema (busque um token remoto se o SSO estiver habilitado ou exclua o token local se um logout tiver ocorrido enquanto isso).

A resposta do servidor contém uma lista de MVPDs juntamente com algumas informações de configuração anexadas à identidade do Programador. A resposta do servidor é usada internamente pelo código AccessEnabler. Somente o status da operação (ou seja, SUCESSO/FALHA) é apresentado ao seu aplicativo por meio do retorno de chamada setRequestorComplete:.

Se o parâmetro urls não for usado, a chamada de rede resultante será direcionada para a URL do provedor de serviços padrão: o ambiente de Adobe RELEASE/produção.

Se um valor for fornecido para o parâmetro urls, a chamada de rede resultante será direcionada a todas as URLs fornecidas no parâmetro urls. Todas as solicitações de configuração são acionadas simultaneamente em threads separados. O primeiro respondente tem prioridade ao compilar a lista de MVPDs. Para cada MVPD na lista, o AccessEnabler lembra o URL do provedor de serviços associado. Todas as solicitações de direito subsequentes são direcionadas ao URL associado ao provedor de serviços que foi emparelhado com o MVPD de destino durante a fase de configuração.

Disponibilidade: v1.0+ Até: v3.0

Disponibilidade: v1.0+ Até: v3.0

Parâmetros:

Observações: Se chamada sem o parâmetro serviceProviders, a biblioteca recuperará a configuração do provedor de serviços padrão (ou seja, https://sp.auth.adobe.com para o perfil de produção ou https://sp.auth-staging.adobe.com para o perfil de preparo). Se o parâmetro serviceProviders for fornecido, ele deverá ser uma matriz de URLs. As informações de configuração são recuperadas de todos os endpoints especificados e são mescladas. Se houver informações duplicadas em diferentes respostas do provedor de serviços, o conflito será resolvido em favor do servidor com resposta mais rápida (ou seja, o servidor com o menor tempo de resposta tem prioridade).

Retornos de chamada disparados: setRequestorComplete:

Voltar ao início…

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

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: Define a identidade do Programador. Cada programador recebe uma ID exclusiva ao se registrar no Adobe para o sistema de autenticação da Adobe Pass. Esta configuração deve ser executada somente uma vez durante o ciclo de vida do aplicativo.

A resposta do servidor contém uma lista de MVPDs juntamente com algumas informações de configuração anexadas à identidade do Programador. A resposta do servidor é usada internamente pelo código AccessEnabler. Somente o status da operação (ou seja, SUCESSO/FALHA) é apresentado ao seu aplicativo por meio do retorno de chamada setRequestorComplete:.

Se o parâmetro urls não for usado, a chamada de rede resultante será direcionada para a URL do provedor de serviços padrão: o ambiente de Adobe RELEASE/produção.

Se um valor for fornecido para o parâmetro urls, a chamada de rede resultante será direcionada a todas as URLs fornecidas no parâmetro urls. Todas as solicitações de configuração são acionadas simultaneamente em threads separados. O primeiro respondente tem prioridade ao compilar a lista de MVPDs. Para cada MVPD na lista, o AccessEnabler lembra o URL do provedor de serviços associado. Todas as solicitações de direito subsequentes são direcionadas ao URL associado ao provedor de serviços que foi emparelhado com o MVPD de destino durante a fase de configuração.

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

Disponibilidade: v2.0+ Até: v3.0

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

Disponibilidade: v2.0+ Até: v3.0

Parâmetros:

Se chamada sem o parâmetro serviceProviders, a biblioteca recuperará a configuração do provedor de serviços padrão (ou seja, https://sp.auth.adobe.com para o perfil de produção ou https://sp.auth-staging.adobe.com para o perfil de preparo). Se o parâmetro serviceProviders for fornecido, ele deverá ser uma matriz de URLs. As informações de configuração são recuperadas de todos os endpoints especificados e são mescladas. Se houver informações duplicadas em diferentes respostas do provedor de serviços, o conflito será resolvido em favor do servidor com resposta mais rápida (ou seja, o servidor com o menor tempo de resposta tem prioridade).

Retornos de chamada disparados: setRequestorComplete:

Voltar ao início…

setRequestorComplete: setReqComplete

Arquivo: AccessEnabler/headers/EntitlementDelegate.h

Descrição Retorno de chamada disparado pelo AccessEnabler que informa ao aplicativo que a fase de configuração foi concluída. Esse é um sinal de que o aplicativo pode começar a emitir solicitações de direito. Nenhuma solicitação de direito pode ser emitida pelo aplicativo até que a fase de configuração seja concluída.

- (void) setRequestorComplete:(int)status;

Disponibilidade: v1.0+

Parâmetros:

Acionado por:

setRequestor:setSignedRequestorId:, setRequestor:setSignedRequestorId:serviceProviders:

Voltar ao início…

checkAuthentication checkAuthN

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: verifica o status de autenticação do usuário atual.
Ele faz isso procurando um token de autenticação válido no local
espaço de armazenamento de token. Esse método não executa chamadas de rede e recomendamos chamá-lo na thread principal.
Ele é usado pelo aplicativo para consultar o status de autenticação do usuário e
atualizar a interface de acordo (ou seja, atualizar a interface de logon/logout). A variável
o status de autenticação é comunicado ao aplicativo por meio de
o retorno de chamada setAuthenticationStatus:errorCode:.

- (void) checkAuthentication;

Disponibilidade: v1.0+

Parâmetros: Nenhum

Retornos de chamada disparados:
setAuthenticationStatus:errorCode:

Voltar ao início…

getAuthentication, getAuthentication:withData: getAuthN

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: inicia o fluxo de trabalho de autenticação completa. Ele é iniciado verificando o status de autenticação. Se ainda não estiver autenticado, a máquina de estado do fluxo de autenticação é iniciada:

À medida que as credenciais do usuário são verificadas na página de logon do MVPD, sua aplicação é solicitada a monitorar as várias operações de redirecionamento que ocorrem enquanto o usuário é autenticado na página de logon do MVPD. Quando as credenciais corretas são inseridas, o controle WebView é redirecionado para uma URL personalizada definida pela constante ADOBEPASS_REDIRECT_URL. Este URL não deve ser carregado pelo WebView. O aplicativo deve interceptar esse URL e interpretar esse evento como um sinal de que a fase de logon foi concluída. Em seguida, ele deve entregar o controle ao AccessEnabler para concluir o fluxo de autenticação (chamando o método handleExternalURL).

Finalmente, o status de autenticação é comunicado ao aplicativo por meio do retorno de chamada setAuthenticationStatus:errorCode:.

- (void) getAuthentication;

Disponibilidade: v1.0+

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

Disponibilidade: v1.9+

Parâmetros:

Retornos de chamada disparados: setAuthenticationStatus:errorCode:, displayProviderDialog:, sendTrackingData:forEventType:

Voltar ao início…

getAuthentication:filter, getAuthentication:withData:andFilter getAuthN_filter

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: inicia o fluxo de trabalho de autenticação completa. Ele é iniciado verificando o status de autenticação. Se ainda não estiver autenticado, a máquina de estado do fluxo de autenticação é iniciada:

Finalmente, o status de autenticação é comunicado ao aplicativo por meio do retorno de chamada setAuthenticationStatus:errorCode:.

Disponibilidade: v2.4+

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

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

Parâmetros:

Disponibilidade: v2.0 - v2.3.1

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

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

Parâmetros:

Retornos de chamada disparados: setAuthenticationStatus:errorCode:, presentTvProviderDialog, dismissTvProviderDialog

Voltar ao início…

displayProviderDialog: dispProvDialog

Arquivo: AccessEnabler/headers/EntitlementDelegate.h

Descrição Retorno de chamada disparado pelo AccessEnabler para informar ao aplicativo que os elementos apropriados da interface do usuário precisam ser instanciados para permitir que o usuário selecione o MVPD desejado. O retorno de chamada fornece uma lista de objetos MVPD com informações adicionais que podem ajudar a criar corretamente o painel da interface de seleção (como o URL que aponta para o logotipo do MVPD, nome de exibição amigável etc.)

Depois que o usuário selecionar o MVPD desejado, o aplicativo de camada superior deverá retomar o fluxo de autenticação chamando setSelectedProvider: e transmitindo a ID do MVPD correspondente à seleção do usuário.

Anulando o fluxo de autenticação - Este é um ponto em que o usuário pode pressionar o botão "Voltar", o que é equivalente a anular o fluxo de autenticação. Nesse cenário, o aplicativo deve chamar o método setSelectedProvider:, transmitindo nulo como parâmetro, para dar ao AccessEnabler a oportunidade de redefinir seu computador de estado de autenticação.

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

Disponibilidade: v1.0+

Parâmetros:

Acionado por: getAuthentication, getAuthentication:withData:,getAuthorization:, getAuthorization:withData:

Voltar ao início…

setSelectedProvider: setSelProv

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: Esse método é chamado pelo seu aplicativo para informar ao Ativador de Acesso a seleção de MVPD do usuário. O aplicativo pode usar esse método para selecionar ou alterar o provedor de serviços usado para autenticação.

Se o MVPD selecionado for um MVPD TempPass, ele será autenticado automaticamente com esse MVPD sem precisar chamar getAuthentication() posteriormente.

Observe que isso não é possível para a Passagem Temp Promocional, onde parâmetros extras são fornecidos no método getAuthentication().

Ao passar null como parâmetro, o Habilitador de Acesso presume que o usuário cancelou o fluxo de autenticação (ou seja, pressionou o botão "Voltar") e responde redefinindo a máquina de estado de autenticação e chamando a chamada de retorno setAuthenticationStatus:errorCode: com o código de erro AccessEnabler.PROVIDER_NOT_SELECTED_ERROR.

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

Disponibilidade: v1.0+

Parâmetros: Nenhum

Retornos de chamada disparados: setAuthenticationStatus:errorCode:,sendTrackingData:forEventType:, navigateToUrl:

Voltar ao início…

navigateToUrl: nav2url

Arquivo: AccessEnabler/headers/EntitlementDelegate.h

Descrição: Retorno de chamada disparado pelo AccessEnabler para solicitar que seu aplicativo instancie um controlador UIWebView/WKWebView e para carregar a URL fornecida no parâmetro url do retorno de chamada. O retorno de chamada passa o parâmetro url, que representa a URL do ponto de extremidade de autenticação ou a URL do ponto de extremidade de logout.

Como o controlador UIWebView/WKWebView passa por vários redirecionamentos, seu aplicativo deve monitorar a atividade do controlador e detectar o momento em que carrega uma URL personalizada específica definida pela constante ADOBEPASS_REDIRECT_URL (ou seja, adobepass://ios.app). Observe que esse URL personalizado específico é realmente inválido e não se destina ao controlador para carregá-lo. Ela deve ser interpretada somente pelo seu aplicativo como um sinal de que o fluxo de autenticação ou logout foi concluído e que é seguro fechar a controladora. Quando o controlador carrega esta URL personalizada específica, seu aplicativo deve fechar UIWebView/WKWebView e chamar o método handleExternalURL:url API do AccessEnabler.

Observação: observe que, no caso do fluxo de autenticação, esse é um ponto em que o usuário pode pressionar o botão "Voltar", o que equivale à anulação do fluxo de autenticação. Nesse cenário, o aplicativo deve chamar o método setSelectedProvider: transmitindo nil como parâmetro e dando ao AccessEnabler a chance de redefinir seu computador de estado de autenticação.

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

Disponibilidade: v1.0+

Parâmetros:

Acionado por: setSelectedProvider:

Voltar ao início…

navigateToUrl:useSVC: nav2urlSVC

Arquivo: AccessEnabler/headers/EntitlementDelegate.h

Descrição: Retorno de chamada disparado pelo AccessEnabler em vez do retorno de chamada navigateToUrl: caso seu aplicativo tenha habilitado anteriormente o controle manual do Safari View Controller (SVC) por meio da chamada setOptions(["handleSVC":true"]), e somente no caso de MVPDs que exigem o Safari View Controller (SVC). Para todos os outros MVPDs, o retorno de chamada navigateToUrl: será chamado. ConsulteSuporte a SFSafariViewController no iOS SDK 3.2+ para obter detalhes sobre como o Safari View Controller (SVC) deve ser gerenciado.

Semelhante ao retorno de chamada navigateToUrl:, o navigateToUrl:useSVC: é acionado pelo AccessEnabler para solicitar que seu aplicativo instancie um controlador SFSafariViewController e carregue a URL fornecida no parâmetro url do retorno de chamada. O retorno de chamada passa o parâmetro url, que representa a URL do ponto de extremidade de autenticação ou a URL do ponto de extremidade de logout, e o parâmetro useSVC, que especifica que o aplicativo deve usar um SFSafariViewController.

À medida que o controlador SFSafariViewController passa por vários redirecionamentos, seu aplicativo deve monitorar a atividade do controlador e detectar o momento em que carrega um URL personalizado específico definido pelo seu application's custom scheme (por exemplo,**​ **adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com). Observe que esse URL personalizado específico é realmente inválido e não se destina ao controlador para carregá-lo. Ela deve ser interpretada somente pelo seu aplicativo como um sinal de que o fluxo de autenticação ou logout foi concluído e que é seguro fechar a controladora. Quando o controlador carrega esta URL personalizada específica, seu aplicativo deve fechar o SFSafariViewController e chamar o método de API handleExternalURL:url do AccessEnabler.

Observação: observe que, no caso do fluxo de autenticação, esse é um ponto em que o usuário pode pressionar o botão "Voltar", o que equivale à anulação do fluxo de autenticação. Nesse cenário, o aplicativo deve chamar o método setSelectedProvider: transmitindo nil como parâmetro e dando ao AccessEnabler a chance de redefinir seu computador de estado de autenticação.

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

Disponibilidade: ​v 3.2+

Parâmetros:

Acionado por: ​ setOptions: antes de setSelectedProvider:

Voltar ao início…

handleExternalURL:url handleExternalURL

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: Este método é chamado pelo aplicativo para concluir o fluxo de autenticação ou logout. Este método deve ser chamado logo após o aplicativo detectar o momento em que o controlador UIWebView/WKWebView or SFSafariViewController é redirecionado para um URL personalizado específico. Caso seu aplicativo precise usar um controlador SFSafariViewController , a URL personalizada específica é definida por seu application's custom scheme (por exemplo, adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com); caso contrário, essa URL personalizada específica é definida pela constante ADOBEPASS_REDIRECT_URL (por exemplo, adobepass://ios.app).

No caso do fluxo de autenticação, o AccessEnabler conclui o fluxo recuperando o token de autenticação do servidor back-end e armazenando-o localmente no armazenamento de token. O AccessEnabler informará ao aplicativo que o fluxo de autenticação foi concluído, chamando o retorno de chamada setAuthenticationStatus() com um código de status 1, indicando sucesso. Se houver um erro durante a execução dessas etapas, o retorno de chamada setAuthenticationStatus() será disparado com um código de status 0, indicando falha de autenticação, bem como um código de erro correspondente.

 (void) handleExternalURL:(NSString *)url;

Disponibilidade: v3.0+

Parâmetros:

Retornos de chamada disparados: setAuthenticationStatus:errorCode, sendTrackingData:forEventType:

Voltar ao início…

getAuthenticationToken - [DEPRECATED] getAuthNToken

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: conclui o fluxo de autenticação solicitando o token de autenticação do servidor back-end. Esse método deve ser chamado pelo aplicativo somente em resposta ao evento em que o controle WebView que hospeda a página de logon MVPD é redirecionado para a URL personalizada definida pela constante ADOBEPASS_REDIRECT_URL.

- (void) getAuthenticationToken;

Disponibilidade: v1.0+ Até: v3.0

Parâmetros: Nenhum

Retornos de chamada disparados: setAuthenticationStatus:errorCode,sendTrackingData:forEventType:

Voltar ao início…

</br

setAuthenticationStatus:errorCode: setAuthNStatus

Arquivo: AccessEnabler/headers/EntitlementDelegate.h

Descrição Retorno de chamada disparado pelo AccessEnabler que informa ao aplicativo o status do fluxo de autenticação. Há muitos lugares onde esse fluxo pode falhar, seja como resultado da interação do usuário ou devido a outros cenários imprevistos (ou seja, problemas de conectividade de rede etc.). Essa chamada de retorno informa a aplicação do status de sucesso/falha do fluxo de autenticação, além de fornecer informações adicionais sobre o motivo da falha, quando necessário.

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

Disponibilidade: v1.0+

Parâmetros:

Acionado por: checkAuthentication, getAuthentication, getAuthentication:withData:, checkAuthorization:, checkAuthorization:withData:

Voltar ao início…

checkPreauthorizedResources: checkPreauth

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: Este método é usado pelo aplicativo para determinar se o usuário já está autorizado a exibir recursos protegidos específicos. A principal finalidade deste método é recuperar informações para uso na decoração da interface do usuário (por exemplo, indicando o status de acesso com ícones de bloqueio e desbloqueio).

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

Disponibilidade: v1.3+

Parâmetros:

Retorno de chamada disparado: preauthorizedResources:

Voltar ao início…

checkPreauthorizedResources:cache: checkPreauthCache

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: Este método é usado pelo aplicativo para determinar se o usuário já está autorizado a exibir recursos protegidos específicos. O objetivo principal desse método é recuperar informações para usar na decoração da interface do usuário (por exemplo, indicando o status de acesso com ícones de bloqueio e desbloqueio). O parâmetro cache controla se o cache interno é usado para resolver recursos.

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

Disponibilidade: v3.1+

Parâmetros:

Retorno de chamada disparado: preauthorizedResources:

Voltar ao início…

recursos pré-autorizados: preauthResources

Arquivo: AccessEnabler/headers/EntitlementDelegate.h

Descrição: Retorno de chamada disparado por checkPreauthorizedResources:. Fornece uma lista de recursos que o usuário já está autorizado a visualizar.

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

Disponibilidade: v1.3+

Parâmetros:

Acionado por: checkPreauthorizedResources:

Voltar ao início…

checkAuthorization:, checkAuthorization:withData: checkAuthZ

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: Este método é usado pelo aplicativo para verificar o status de autorização. Ela é iniciada verificando o status de autenticação primeiro. Se não estiver autenticado, o retorno de chamada tokenRequestFailed:errorCode:errorDescription: será disparado e o método será encerrado. Se o usuário estiver autenticado, ele também acionará o fluxo de autorização. Veja detalhes sobre o método getAuthorization:.

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

Disponibilidade: v1.0+

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

Disponibilidade: v1.9+

Parâmetros:

Retornos de chamada disparados:

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

Voltar ao início…

getAuthorization:, getAuthorization:withData: getAuthZ

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: Este método é usado pelo aplicativo para iniciar o fluxo de autorização. Se o usuário ainda não estiver autenticado, ele também iniciará o fluxo de autenticação. Se o usuário for autenticado, o AccessEnabler continuará a emitir solicitações para o token de autorização (se nenhum token de autorização válido estiver presente no cache do token local) e para o token de mídia de vida curta. Depois que o token de mídia curta é obtido, o fluxo de autorização é considerado concluído. O retorno de chamada setToken:forResource: é disparado e o token de mídia curto é entregue como um parâmetro ao aplicativo. Se, por qualquer motivo, a autorização falhar, o retorno de chamada tokenRequestFailed:forEventType: será acionado e o código/detalhes do erro serão fornecidos.

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

Disponibilidade: v1.0+

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

Disponibilidade: v1.9+

Parâmetros:

Retornos de chamada disparados: tokenRequestFailed:errorCode:errorDescription:, setToken:forResource:,sendTrackingData:forEventType:

Retornos de chamada adicionais disparados:
Este método também pode disparar os seguintes retornos de chamada (se o fluxo de autenticação também for iniciado): setAuthenticationStatus:errorCode:, displayProviderDialog:

Voltar ao início…

setToken:forResource: setToken

Arquivo: AccessEnabler/headers/EntitlementDelegate.h

Descrição Retorno de chamada disparado pelo AccessEnabler que informa ao aplicativo que o fluxo de autorização foi concluído com êxito. O token de mídia de vida curta também é fornecido como um parâmetro.

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

Disponibilidade: v1.0+

Parâmetros:

Acionado por: checkAuthorization: , checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:

Voltar ao início…

tokenRequestFailed:errorCode:errorDescription: tokenReqFailed

Arquivo: AccessEnabler/headers/EntitlementDelegate.h

Descrição Retorno de chamada disparado pelo AccessEnabler que informa ao aplicativo de camada superior que o fluxo de autorização falhou.

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

Disponibilidade: v1.0+

Parâmetros:

Acionado por: checkAuthorization:, checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:

Voltar ao início…

logout logout

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: Este método é chamado pelo aplicativo para iniciar o fluxo de logout. O logout é o resultado de uma série de operações de redirecionamento HTTP devido ao fato de que o usuário precisa ser desconectado dos servidores de Autenticação do Adobe Pass e também dos servidores do MVPD. Como esse fluxo não pode ser concluído com uma simples solicitação HTTP emitida pela biblioteca AccessEnabler, um controlador UIWebView/WKWebView or SFSafariViewController precisa ser instanciado para poder seguir as operações de redirecionamento HTTP.

O fluxo de logout difere do fluxo de autenticação na medida em que o usuário não é obrigado a interagir com o controlador UIWebView/WKWebView or SFSafariViewController de nenhuma maneira. Portanto, o Adobe recomenda que você torne o controle invisível (ou seja, oculto) durante o processo de logout.

Um padrão semelhante ao fluxo de autenticação é empregado. O iOS AccessEnabler aciona o retorno de chamada navigateToUrl: ou o navigateToUrl:useSVC: para criar um controlador UIWebView/WKWebView or SFSafariViewController e carregar a URL fornecida no parâmetro url do retorno de chamada. Este é o URL do ponto de extremidade de logout no servidor back-end. Para tvOS AccessEnabler, nem o retorno de chamada navigateToUrl: nem o retorno de chamada navigateToUrl:useSVC: são chamados.

À medida que passa por vários redirecionamentos, seu aplicativo deve monitorar a atividade do controlador UIWebView/WKWebView or SFSafariViewController e detectar o momento em que carrega um URL personalizado específico. Observe que esse URL personalizado específico é realmente inválido e não se destina ao controlador para carregá-lo. Ela deve ser interpretada somente pelo seu aplicativo como um sinal de que o fluxo de logout foi concluído e que é seguro fechar a controladora. Quando o controlador carrega esta URL personalizada específica, seu aplicativo deve fechar o controlador e chamar o método de API handleExternalURL:url do AccessEnabler. Caso seu aplicativo precise usar um controlador SFSafariViewController , a URL personalizada específica é definida por seu application's custom scheme (por exemplo, adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com); caso contrário, essa URL personalizada específica é definida pela constante ADOBEPASS_REDIRECT_URL (por exemplo, adobepass://ios.app).

No final, o AccessEnabler chamará o retorno de chamada setAuthenticationStatus() com um código de status 0, indicando sucesso do fluxo de logout.

Observação: se o usuário estiver conectado usando o Apple SSO, o status VSA203 será acionado. Se esse for o caso, o usuário deve ser instruído a também fazer logoff das configurações do sistema. Se isso não for feito, haverá uma nova autenticação quando o aplicativo for reiniciado.

- (void) logout;

Disponibilidade: v1.0+

Parâmetros: Nenhum

Retornos de chamada disparados: navigateToUrl:, setAuthenticationStatus:errorCode:

Voltar ao início…

getSelectedProvider getSelProv

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: Use este método para determinar o provedor selecionado no momento.

- (void) getSelectedProvider;

Disponibilidade: v1.0+

Parâmetros: Nenhum

Retornos de chamada disparados: selectedProvider:

Voltar ao início…

seletedProvider selProv

Arquivo: AccessEnabler/headers/EntitlementDelegate.h

Descrição Retorno de chamada disparado pelo AccessEnabler que fornece informações sobre o MVPD selecionado no momento para o aplicativo.

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

Disponibilidade: v1.0+

Parâmetros:

Acionado por: getSelectedProvider

Voltar ao início…

getMetadata: getMeta

Arquivo: AccessEnabler/headers/AccessEnabler.h

Descrição: Use este método para recuperar informações expostas como metadados pela biblioteca AccessEnabler. O aplicativo pode acessar esses dados fornecendo um parâmetro de entrada key baseado em dicionário.

Há dois tipos de metadados disponíveis para programadores:

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

Disponibilidade: v1.0+

Parâmetros:

Retornos de chamada disparados: setMetadataStatus:encrypted:forKey:andArguments:

Mais Informações: Metadados de Usuário

Voltar ao início…

presentTVProviderDialog presentTvDialog

Arquivo: AccessEnabler/headers/EntitlementDelegate.h

Descrição Retorno de chamada disparado pelo AccessEnabler após chamargetAuthentication() se o solicitante atual oferecer suporte a pelo menos um MVPD com suporte a SSO.

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

Disponibilidade: v2.0+

Parâmetros:

Acionado por: getAuthentication

Mais Informações Logon Único do iOS/tvOS

Voltar ao início…

dismissTVProviderDialog dismissTvDialog

Arquivo: AccessEnabler/headers/EntitlementDelegate.h

Descrição Retorno de chamada disparado pelo AccessEnabler depois que o usuário fecha a Caixa de Diálogo Apple SSO.

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

Disponibilidade: v2.0+

Parâmetros:

Acionado por: Ação do usuário

Mais Informações Logon Único do iOS/tvOS

Voltar ao início…

setMetadataStatus:encrypted:forKey:andArguments: setMetaStatus

Arquivo: AccessEnabler/headers/EntitlementDelegate.h

Descrição Retorno de chamada disparado pelo AccessEnabler que fornece os metadados solicitados por meio de uma chamada getMetadata:.

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

Disponibilidade: 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"]
            }

Acionado por: getMetadata:

Mais Informações: Metadados de Usuário

Voltar ao início…

MVPD mvpd

Arquivo: AccessEnabler/headers/model/MVPD.h

Descrição Descreve o objeto MVPD. Pode ser usado para obter informações sobre as propriedades do MVPD.

Disponibilidade: v1.0+ [a propriedade boardingStatus está disponível na v2.2]

Propriedades:

Voltar ao início…

Rastreamento de eventos tracking

O AccessEnabler aciona um retorno de chamada adicional que não está necessariamente relacionado aos fluxos de direito. A implementação da função de retorno de chamada sendTrackingData() é opcional, mas permite que o aplicativo rastreie eventos específicos e compile estatísticas, como o número de tentativas de autenticação/autorização com êxito/falha.

sendTrackingData sendTracking

Arquivo: AccessEnabler/headers/EntitlementDelegate.h

Descrição Retorno de chamada disparado pelo AccessEnabler sinalizando ao aplicativo a ocorrência de vários eventos, como a conclusão/falha de fluxos de autenticação/autorização. Com a Autenticação Adobe Pass 1.6, o tipo de dispositivo, o tipo de cliente AccessEnabler e o sistema operacional são relatados por sendTrackingData(). O retorno de chamada sendTrackingData() permanece compatível com versões anteriores.

Retorno de chamada: eventos de rastreamento

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

Disponibilidade: v1.0+

Observação: o tipo de dispositivo e o sistema operacional são derivados do uso de uma biblioteca Java pública (http://java.net/projects/user-agent-utils) e da cadeia de caracteres do agente do usuário. Esteja ciente de que essas informações são fornecidas apenas como uma forma grosseira de dividir as métricas operacionais em categorias de dispositivos, mas esse Adobe não pode assumir nenhuma responsabilidade por resultados incorretos. Use a nova funcionalidade adequadamente.

Parâmetros:

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

Instruções para interpretar os valores na matriz data: