DocumentatieAdobe PassAdobe Pass-verificatie

(Verouderd) Referentie iOS/tvOS SDK API iostvos-sdk-api-reference

Last update: Mon May 05 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
De inhoud op deze pagina wordt alleen ter informatie verstrekt. Voor het gebruik van deze API is een huidige licentie van Adobe vereist. Ongeautoriseerd gebruik is niet toegestaan.
IMPORTANT
Zorg ervoor u over de recentste het productmededelingen van de Authentificatie van Adobe Pass en ontmantelingschronologie wordt geïnformeerd die in de pagina van de Mededelingen van het Productwordt samengevoegd.

Inleiding intro

Op deze pagina worden de methoden en callback-functies beschreven die door de native iOS/tvOS-client voor Adobe Pass-verificatie worden aangeboden. De methoden en callback-functies die hier worden beschreven, worden gedefinieerd in de headerbestanden AccessEnabler.h en EntitlementDelegate.h . U vindt ze hier in de iOS AccessEnabler SDK: [SDK directory]/AccessEnabler/headers/api/

Bijbehorende documentatie:

NOTE
De Adobe moedigt u aan om slechts de Authentificatie van Adobe Pass openbare APIs te gebruiken:
  • Openbare API's zijn beschikbaar en volledig getest op alle ondersteunde clienttypen. Voor om het even welke openbare eigenschap, zorgen wij ervoor dat elk cliënttype een overeenkomstige versie van de bijbehorende methode(n) heeft.
  • Openbare API's moeten zo stabiel mogelijk zijn, achterwaartse compatibiliteit ondersteunen en ervoor zorgen dat partnerintegratie niet wordt verbroken. Voor niet-openbare API's behouden we ons echter het recht voor om hun handtekening op elk toekomstig moment te wijzigen. Als u een bepaalde stroom tegenkomt die niet door een combinatie van de huidige openbare API van de Authentificatie van Adobe Pass vraag kan worden gesteund, is de beste benadering ons op de hoogte te brengen. Rekening houdend met uw behoeften, kunnen wij openbare APIs wijzigen en een stabiele oplossing verstrekken die zich voortzet.

API-naslag apis

init:softwareStatement initWithSoftwareStatement

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: Instantieert het voorwerp AccessEnabler. Er zou één enkele instantie AccessEnabler per toepassingsinstantie moeten zijn.

API vraag: De aannemer van iOS AccessEnabler
- (id) init:
(NSString *)softwareStatement;

Beschikbaarheid: v3.0+

Parameters:

  • softwareStatement: een koord dat de toepassing in het systeem van de Adobe identificeert. Ontdek hoe u een Software Statement kunt verkrijgen.

Terug naar boven…

init - [ VEROUDERD ] init

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: Instantieert het voorwerp AccessEnabler. Er zou één enkele instantie AccessEnabler per toepassingsinstantie moeten zijn.

API-aanroep: Constructor iOS AccessEnabler
- (id) init;

Beschikbaarheid: v1.0+ tot: v3.0

Parameters: niets

Terug naar boven…

setOptions:opties setOptions

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: vormt globale opties van SDK. Het keurt een NSDictionary als argument goed. De waarden van het woordenboek worden samen met elke netwerkaanroep die de SDK maakt, doorgegeven aan de server.

Nota: de waarden zullen aan de server onafhankelijk van de huidige stroom (authentificatie/vergunning) worden overgegaan. Als u de waarden wilt wijzigen, kunt u deze methode op elk gewenst moment aanroepen.

API-aanroep: setOptions
- (void) setOptions:(NSDictionary *)options;

Beschikbaarheid: v2.3.0+

Parameters:

  • opties: Een NSDictionary die globale opties van SDK bevat. Momenteel zijn de volgende opties beschikbaar:

    • applicationProfile - het kan worden gebruikt om serverconfiguraties te maken die op deze waarde worden gebaseerd.

    • bezoekorID - de Dienst van identiteitskaart van het Experience Cloud. Deze waarde kan later worden gebruikt voor geavanceerde analyserapporten.

    • handleSVC - Van Boole die als de programmeur SFSafariViewControllers zal behandelen. Gelieve te zien SFSafariViewController steun op iOS SDK 3.2+voor meer details.

      • Als de reeks aan vals, SDK automatisch de eindgebruiker met een SFSafariViewController zal voorstellen. De SDK navigeert verder naar de URL van de MVPD-aanmeldingspagina.
      • Als de reeks aan waar, SDK ​ ​automatisch niet {de eindgebruiker met een SFSafariViewController zal voorstellen. SDK zal verder navigeren (toUrl:{url}, useSVC:JA).

  • apparaat_info - de informatie van de Cliënt zoals die in wordt beschreven het overgaan cliëntinformatie.

Terug naar boven…

setRequestor:requestorID, setRequestor:requestorID:serviceProviders: setReqV3

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: vestigt de identiteit van de programmeur. Elke programmeur krijgt een unieke id toegewezen bij het registreren bij Adobe voor het Adobe Pass-verificatiesysteem. Wanneer het behandelen van SSO en verre tokens, kan de authentificatiestatus veranderen wanneer de toepassing op de achtergrond is, setRequestor kan opnieuw worden geroepen wanneer de toepassing in de voorgrond wordt gebracht om met de systeemstaat te synchroniseren (haal een verre token als SSO wordt toegelaten of schrap het lokale teken als een logout in de tussentijd gebeurde).

De serverreactie bevat een lijst van MVPDs samen met wat configuratieinformatie die aan de identiteit van Programmer in bijlage is. De serverreactie wordt gebruikt intern door de code AccessEnabler. Alleen de status van de bewerking (SUCCESS/FAIL) wordt via de callback setRequestorComplete: aan uw toepassing gepresenteerd.

Als de parameter urls niet wordt gebruikt, richt de resulterende netwerkaanroep zich op de standaarddienstverlener URL: de Adobe RELEASE/productie milieu.

Als een waarde voor de parameter urls wordt opgegeven, richt de resulterende netwerkaanroep alle URL's die in de parameter urls worden opgegeven. Alle configuratieverzoeken worden teweeggebracht gelijktijdig in afzonderlijke draden. De eerste responder krijgt voorrang wanneer het compileren van de lijst van MVPDs. Voor elke MVPD in de lijst, onthoudt AccessEnabler URL van de bijbehorende dienstverlener. Alle volgende machtigingsaanvragen worden doorgestuurd naar de URL die is gekoppeld aan de serviceprovider die tijdens de configuratiefase aan de doel-MVPD is gekoppeld.

API-aanroep: configuratie aanvrager
- (void) setRequestor:(NSString *)requestorID

Beschikbaarheid: v3.0+

API-aanroep: configuratie aanvrager
- (void) setRequestor:(NSString *)requestorID serviceProviders:(NSArray *)urls;

Beschikbaarheid: v3.0+

Parameters:

  • requestID: Unieke identiteitskaart verbonden aan de Programmer. Geef de unieke id die door Adobe aan uw site is toegewezen door wanneer u zich voor het eerst aanmeldt bij de Adobe Pass-verificatieservice.
  • urls: Facultatieve parameter; door gebrek, wordt de dienstverlener van Adobe gebruikt (http://sp.auth.adobe.com/). Deze serie staat u toe om eindpunten voor authentificatie en vergunningsdiensten te specificeren die door Adobe worden verleend (verschillende instanties zouden voor het zuiveren doeleinden kunnen worden gebruikt). U kunt dit gebruiken om meerdere instanties van Adobe Pass-verificatieproviders op te geven. Daarbij bestaat de MVPD-lijst uit de eindpunten van alle serviceproviders. Elke MVPD is gekoppeld aan de snelste serviceprovider, dat wil zeggen de provider die eerst heeft gereageerd en die die MVPD ondersteunt.
NOTE
Als deze wordt aangeroepen zonder de parameter serviceProviders , haalt de bibliotheek de configuratie op van het standaardservicebureau (dat wil zeggen https://sp.auth.adobe.com voor het productieprofiel of https://sp.auth-staging.adobe.com voor het staging-profiel). Als de parameter serviceProviders wordt opgegeven, moet deze een array van URL's zijn. De configuratiegegevens worden opgehaald uit alle opgegeven eindpunten en worden samengevoegd. Als dubbele informatie in verschillende dienstverlener reacties bestaat, wordt het conflict opgelost ten gunste van de snelst antwoordende server (namelijk de server met de kortste reactietijd neemt belangrijkheid).

teweeggebrachte callbacks: setRequestorComplete:

Terug naar boven…

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

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: vestigt de identiteit van de programmeur. Elke programmeur krijgt een unieke id toegewezen bij het registreren bij Adobe voor het Adobe Pass-verificatiesysteem. Wanneer het behandelen van SSO en verre tokens kan de authentificatiestatus veranderen wanneer de toepassing op de achtergrond is, kan setRequestor opnieuw worden geroepen wanneer de toepassing in voorgrond wordt gebracht om met de systeemstaat te synchroniseren (haal een verre teken als SSO wordt toegelaten of schrap het lokale teken als een logout in de tussentijd gebeurde).

De serverreactie bevat een lijst van MVPDs samen met wat configuratieinformatie die aan de identiteit van Programmer in bijlage is. De serverreactie wordt gebruikt intern door de code AccessEnabler. Alleen de status van de bewerking (SUCCESS/FAIL) wordt via de callback setRequestorComplete: aan uw toepassing gepresenteerd.

Als de parameter urls niet wordt gebruikt, richt de resulterende netwerkaanroep zich op de standaarddienstverlener URL: de Adobe RELEASE/productie milieu.

Als een waarde voor de parameter urls wordt opgegeven, richt de resulterende netwerkaanroep alle URL's die in de parameter urls worden opgegeven. Alle configuratieverzoeken worden teweeggebracht gelijktijdig in afzonderlijke draden. De eerste responder krijgt voorrang wanneer het compileren van de lijst van MVPDs. Voor elke MVPD in de lijst, onthoudt AccessEnabler URL van de bijbehorende dienstverlener. Alle volgende machtigingsaanvragen worden doorgestuurd naar de URL die is gekoppeld aan de serviceprovider die tijdens de configuratiefase aan de doel-MVPD is gekoppeld.

API-aanroep: configuratie aanvrager
- (void) setRequestor:(NSString *)requestorID
signedRequestorID:(NSString *)signedRequestorID;

Beschikbaarheid: v1.0+ tot: v3.0

API-aanroep: configuratie aanvrager
- (void) setRequestor:(NSString *)requestorID
signedRequestorID:(NSString *)signedRequestorID
serviceProviders:(NSArray *)urls;

Beschikbaarheid: v1.0+ tot: v3.0

Parameters:

  • requestID: Unieke identiteitskaart verbonden aan de Programmer. Geef de unieke id die door Adobe is toegewezen door aan uw site wanneer u zich voor het eerst hebt geregistreerd bij de Adobe Pass-verificatieservice.
  • signedRequestorID: Deze parameter bestaat in iOS AccessEnabler versies 1.2 en later. Een kopie van de aanvrager-id die digitaal is ondertekend met uw persoonlijke sleutel. .
  • urls: Facultatieve parameter; door gebrek, wordt de dienstverlener van Adobe gebruikt (http://sp.auth.adobe.com/). Deze serie staat u toe om eindpunten voor authentificatie en vergunningsdiensten te specificeren die door Adobe worden verleend (verschillende instanties zouden voor het zuiveren doeleinden kunnen worden gebruikt). U kunt dit gebruiken om meerdere instanties van Adobe Pass-verificatieproviders op te geven. Daarbij bestaat de MVPD-lijst uit de eindpunten van alle serviceproviders. Elke MVPD is gekoppeld aan de snelste serviceprovider, dat wil zeggen de provider die eerst heeft gereageerd en die die MVPD ondersteunt.

Nota's: Als geroepen zonder de serviceProviders parameter, zal de bibliotheek de configuratie van de standaarddienstverlener (namelijk https://sp.auth.adobe.com voor het productieprofiel of https://sp.auth-staging.adobe.com voor het opvoeren profiel) terugwinnen. Als de parameter serviceProviders wordt opgegeven, moet deze een array van URL's zijn. De configuratiegegevens worden opgehaald uit alle opgegeven eindpunten en worden samengevoegd. Als dubbele informatie in verschillende dienstverlener reacties bestaat, wordt het conflict opgelost ten gunste van de snelst antwoordende server (d.w.z., de server met de kortste reactietijd neemt belangrijkheid).

teweeggebrachte callbacks: setRequestorComplete:

Terug naar boven…

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

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: vestigt de identiteit van de programmeur. Elke programmeur krijgt een unieke id toegewezen bij het registreren bij Adobe voor het Adobe Pass-verificatiesysteem. Deze instelling mag slechts eenmaal worden uitgevoerd tijdens de levenscyclus van de toepassing.

De serverreactie bevat een lijst van MVPDs samen met wat configuratieinformatie die aan de identiteit van Programmer in bijlage is. De serverreactie wordt gebruikt intern door de code AccessEnabler. Alleen de status van de bewerking (SUCCESS/FAIL) wordt via de callback setRequestorComplete: aan uw toepassing gepresenteerd.

Als de parameter urls niet wordt gebruikt, richt de resulterende netwerkaanroep zich op de standaarddienstverlener URL: de Adobe RELEASE/productie milieu.

Als een waarde voor de parameter urls wordt opgegeven, richt de resulterende netwerkaanroep alle URL's die in de parameter urls worden opgegeven. Alle configuratieverzoeken worden teweeggebracht gelijktijdig in afzonderlijke draden. De eerste responder krijgt voorrang wanneer het compileren van de lijst van MVPDs. Voor elke MVPD in de lijst, onthoudt AccessEnabler URL van de bijbehorende dienstverlener. Alle volgende machtigingsaanvragen worden doorgestuurd naar de URL die is gekoppeld aan de serviceprovider die tijdens de configuratiefase aan de doel-MVPD is gekoppeld.

API-aanroep: configuratie aanvrager
code language-none 
- (void) setRequestor:(NSString *)requestorID
    signedRequestorID:(NSString *)signedRequestorID
               secret:(NSString *)secret
            publicKey:(NSString *)publicKey;

Beschikbaarheid: v2.0+ tot: v3.0

API-aanroep: configuratie aanvrager
code language-none 
- (void) setRequestor:(NSString *)requestorID
    signedRequestorID:(NSString *)signedRequestorID
     serviceProviders:(NSArray *)urls

secret:(NSString *)secret

publicKey:(NSString *)publicKey;

Beschikbaarheid: v2.0+ tot: v3.0

Parameters:

  • requestID: Unieke identiteitskaart verbonden aan de Programmer. Geef de unieke id die door Adobe aan uw site is toegewezen, door aan uw site wanneer u het eerst geregistreerd bij de Adobe Pass Authentication-service.
  • signedRequestorID: Deze parameter bestaat in iOS AccessEnabler versies 1.2 en hoger. Een kopie van de aanvrager-id die digitaal is ondertekend met uw persoonlijke sleutel. .
  • urls: Facultatieve parameter; door gebrek, de dienstverlener van Adobe wordt gebruikt (http://sp.auth.adobe.com/). Deze serie staat u toe om eindpunten voor authentificatie en vergunningsdiensten te specificeren die door Adobe worden verleend (verschillende instanties zouden voor het zuiveren doeleinden kunnen worden gebruikt). U kunt dit gebruiken om meerdere instanties van Adobe Pass-verificatieproviders op te geven. Daarbij bestaat de MVPD-lijst uit de eindpunten van alle serviceproviders. Elke MVPD is gekoppeld aan de snelste serviceprovider, dat wil zeggen de provider die eerst heeft gereageerd en die die MVPD ondersteunt.
  • geheim en publicKey: De geheime en openbare sleutel die wordt gebruikt om de tweede het schermvraag te ondertekenen. Voor meer informatie zie de Clienteless documentatie.

Als deze wordt aangeroepen zonder de parameter serviceProviders , haalt de bibliotheek de configuratie op van het standaardservicebureau (d.w.z. https://sp.auth.adobe.com voor het productieprofiel of https://sp.auth-staging.adobe.com voor het staging-profiel). Als de parameter serviceProviders wordt opgegeven, moet deze een array van URL's zijn. De configuratiegegevens worden opgehaald uit alle opgegeven eindpunten en worden samengevoegd. Als dubbele informatie in verschillende dienstverlener reacties bestaat, wordt het conflict opgelost ten gunste van de snelst antwoordende server (d.w.z., de server met de kortste reactietijd neemt belangrijkheid).

teweeggebrachte callbacks: setRequestorComplete:

Terug naar boven…

setRequestorComplete: setReqComplete

Dossier: AccessEnabler/headers/EntitlementDelegate.h

Omschrijving Callback die door AccessEnabler wordt teweeggebracht die uw toepassing informeert dat de configuratiefase volledig is. Dit is een signaal dat de app aanvragen voor machtigingen kan starten. De toepassing kan geen machtigingsaanvragen indienen totdat de configuratiefase is voltooid.

Callback: configuratie aanvrager voltooid
code language-none 
- (void) setRequestorComplete:(int)status;

Beschikbaarheid: v1.0+

Parameters:

  • status: kan één van de volgende waarden nemen:

    • ACCESS_ENABLER_STATUS_SUCCESS - de configuratiefase is voltooid
    • ACCESS_ENABLER_STATUS_ERROR - configuratiefase mislukt

teweeggebracht door:

setRequestor:setSignedRequestorId:, setRequestor:setSignedRequestorId:serviceProviders:

Terug naar boven…

checkAuthentication checkAuthN

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: controleert de authentificatiestatus van de huidige gebruiker.
Het doet dit door naar een geldig authentificatietoken in de lokale
opslagruimte voor token. Deze methode voert geen netwerkvraag uit en wij adviseren roepend het op de belangrijkste draad.
Het wordt gebruikt door de toepassing om de de authentificatiestatus van de gebruiker te vragen en
de gebruikersinterface dienovereenkomstig bijwerken (d.w.z. de gebruikersinterface voor aanmelden/afmelden bijwerken). De
de authenticatiestatus wordt aan de aanvraag meegedeeld via
de setAuthenticationStatus:errorCode: callback.

API-aanroep: verificatiestatus controleren
code language-none 
- (void) checkAuthentication;

Beschikbaarheid: v1.0+

Parameters: niets

teweeggebrachte callbacks:
setAuthenticationStatus:errorCode:

Terug naar boven…

getAuthentication, getAuthentication:withData: getAuthN

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: begint het volledige authentificatiewerkschema. Het begint door de authentificatiestatus te controleren. Indien nog niet geverifieerd, wordt de verificatiestroom state-machine gestart:

  • als de laatste verificatiepoging succesvol was, de MVPD de selectiefase wordt overgeslagen en de callback van navigateToUrl: wordt geactiveerd. De de toepassing gebruikt deze callback om de controle te concretiseren WebView die de gebruiker met de MVPD login pagina voorstelt. [NOTA: Vanaf Toegang toelaten 1.5, is deze functionaliteit niet beschikbaar wegens een beperking in SDK ].
  • als de laatste verificatiepoging is mislukt of als de gebruiker zich expliciet heeft afgemeld, wordt de displayProviderDialog: callback geactiveerd. Deze callback wordt door uw toepassing gebruikt om de gebruikersinterface van de MVPD-selectie weer te geven. Uw app is ook vereist om de verificatiestroom te hervatten door de AccessEnabler-bibliotheek via de setSelectedProvider: -methode te informeren over de MVPD-selectie van de gebruiker.

Aangezien de gebruikersgegevens op de MVPD-aanmeldingspagina worden gecontroleerd, moet uw toepassing de meervoudige omleidingsbewerkingen controleren die plaatsvinden terwijl de gebruiker op de MVPD-aanmeldingspagina wordt geverifieerd. Wanneer de correcte geloofsbrieven zijn ingegaan, wordt de controle WebView opnieuw gericht aan een douane URL die door de ADOBEPASS_REDIRECT_URL constante wordt bepaald. Deze URL is niet bedoeld om door WebView te worden geladen. De toepassing moet deze URL onderscheppen en deze gebeurtenis interpreteren als een signaal dat de aanmeldingsfase is voltooid. Het zou dan controle aan AccessEnabler moeten overdragen om de authentificatiestroom (door de 🔗 methode te roepen 0} handleExternalURL) te voltooien.

Tot slot wordt de authentificatiestatus meegedeeld aan de toepassing via setAuthenticationStatus:errorCode: callback.

API-aanroep: initieert de verificatiestroom
code language-none 
- (void) getAuthentication;

Beschikbaarheid: v1.0+

API-aanroep: initieert de verificatiestroom
code language-none 
- (void) getAuthentication:(BOOL)forceAuthn:
                  withData:(NSDictionary* )data;

Beschikbaarheid: v1.9+

Parameters:

  • forceAuthn: Een vlag die specificeert als de authentificatiestroom zou moeten zijn begonnen, ongeacht als de gebruiker reeds voor authentiek verklaard of niet is.
  • gegevens: Een woordenboek dat uit zeer belangrijk-waardeparen bestaat die naar de de omslagdienst van betaaltelevisie moeten worden verzonden. Adobe kan deze gegevens gebruiken om toekomstige functionaliteit mogelijk te maken zonder de SDK te wijzigen.

teweeggebrachte callbacks: setAuthenticationStatus:errorCode:, displayProviderDialog:, sendTrackingData:forEventType:

Terug naar boven…

getAuthentication:filter, getAuthentication:withData:andFilter getAuthN_filter

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: begint het volledige authentificatiewerkschema. Het begint door de authentificatiestatus te controleren. Indien nog niet geverifieerd, wordt de verificatiestroom state-machine gestart:

  • presentTvProviderDialog ()zal worden geroepen als de huidige aanvrager minstens één MVPD heeft die SSO steunt. Als geen MVPD SSO steunt, zal de klassieke authentificatiestroom beginnen en de filterparameter wordt genegeerd.
  • Nadat de gebruiker de Apple SSO-stroom dismissTvProviderDialog() heeft voltooid, wordt deze geactiveerd en het verificatieproces is voltooid.

Tot slot wordt de authentificatiestatus meegedeeld aan de toepassing via setAuthenticationStatus:errorCode: callback.

Beschikbaarheid: v2.4+

API-aanroep: initieert de verificatiestroom
code language-none 
- (void) getAuthentication:(NSDictionary *)filter;
API-aanroep: initieert de verificatiestroom
code language-none 
- (void) getAuthentication:(BOOL)forceAuthn:
                  withData:(NSDictionary* )data
                 andFilter:(NSDictionary *)filter;

Parameters:

  • forceAuthn: Een vlag die specificeert als de authentificatiestroom zou moeten zijn begonnen, ongeacht als de gebruiker reeds voor authentiek verklaard of niet is.

  • gegevens: Een woordenboek dat uit zeer belangrijk-waardeparen bestaat die naar de de omslagdienst van betaaltelevisie moeten worden verzonden. Adobe kan deze gegevens gebruiken om toekomstige functionaliteit mogelijk te maken zonder de SDK te wijzigen.

  • filter: Een woordenboek met twee lijsten met MVPD-id's die moeten worden weergegeven in het dialoogvenster Apple SSO. Elke MVPD die SSO niet ondersteunt, wordt genegeerd, maar de volgorde wordt gerespecteerd. Het woordenboek moet twee toetsen hebben:

    • TV_PROVIDERS: Een lijst met alle MVPDs die in de plukker zou moeten verschijnen
    • FEATURED_TV_PROVIDERS: Een lijst met alle MVPDs die zou moeten worden gemerkt zoals gespiegeld in de plukker. MVPD's in deze lijst moeten ook worden opgegeven in de lijst Tv_PROVIDERS.

Beschikbaarheid: v2.0 - v2.3.1

API-aanroep: initieert de verificatiestroom
code language-none 
- (void) getAuthentication:(NSArray *)filter;
API-aanroep: initieert de verificatiestroom
code language-none 
- (void) getAuthentication:(BOOL)forceAuthn:
                  withData:(NSDictionary* )data
                 andFilter:(NSArray *)filter;

Parameters:

  • forceAuthn: Een vlag die specificeert als de authentificatiestroom zou moeten zijn begonnen, ongeacht als de gebruiker reeds voor authentiek verklaard of niet is.
  • gegevens: Een woordenboek dat uit zeer belangrijk-waardeparen bestaat die naar de de omslagdienst van betaaltelevisie moeten worden verzonden. Adobe kan deze gegevens gebruiken om toekomstige functionaliteit mogelijk te maken zonder de SDK te wijzigen.
  • filter: Een lijst met MVPD-id's die moeten worden weergegeven in het dialoogvenster Apple SSO. Elke MVPD die SSO niet ondersteunt, wordt genegeerd, maar de volgorde wordt gerespecteerd.

teweeggebrachte callbacks: setAuthenticationStatus:errorCode:, presentTvProviderDialog, dismissTvProviderDialog

Terug naar boven…

displayProviderDialog: dispProvDialog

Dossier: AccessEnabler/headers/EntitlementDelegate.h

Omschrijving Callback die door AccessEnabler wordt teweeggebracht om de toepassing mee te delen dat de aangewezen elementen UI moeten worden geconcretiseerd om de gebruiker toe te staan om de gewenste MVPD te selecteren. De callback bevat een lijst met MVPD-objecten met aanvullende informatie die kan helpen om het deelvenster met de gebruikersinterface van de selectie correct samen te stellen (zoals de URL die het MVPD-logo aanwijst, een vriendelijke weergavenaam, enz.)

Nadat de gebruiker de gewenste MVPD heeft geselecteerd, moet de toepassing op de bovenste laag de verificatiestroom hervatten door setSelectedProvider: aan te roepen en deze de id van de MVPD door te geven die overeenkomt met de selectie van de gebruiker.

Aborting de authentificatiestroom - dit is een punt waar de gebruiker de capaciteit heeft om de "Achterknoop"te drukken, die aan het aborteren van de authentificatiestroom gelijkwaardig is. In dat scenario, wordt uw toepassing vereist om setSelectedProvider te roepen: methode, die ongeldig als parameter overgaat, om AccessEnabler de kans te geven om zijn authentificatiestatus-machine terug te stellen.

Callback: de gebruikersinterface van de MVPD-selectie weergeven
code language-none 
- (void) displayProviderDialog:(NSArray *)mvpds;

Beschikbaarheid: v1.0+

Parameters:

  • mvpds: lijst van de voorwerpen van MVPD die op MVPD betrekking hebbende informatie houden die de toepassing kan gebruiken om de elementen van de MVPD selectie UI te bouwen.

teweeggebracht door: getAuthentication, getAuthentication:withData:, getAuthorization:, getAuthorization:withData:

Terug naar boven…

setSelectedProvider: setSelProv

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: Deze methode wordt geroepen door uw toepassing om Toegangsmanager van de selectie van MVPD van de gebruiker op de hoogte te brengen. De toepassing kan deze methode gebruiken om de dienstverlener te selecteren of te veranderen die voor authentificatie wordt gebruikt.

Als de geselecteerde MVPD een TempPass-MVPD is, wordt deze automatisch geverifieerd met die MVPD zonder dat getAuthentication() achteraf moet worden aangeroepen.

Houd er rekening mee dat dit niet mogelijk is voor de Tijdelijke controle voor speciale acties waarbij extra parameters worden gegeven aan de methode getAuthentication().

Wanneer het overgaan van ongeldig als parameter, veronderstelt de Toegang dat de gebruiker de authentificatiestroom (d.w.z. op de "Achterknoop"gedrukt) heeft geannuleerd, en antwoordt door de authentificatiestatus-machine terug te stellen en door setAuthenticationStatus:errorCode: callback met de AccessEnabler.PROVIDER_NOT_SELECTED_ERROR foutencode te roepen.

API-aanroep: stel de momenteel geselecteerde provider in
code language-none 
- (void) setSelectedProvider:(NSString *)mvpdId;

Beschikbaarheid: v1.0+

Parameters: niets

teweeggebrachte callbacks: setAuthenticationStatus:errorCode:, sendTrackingData:forEventType:, navigateToUrl:

Terug naar boven…

Dossier: AccessEnabler/headers/EntitlementDelegate.h

Beschrijving: Callback die door AccessEnabler wordt teweeggebracht om uw toepassing te verzoeken om een controlemechanisme UIWebView/WKWebView te concretiseren en URL te laden die in de 2} parameter van callback wordt verstrekt. url De callback gaat de url parameter over die URL van het authentificatieeindpunt of URL van het logout eindpunt vertegenwoordigt.

Aangezien het UIWebView/WKWebView ``controlemechanisme door verscheidene redirects gaat, moet uw toepassing de activiteit van het controlemechanisme controleren en het moment ontdekken wanneer het een specifieke douane URL laadt die door de ADOBEPASS_REDIRECT_URL constante (d.w.z. adobepass://ios.app wordt bepaald). Deze specifieke aangepaste URL is in feite ongeldig en is niet bestemd voor de controller om deze daadwerkelijk te laden. Het moet slechts door uw toepassing als signaal worden geïnterpreteerd dat de authentificatie of logout stroom heeft voltooid en dat het veilig is om het controlemechanisme te sluiten. Wanneer het controlemechanisme deze specifieke douane URL laadt moet uw toepassing UIWebView/WKWebView sluiten en de 20} API methode roepen van AccessEnabler {.handleExternalURL:url

Nota: Gelieve te merken op dat in het geval van de authentificatiestroom dit een punt is waar de gebruiker de capaciteit heeft om de "Achterknoop"te drukken, die aan het aborteren van de authentificatiestroom gelijkwaardig is. In zulk een scenario, wordt uw toepassing vereist om setSelectedProvider te roepen: methode die nil als parameter overgaat en een kans geeft aan AccessEnabler om zijn authentificatiestatus-machine terug te stellen.

Callback: MVPD-aanmeldingspagina weergeven
code language-none 
- (void) navigateToUrl:(NSString *)url;

Beschikbaarheid: v1.0+

Parameters:

  • url: URL die aan de MVPD login pagina richt

teweeggebracht door: setSelectedProvider:

Terug naar boven…

Dossier: AccessEnabler/headers/EntitlementDelegate.h

Beschrijving: Callback die door AccessEnabler in plaats van navigateToUrl: callback in werking wordt gesteld voor het geval dat uw toepassing eerder handmatige behandeling van het Controlemechanisme van de Mening Safari (SVC) via [ setOptions (\ "handleSVC":waar"]), en slechts in het geval van MVPDs die Controlemechanisme van de Mening vereisen (SVC). Voor alle andere MVPD's wordt de callback navigateToUrl: aangeroepen. Gelieve te zien {de steun SFSafariViewController op iOS SDK 3.2+ 🔗 voor details op hoe het Controlemechanisme van de Mening Safari (SVC) zou moeten worden beheerd.

Net als bij de navigateToUrl: callback wordt navigateToUrl:useSVC: door de AccessEnabler geactiveerd om uw toepassing te vragen een SFSafariViewController -controller te instantiëren en de URL te laden die in de url -parameter van de callback is opgegeven. De callback geeft de parameter url door die de URL van het verificatieeindpunt of de URL van het logout-eindpunt vertegenwoordigt, en de parameter useSVC die aangeeft dat de toepassing een SFSafariViewController moet gebruiken.

Aangezien het SFSafariViewController controlemechanisme door verscheidene omleidingen gaat, moet uw toepassing de activiteit van het controlemechanisme controleren en het ogenblik ontdekken wanneer het een specifieke douane URL laadt die door uw application's custom scheme wordt bepaald (b.v.**​ ** adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com). Deze specifieke aangepaste URL is in feite ongeldig en is niet bestemd voor de controller om deze daadwerkelijk te laden. Het moet slechts door uw toepassing als signaal worden geïnterpreteerd dat de authentificatie of logout stroom heeft voltooid en dat het veilig is om het controlemechanisme te sluiten. Wanneer het controlemechanisme deze specifieke douane URL laadt moet uw toepassing SFSafariViewController sluiten en de 1} API methode van AccessEnabler roepen {.handleExternalURL:url

Nota: Gelieve te merken op dat in het geval van de authentificatiestroom dit een punt is waar de gebruiker de capaciteit heeft om de "Achterknoop"te drukken, die aan het aborteren van de authentificatiestroom gelijkwaardig is. In zulk een scenario, wordt uw toepassing vereist om setSelectedProvider te roepen: methode die nil als parameter overgaat en een kans geeft aan AccessEnabler om zijn authentificatiestatus-machine terug te stellen.

Callback: MVPD-aanmeldingspagina weergeven in SFSafariViewController
code language-none 
@optional
​- (void) navigateToUrl:(NSString *)url useSVC:(BOOL)useSVC;

Beschikbaarheid: ​v 3.2+

Parameters:

  • url: URL die aan de MVPD aanmeldingspagina richt
  • useSVC: of url in SFSafariViewController zou moeten worden geladen.

teweeggebracht door: ​ setOptions: vóór setSelectedProvider:

Terug naar boven…

handleExternalURL:url handleExternalURL

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: Deze methode wordt geroepen door uw toepassing om de authentificatie of logout stroom te voltooien. Deze methode moet worden aangeroepen direct nadat uw toepassing het moment detecteert waarop de UIWebView/WKWebView or SFSafariViewController -controller wordt omgeleid naar een specifieke aangepaste URL. In het geval dat uw toepassing a SFSafariViewController controlemechanisme moet gebruiken wordt de specifieke douane URL bepaald door uw application's custom scheme (b.v. adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com), anders wordt deze specifieke douane URL bepaald door de ADOBEPASS_REDIRECT_URL constante (d.w.z. adobepass://ios.app).

In het geval van de authentificatiestroom voltooit AccessEnabler de stroom door het authentificatietoken van de achterste deelserver terug te winnen en het lokaal in de symbolische opslag op te slaan. AccessEnabler zal uw toepassing informeren dat de authentificatiestroom door setAuthenticationStatus() callback met een statuscode van 1 te roepen volledig is, erop wijzend succes. Als er tijdens de uitvoering van deze stappen een fout optreedt, wordt de callback van setAuthenticationStatus() geactiveerd met een statuscode 0 die een verificatiefout en een bijbehorende foutcode aangeeft.

API-aanroep: de verificatie- of uitlogingsstroom voltooien
code language-none 
 (void) handleExternalURL:(NSString *)url;

Beschikbaarheid: v3.0+

Parameters:

  • url: Onderschepte URL van de UIWebView/WKWebView or SFSafariViewController controle als koord.

teweeggebrachte callbacks: setAuthenticationStatus:errorCode, sendTrackingData:forEventType:

Terug naar boven…

getAuthenticationToken - [ VEROUDERD ] getAuthNToken

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: voltooit de authentificatiestroom door het authentificatietoken van de achterste deelserver te verzoeken. Deze methode moet alleen door uw toepassing worden aangeroepen als reactie op een gebeurtenis waarbij het WebView-besturingselement dat de MVPD-aanmeldingspagina host, wordt omgeleid naar de aangepaste URL die door de ADOBEPASS_REDIRECT_URL -constante wordt gedefinieerd.

API-aanroep: het verificatietoken ophalen
code language-none 
- (void) getAuthenticationToken;

Beschikbaarheid: v1.0+ tot: v3.0

Parameters: niets

teweeggebrachte callbacks: setAuthenticationStatus:errorCode,sendTrackingData:forEventType:

Terug naar boven…

</br

setAuthenticationStatus:errorCode: setAuthNStatus

Dossier: AccessEnabler/headers/EntitlementDelegate.h

Omschrijving Callback die door AccessEnabler wordt teweeggebracht die de toepassing van het statuut van de authentificatiestroom informeert. Er zijn vele plaatsen waar deze stroom kan ontbreken, of als gevolg van gebruikersinteractie of wegens andere onvoorziene scenario's (d.w.z., netwerkconnectiviteitsproblemen, enz.). Deze callback informeert de toepassing van de succes/mislukkingsstatus van de authentificatiestroom, terwijl ook het verstrekken van extra informatie over de mislukkingsreden, wanneer nodig.

Callback: rapport de status van de authentificatiestroom
code language-none 
- (void) setAuthenticationStatus:(int)status
                       errorCode:(NSString *)code;

Beschikbaarheid: v1.0+

Parameters:

  • status: kan één van de volgende waarden nemen:

    • ACCESS_ENABLER_STATUS_SUCCESS - de verificatiestroom is voltooid
    • ACCESS_ENABLER_STATUS_ERROR - verificatiestroom mislukt

  • code: mislukkingsreden. Als status ACCESS_ENABLER_STATUS_SUCCESS is, dan code een leeg koord (d.w.z., dat door de USER_AUTHENTICATED constante wordt bepaald) is. In het geval van een fout kan deze parameter een van de volgende waarden hebben:

    • USER_NOT_AUTHENTICATED_ERROR - De gebruiker is niet geverifieerd. In antwoord op checkAuthentication: methodevraag wanneer er geen geldig authentificatietoken in het lokale symbolische geheime voorgeheugen is.
    • PROVIDER_NOT_SELECTED_ERROR - De AccessEnabler heeft de authentificatiestatus-machine na de hogere laagtoepassing overgegaan ongeldig tot setSelectedProvider: om de authentificatiestroom af te breken. Waarschijnlijk heeft de gebruiker de verificatiestroom geannuleerd (druk op de knop "Terug").
    • GENERIC_AUTHENTICATION_ERROR - De verificatiestroom is mislukt als gevolg van redenen zoals netwerkonbeschikbaarheid of omdat de gebruiker de verificatiestroom expliciet heeft geannuleerd.

teweeggebracht door: checkAuthentication, getAuthentication, getAuthentication:withData:, checkAuthorization:, checkAuthorization:withData:

Terug naar boven…

checkPreauthorisedResources: checkPreauth

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: Deze methode wordt gebruikt door de toepassing om te bepalen als de gebruiker reeds gemachtigd is om specifieke beschermde middelen te bekijken. Het primaire doel van deze methode is informatie voor gebruik in het versieren van UI terug te winnen (bijvoorbeeld, wijzend op toegangsstatus met slot en ontgrendelingspictogrammen).

API-aanroep: stel de momenteel geselecteerde provider in
code language-none 
- (void) checkPreauthorizedResources:(NSArray *)resources;

Beschikbaarheid: v1.3+

Parameters:

  • middelen: serie van middelen waarvoor de vergunning zou moeten worden gecontroleerd. Elk element in de lijst moet een tekenreeks zijn die de bron-id vertegenwoordigt. De resource-id is onderworpen aan dezelfde beperkingen als de resource-id in de aanroep, dat wil zeggen dat deze een waarde moet zijn die is vastgesteld tussen de programmeur en de MVPD of een media-RSS-fragment.

callback teweeggebracht: preauthorizedResources:

Terug naar boven…

checkPreauthorizedResources:cache: checkPreauthCache

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: Deze methode wordt gebruikt door de toepassing om te bepalen als de gebruiker reeds gemachtigd is om specifieke beschermde middelen te bekijken. Het primaire doel van deze methode is het ophalen van informatie voor gebruik in het versieren van de interface (bijvoorbeeld het aangeven van de toegangsstatus met vergrendelings- en ontgrendelpictogrammen). De geheime voorgeheugen parametercontroles of het interne geheime voorgeheugen voor het oplossen van middelen wordt gebruikt.

API-aanroep: stel de momenteel geselecteerde provider in
code language-none 
- (void) checkPreauthorizedResources:(NSArray *)resources cache:(BOOL)cache;

Beschikbaarheid: v3.1+

Parameters:

  • middelen: serie van middelen waarvoor de vergunning zou moeten worden gecontroleerd. Elk element in de lijst moet een tekenreeks zijn die de bron-id vertegenwoordigt. Voor de bron-id gelden dezelfde beperkingen als voor de bron-id in de aanroep van getAuthorization: . Dit houdt in dat er een waarde moet worden overeengekomen tussen de programmeur en de MVPD of een RSS-fragment voor media.
  • geheime voorgeheugen: Van Boole die of specificeert om het interne geheime voorgeheugen voor het oplossen van middelen te gebruiken. Als de waarde false is, wordt de cache overgeslagen, wat leidt tot serveraanroepen telkens wanneer deze API wordt aangeroepen.

callback teweeggebracht: preauthorizedResources:

Terug naar boven…

preauthorisedResources: preauthResources

Dossier: AccessEnabler/headers/EntitlementDelegate.h

Beschrijving: Callback die door checkPreauthorizedResources: wordt teweeggebracht. Verstrekt een lijst van middelen de gebruiker reeds aan mening wordt gemachtigd.

API-aanroep: stel de momenteel geselecteerde provider in
code language-none 
- (void) checkPreauthorizedResources:(NSArray *)resources;

Beschikbaarheid: v1.3+

Parameters:

  • resources: array met bronnen waarvoor de gebruiker al gemachtigd is om deze weer te geven.

teweeggebracht door: checkPreauthorizedResources:

Terug naar boven…

checkAuthorization:, checkAuthorization:withData: checkAuthZ

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: Deze methode wordt gebruikt door de toepassing om de vergunningsstatus te controleren. Het begint door de authentificatiestatus eerst te controleren. Als deze niet is geverifieerd, wordt de callback van tokenRequestFailed:errorCode:errorDescription: geactiveerd en wordt de methode afgesloten. Als de gebruiker voor authentiek wordt verklaard, teweegbrengt het ook de vergunningsstroom. Zie details over de methode getAuthorization: .

API-aanroep: autorisatiestatus controleren
code language-none 
- (void) checkAuthorization:(NSString *)resource;

Beschikbaarheid: v1.0+

API-aanroep: autorisatiestatus controleren
code language-none 
- (void) checkAuthorization:(NSString *)resource:
                   withData:(NSDictionary *)data;

Beschikbaarheid: v1.9+

Parameters:

  • middel: identiteitskaart van het middel waarvoor de gebruiker om toestemming verzoekt.
  • gegevens: Een woordenboek dat uit zeer belangrijk-waardeparen bestaat die naar de de omslagdienst van betaaltelevisie moeten worden verzonden. Adobe kan deze gegevens gebruiken om toekomstige functionaliteit mogelijk te maken zonder de SDK te wijzigen.

teweeggebrachte callbacks:

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

Terug naar boven…

getAuthorization:, getAuthorization:withData: getAuthZ

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: Deze methode wordt gebruikt door de toepassing om de vergunningsstroom in werking te stellen. Als de gebruiker niet reeds voor authentiek wordt verklaard, stelt het ook de authentificatiestroom in werking. Als de gebruiker voor authentiek wordt verklaard, gaat AccessEnabler te werk om verzoeken om het toestemmingstoken (als geen geldig toestemmingstoken in het lokale symbolische geheime voorgeheugen) en voor het kortstondige media token uit te geven. Zodra het korte media token is verkregen, wordt de autorisatiestroom als volledig beschouwd. De callback van setToken:forResource: wordt teweeggebracht en het korte media teken wordt geleverd als parameter aan de toepassing. Als de autorisatie om welke reden dan ook mislukt, wordt de callback van tokenRequestFailed:forEventType: geactiveerd en worden de foutcode/details weergegeven.

API-aanroep: de machtigingsstroom starten
code language-none 
- (void) getAuthorization:(NSString *)resource;

Beschikbaarheid: v1.0+

API-aanroep: de machtigingsstroom starten
code language-none 
- (void) getAuthorization:(NSString *)resource:
                 withData:(NSDictionary *)data;

Beschikbaarheid: v1.9+

Parameters:

  • middel: identiteitskaart van het middel waarvoor de gebruiker om toestemming verzoekt.
  • gegevens: Een woordenboek dat uit zeer belangrijk-waardeparen bestaat die naar de de omslagdienst van betaaltelevisie moeten worden verzonden. Adobe kan deze gegevens gebruiken om toekomstige functionaliteit mogelijk te maken zonder de SDK te wijzigen.

teweeggebrachte callbacks: tokenRequestFailed:errorCode:errorDescription:, setToken:forResource:,sendTrackingData:forEventType:

extra teweeggebrachte callbacks:
Deze methode kan ook de volgende callbacks activeren (als de verificatiestroom ook wordt gestart): setAuthenticationStatus:errorCode:, displayProviderDialog:

NOTE
Gebruik waar mogelijk checkAuthorization: / checkAuthorization:withData: in plaats van getAuthorization: / getAuthorization:withData: . Met de methode getAuthorization: / getAuthorization:withData: wordt een volledige verificatiestroom gestart (als de gebruiker niet is geverifieerd). Dit kan leiden tot een gecompliceerde implementatie aan de kant van de programmeur.

Terug naar boven…

setToken:forResource: setToken

Dossier: AccessEnabler/headers/EntitlementDelegate.h

Omschrijving Callback die door AccessEnabler wordt teweeggebracht die uw toepassing meedeelt dat de vergunningsstroom met succes werd voltooid. Het media-token voor korte tijd wordt ook als een parameter geleverd.

Callback: autorisatiestroom is voltooid
code language-none 
- (void) setToken:(NSString *)token
      forResource:(NSString *)resource;

Beschikbaarheid: v1.0+

Parameters:

  • teken: het korte-levende media teken
  • middel: het middel waarvoor de vergunning werd verkregen

teweeggebracht door: checkAuthorization: , checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:

Terug naar boven…

tokenRequestFailed:errorCode:errorDescription: tokenReqFailed

Dossier: AccessEnabler/headers/EntitlementDelegate.h

Omschrijving Callback die door AccessEnabler wordt teweeggebracht die de upper-layer toepassing informeert dat de vergunningsstroom ontbrak.

Callback: autorisatiestroom mislukt
code language-none 
- (void) tokenRequestFailed:(NSString *)resource
                  errorCode:(NSString *)code
           errorDescription:(NSString *)description;

Beschikbaarheid: v1.0+

Parameters:

  • middel: Het middel waarvoor de vergunning werd verkregen.
  • code: De foutencode verbonden aan het mislukkingsscenario. Mogelijke waarden:
    • USER_NOT_AUTHORIZED_ERROR - de gebruiker kan geen autorisatie uitvoeren
      voor de gegeven bron
  • beschrijving: De extra details over het mislukkingsscenario. Als dit beschrijvende koord om het even welke reden niet beschikbaar is, verzendt de Authentificatie van Adobe Pass een leeg koord (""").
    Deze tekenreeks kan door een MVPD worden gebruikt om aangepaste foutberichten of verkoopberichten door te geven. Als een abonnee bijvoorbeeld geen toestemming voor een resource krijgt, kan de MVPD een bericht verzenden zoals: "U hebt momenteel geen toegang tot dit kanaal in uw pakket. Als u uw pakket zou willen bevorderen klikt hier." Het bericht wordt overgegaan door de Authentificatie van Adobe Pass door deze callback aan Programmer, die de optie heeft om het te tonen of te negeren. Adobe Pass Authentication kan deze parameter ook gebruiken om meldingen te verzenden over de voorwaarde die tot een fout kan hebben geleid. Bijvoorbeeld, "kwam een netwerkfout voor toen het communiceren met de de vergunningsdienst van de leverancier".

teweeggebracht door: checkAuthorization:, checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:

Terug naar boven…

afmelden logout

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: Deze methode wordt geroepen door uw toepassing om de logout stroom in werking te stellen. De logout is het resultaat van een reeks HTTP-omleidingsbewerkingen omdat de gebruiker moet worden afgemeld bij zowel de Adobe Pass Authentication-servers als bij de MVPD-servers. Omdat deze stroom niet kan worden voltooid met een eenvoudige HTTP-aanvraag die is uitgegeven door de AccessEnabler-bibliotheek, moet een UIWebView/WKWebView or SFSafariViewController -controller worden geïnstantieerd om de HTTP-omleidingsbewerkingen te kunnen volgen.

De logout-flow verschilt van de verificatiestroom omdat de gebruiker op geen enkele wijze met de UIWebView/WKWebView or SFSafariViewController -controller hoeft te communiceren. Daarom adviseert de Adobe dat u de controle onzichtbaar (d.w.z. verborgen) tijdens het logout proces maakt.

Een patroon gelijkend op de authentificatiestroom wordt gebruikt. De iOS AccessEnabler activeert de callback navigateToUrl: of de navigateToUrl:useSVC: om een controller UIWebView/WKWebView or SFSafariViewController te maken en de URL te laden die in de parameter url van de callback wordt opgegeven. Dit is URL van het logout eindpunt op de achtergrondserver. Voor tvOS AccessEnabler wordt noch de callback navigateToUrl: , noch de callback navigateToUrl:useSVC: aangeroepen.

Aangezien het door verscheidene omleidingen gaat, moet uw toepassing de activiteit van het UIWebView/WKWebView or SFSafariViewController controlemechanisme controleren en het moment ontdekken wanneer het een specifieke douane URL laadt. Deze specifieke aangepaste URL is in feite ongeldig en is niet bestemd voor de controller om deze daadwerkelijk te laden. Het moet door uw toepassing slechts als signaal worden geïnterpreteerd dat de logout stroom heeft voltooid en dat het veilig is om het controlemechanisme te sluiten. Wanneer het controlemechanisme deze specifieke douane URL laadt moet uw toepassing het controlemechanisme sluiten en de API methode van AccessEnabler handleExternalURL:url roepen. In het geval dat uw toepassing a SFSafariViewController controlemechanisme moet gebruiken wordt de specifieke douane URL bepaald door uw application's custom scheme (b.v. adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com), anders wordt deze specifieke douane URL bepaald door de ADOBEPASS_REDIRECT_URL constante (d.w.z. adobepass://ios.app).

Uiteindelijk zal AccessEnabler setAuthenticationStatus() callback met een statuscode van 0 roepen, die op succes van de logout stroom wijst.

Nota: als de gebruiker het programma wordt geopend gebruikend Apple SSO zal de status VSA203 worden teweeggebracht. Als dit het geval is, zou de gebruiker moeten worden geïnstrueerd om zich van de systeemmontages ook te melden. Als u dit niet doet, wordt de verificatie opnieuw uitgevoerd wanneer de toepassing opnieuw wordt gestart.

API-aanroep: de afmeldingsstroom starten
code language-none 
- (void) logout;

Beschikbaarheid: v1.0+

Parameters: niets

teweeggebrachte callbacks: navigateToUrl:, setAuthenticationStatus:errorCode:

Terug naar boven…

getSelectedProvider getSelProv

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: gebruik deze methode om de momenteel geselecteerde leverancier te bepalen.

API-aanroep: de momenteel geselecteerde MVPD bepalen
code language-none 
- (void) getSelectedProvider;

Beschikbaarheid: v1.0+

Parameters: niets

teweeggebrachte callbacks: selectedProvider:

Terug naar boven…

selectedProvider selProv

Dossier: AccessEnabler/headers/EntitlementDelegate.h

Omschrijving Callback die door AccessEnabler wordt teweeggebracht die informatie over momenteel geselecteerde MVPD aan de toepassing levert.

Callback: informatie over de momenteel geselecteerde MVPD
code language-none 
- (void) selectedProvider:(MVPD *)mvpd;

Beschikbaarheid: v1.0+

Parameters:

  • mvpd: voorwerp dat informatie over momenteel geselecteerde MVPD bevat

teweeggebracht door: getSelectedProvider

Terug naar boven…

getMetadata: getMeta

Dossier: AccessEnabler/headers/AccessEnabler.h

Beschrijving: gebruik deze methode om informatie terug te winnen die als meta-gegevens door de bibliotheek AccessEnabler wordt blootgesteld. De toepassing kan tot deze gegevens toegang hebben door een op woordenboek-gebaseerde sleutel inputparameter te verstrekken.

Er zijn twee soorten meta-gegevens beschikbaar aan Programmeurs:

  • Statische metagegevens (verificatietoken TTL, machtigingstoken-TTL en apparaat-id)
  • Metagegevens van gebruikers (gebruikersspecifieke informatie, zoals gebruikersnaam en postcode; kan tijdens de verificatie- en autorisatiestromen van een MVPD naar het apparaat van een gebruiker worden doorgegeven)
API-aanroep: de AccessEnabler vragen naar metagegevens
code language-none 
- (void) getMetadata:(NSDictionary *)keyDictionary;

Beschikbaarheid: v1.0+

Parameters:

  • keyDictionary: een structuur van woordenboekgegevens, met het volgende
    indeling:

    • Als de sleutel METADATA_OPCODE_KEY is en de waarde METADATA_AUTHENTICATION is, dan wordt de vraag gemaakt om de vervaltijd van het authentificatietoken te verkrijgen.

    • Als de sleutel METADATA_OPCODE_KEY is en de waarde METADATA_AUTHORIZATION is en
      key is METADATA_RESOURCE_ID_KEY en de waarde is een bepaalde middelID, dan wordt de vraag gemaakt om de vervaltijd van het toestemmingstoken te verkrijgen verbonden aan het gespecificeerde middel.

    • Als de toets METADATA_OPCODE_KEY is en de waarde METADATA_DEVICE_ID is, wordt de query uitgevoerd om de huidige apparaat-id te verkrijgen. Deze functie is standaard uitgeschakeld en programmeurs moeten contact opnemen met de Adobe voor informatie over de mogelijkheden en kosten.

    • Als de sleutel METADATA_OPCODE_KEY is en de waarde METADATA_USER_META is en de sleutel is METADATA_USER_META_KEY en de waarde is de naam van de meta-gegevens, dan wordt de vraag gemaakt voor gebruikersmeta-gegevens. De lijst met beschikbare metagegevenstypen voor gebruikers:

      • zip - Lijst met postcodes
      • householdID - Huishoudelijke id. Als een MVPD geen subaccounts ondersteunt, is dit gelijk aan userID .
      • maxRating - Een verzameling van maximale ouderlijke classificaties voor de gebruiker
      • userID - De gebruikers-id. Als een MVPD subaccounts ondersteunt en de gebruiker niet de hoofdaccount is, zal userID anders zijn dan householdID.
      • channelID - Een lijst met kanalen die een gebruiker mag bekijken.
    note note
    NOTE
    De werkelijke gebruikersmetagegevens die beschikbaar zijn voor een programmeur, zijn afhankelijk van wat een MVPD beschikbaar stelt. Deze lijst wordt uitgebreid wanneer nieuwe metagegevens beschikbaar worden gemaakt en worden toegevoegd aan het Adobe Pass-verificatiesysteem.

teweeggebrachte callbacks: setMetadataStatus:encrypted:forKey:andArguments:

Meer Informatie: Metagegevens van de Gebruiker

Terug naar boven…

presentTVProviderDialog presentTvDialog

Dossier: AccessEnabler/headers/EntitlementDelegate.h

Omschrijving Callback die door AccessEnabler na het roepen van wordt teweeggebracht getAuthentication ()als de huidige aanvrager minstens één MVPD met steun SSO steunt.

Callback: resultaat van SSO-stromen
code language-none 
- (void) presentTvProviderDialog: (UIViewController *) viewController;

Beschikbaarheid: v2.0+

Parameters:

  • viewController: vertegenwoordigt het Apple SSO-dialoogvenster. Deze viewController moet op het scherm worden getoond.

teweeggebracht door: getAuthentication

Meer Informatie: iOS/tvOS enig Teken

Terug naar boven…

TVProviderDialog negeren dismissTvDialog

Dossier: AccessEnabler/headers/EntitlementDelegate.h

Beschrijving Callback die door AccessEnabler wordt teweeggebracht nadat de gebruiker de Dialoog van Apple SSO sluit.

Callback: resultaat van SSO-stromen
code language-none 
- (void) dismissTvProviderDialog: (UIViewController *) viewController;

Beschikbaarheid: v2.0+

Parameters:

  • viewController: vertegenwoordigt het Apple SSO-dialoogvenster. Deze viewController moet van het scherm worden verwijderd.

teweeggebracht door: actie van de Gebruiker

Meer Informatie: iOS/tvOS enig Teken

Terug naar boven…

setMetadataStatus:encrypted:forKey:andArguments: setMetaStatus

Dossier: AccessEnabler/headers/EntitlementDelegate.h

Beschrijving Callback die door AccessEnabler wordt teweeggebracht die de meta-gegevens levert die via een getMetadata: vraag worden gevraagd.

Callback: resultaat van verzoek om metagegevens op te halen
code language-none 
- (void) setMetadataStatus:(id)metadata
                 encrypted:(bool)encrypted
                    forKey:(int)key
              andArguments:(NSDictionary *)arguments;

Beschikbaarheid: v1.0+

Parameters:

  • meta-gegevens: De gevraagde meta-gegevens. Deze waarde is een NSString in het geval van statische metagegevens (TTL voor verificatie, TTL voor autorisatie, apparaat-id). Het is een complex object wanneer u gebruikersspecifieke metagegevens aanvraagt. Dit complexe object is doorgaans de Objectief-C-representatie van een JSON-payload (bijvoorbeeld '{"street": "Main Avenue", "building": [ "150", "320"]' wordt in doelstelling-C vertaald als NSDictionary("street" -> "Main Avenue", "building" -> NSArray("15 0", "320"). Voorbeeld van JSON-object voor metagegevens:
        {
            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"]
            }

  • gecodeerd: De waarde van Boole die specificeert als de teruggewonnen meta-gegevens al dan niet wordt gecodeerd. Deze parameter is alleen van belang voor verzoeken van metagegevens van gebruikers. Deze parameter heeft geen betekenis voor statische metagegevens (bijvoorbeeld TTL voor verificatie) die altijd ongecodeerd worden ontvangen. Als deze parameter aan waar wordt geplaatst, dan is het aan programmeur om de niet gecodeerde waarde van Metagegevens van de Gebruiker te verkrijgen door een decryptie van RSA uit te voeren gebruikend whitelingende privé sleutel (de zelfde privé sleutel die voor het ondertekenen van identiteitskaart van de Aanvrager in setRequestor:setSignedRequestorId: en setRequestor:setSignedRequestorId:serviceProviders: vraag wordt gebruikt).

  • sleutel: De sleutel die wordt gebruikt om het verzoek van de meta-gegevensherwinning te formuleren.

  • argumenten: Het zelfde woordenboek dat tot de getMetadata: vraag werd overgegaan. Dit wordt verstrekt om de toepassing toe te staan om de verzoeken met de reacties te passen.

teweeggebracht door: getMetadata:

Meer Informatie: Metagegevens van de Gebruiker

Terug naar boven…

MVPD mvpd

Dossier: AccessEnabler/headers/model/MVPD.h

Beschrijving beschrijft het voorwerp van MVPD. Kan worden gebruikt om informatie over de MVPD-eigenschappen te verkrijgen.

Beschikbaarheid: v1.0+ [ boardingStatus bezit is beschikbaar van v2.2 ]

Eigenschappen:

  • (NSString) ID - De MVPD-id.

  • (NSString) displayName - De naam van MVPD. [ dit zou moeten worden gebruikt aan vertoning in de plukker ]

  • (NSString) logoURL - Het adres van het MVPD-logo.

  • (BOOL) enablePlatformServices - als waar, steunt MVPD de diensten SSO zoals Apple SSO.

  • (NSString) boardingStatus - kan 3 waarden hebben:

    • 0 - De MVPD biedt geen ondersteuning voor Apple SSO.
    • PICKER - De MVPD kan worden weergegeven in de Apple-kiezer, maar de verificatiestroom wordt uitgevoerd door Adobe.
    • ONDERSTEUND - De MVPD wordt volledig ondersteund door Apple en gebruikt Apple SSO-token.

Terug naar boven…

Gebeurtenissen bijhouden tracking

AccessEnabler teweegbrengt een extra callback teweeg die niet noodzakelijk met de machtigingsstromen verwant is. Het implementeren van de callback-functie sendTrackingData() is optioneel, maar de toepassing kan specifieke gebeurtenissen volgen en statistieken compileren, zoals het aantal geslaagde/mislukte verificatie-/autorisatiepogingen.

sendTrackingData sendTracking

Dossier: AccessEnabler/headers/EntitlementDelegate.h

Omschrijving Callback die door AccessEnabler wordt teweeggebracht signalerend aan de toepassing het voorkomen van diverse gebeurtenissen zoals de voltooiing/de mislukking van authentificatie/vergunningsstromen. Bij Adobe Pass-verificatie 1.6 worden het apparaattype, het AccessEnabler-clienttype en het besturingssysteem gerapporteerd door sendTrackingData() . De callback van sendTrackingData() blijft compatibel met oudere versies.

Callback: het volgen gebeurtenissen

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

Beschikbaarheid: v1.0+

Nota: het apparatentype en het werkende systeem worden afgeleid door het gebruik van een openbare bibliotheek van Java (http://java.net/projects/user-agent-utils) en het koord van de gebruikersagent. Deze informatie wordt alleen verstrekt als een ruwe manier om operationele meetgegevens in apparatencategorieën op te delen, maar die Adobe kan geen verantwoordelijkheid voor onjuiste resultaten nemen. Gebruik de nieuwe functionaliteit.

  • Mogelijke waarden voor apparaattype:

    • computer
    • tablet
    • mobile
    • gameconsole
    • unknown

  • Mogelijke waarden voor client type AccessEnabled:

    • flash
    • html5
    • ios
    • android

Parameters:

  • gebeurtenis: de code van de gebeurtenis die wordt gevolgd. Er zijn drie mogelijke gebeurtenistypen voor bijhouden:

    • authenticationDetection: om het even welke tijd een verzoek van het toestemmingstoken terugkeert (de gebeurtenis is TRACKING_AUTHORIZATION)
    • authenticationDetection: om het even welke tijd een authentificatiecontrole voorkomt (de gebeurtenis is TRACKING_AUTHENTICATION)
    • mvpdSelection: wanneer de gebruiker een MVPD in de de selectievorm van MVPD selecteert (de gebeurtenis is TRACKING_GET_SELECTED_PROVIDER)

  • gegevens: extra gegevens die aan de gemelde gebeurtenis worden geassocieerd. Deze gegevens worden gepresenteerd in de vorm van een lijst met waarden.

teweeggebracht door: checkAuthentication, getAuthentication, getAuthentication:withData:, checkAuthorization:, checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:, setSelectedProvider:

Instructies voor het interpreteren van de waarden in de gegevens serie:

  • Voor trackingEventType TRACKING_AUTHENTICATION:

    • 0 - of het symbolische verzoek succesvol (waar/vals) was en als succesvol:
    • 1 - het koord van identiteitskaart van MVPD
    • 2 - GUID (md5 hashed)
    • 3 - Symbolisch reeds in geheim voorgeheugen (waar/vals)
    • 4 - het type van Apparaat
    • 5 - Het cliënttype van AccessEnabler
    • 6 - Het type van werkend systeem

  • Voor trackingEventType TRACKING_AUTHORIZATION:

    • 0 - of het symbolische verzoek succesvol (waar/vals) was en als succesvol:
    • 1 - identiteitskaart van MVPD
    • 2 - GUID (md5 hashed)
    • 3 - Symbolisch reeds in geheim voorgeheugen (waar/vals)
    • 4 - Fout
    • 5 - Details
    • 6 - het type van Apparaat
    • 7 - Het cliënttype van AccessEnabler
    • 8 - Het type van werkend systeem

  • Voor trackingEventType TRACKING_GET_SELECTED_PROVIDER:

    • 0 - identiteitskaart van momenteel geselecteerde MVPD
    • 1 - het type van Apparaat
    • 2 - Het cliënttype van AccessEnabler
    • 3 - Het type van werkend systeem
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b