iOS/tvOS SDK API Reference iostvos-sdk-api-reference

Introduction intro

This page describes the methods and callback functions exposed by the iOS/tvOS native client for Adobe Pass Authentication. The methods and callback functions described here are defined in the AccessEnabler.h and EntitlementDelegate.h header files; you can find them in the iOS AccessEnabler SDK here: [SDK directory]/AccessEnabler/headers/api/

Associated documentation:

API Reference apis

init:softwareStatement initWithSoftwareStatement

File: AccessEnabler/headers/AccessEnabler.h

Description: Instantiates the AccessEnabler object. There should be a single AccessEnabler instance per application instance.

Availability: v3.0+

Parameters:

Back to top…

init - [DEPRECATED] init

File: AccessEnabler/headers/AccessEnabler.h

Description: Instantiates the AccessEnabler object. There should be a single AccessEnabler instance per application instance.

Availability: v1.0+ Until: v3.0

Parameters: None

Back to top…

setOptions:options setOptions

File: AccessEnabler/headers/AccessEnabler.h

Description: Configures global SDK options. It accepts an NSDictionary as an argument. The values from the dictionary will be passed to the server along with every network call that the SDK makes.

Note: The values will be passed to the server independent of the current flow (authentication/authorization). If you want to change the values you can call this method at any point in time.

Availability: v2.3.0+

Parameters:

Back to top…

setRequestor:requestorID, setRequestor:requestorID:serviceProviders: setReqV3

File: AccessEnabler/headers/AccessEnabler.h

Description: Establishes the identity of the Programmer. Each Programmer is assigned a unique ID upon registering with Adobe for the Adobe Pass Authentication system. When dealing with SSO and remote tokens, the authentication state can change when the application is in the background, setRequestor can be called again when the application is brought into the foreground in order to synchronize with the system state (fetch a remote token if SSO is enabled or delete the local token if a logout happened in the meantime).

The server response contains a list of MVPDs together with some configuration information that is attached to the identity of the Programmer. The server response is used internally by the AccessEnabler code. Only the status of the operation (i.e., SUCCESS/FAIL) is presented to your application via the setRequestorComplete: callback.

If the urls parameter is not used, the resulting network call targets the default service provider URL: the Adobe RELEASE/production environment.

If a value is provided for the urls parameter, the resulting network call targets all of the URLs provided in the urls parameter. All configuration requests are triggered simultaneously in separate threads. The first responder takes precedence when compiling the list of MVPDs. For each MVPD in the list, the AccessEnabler remembers the URL of the associated service provider. All subsequent entitlement requests are directed to the URL associated with the service provider that was paired with the target MVPD during the configuration phase.

Availability: v3.0+

Availability: v3.0+

Parameters:

Callbacks triggered: setRequestorComplete:

Back to top…

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

File: AccessEnabler/headers/AccessEnabler.h

Description: Establishes the identity of the Programmer. Each Programmer is assigned a unique ID upon registering with Adobe for the Adobe Pass Authentication system. When dealing with SSO and remote tokens the authentication state can change when the application is in the background, setRequestor can be called again when the application is brought into foreground in order to synchronize with the system state (fetch a remote token if SSO is enabled or delete the local token if a logout happened in the meantime).

The server response contains a list of MVPDs together with some configuration information that is attached to the identity of the Programmer. The server response is used internally by the AccessEnabler code. Only the status of the operation (i.e., SUCCESS/FAIL) is presented to your application via the setRequestorComplete: callback.

If the urls parameter is not used, the resulting network call targets the default service provider URL: the Adobe RELEASE/production environment.

If a value is provided for the urls parameter, the resulting network call targets all of the URLs provided in the urls parameter. All configuration requests are triggered simultaneously in separate threads. The first responder takes precedence when compiling the list of MVPDs. For each MVPD in the list, the AccessEnabler remembers the URL of the associated service provider. All subsequent entitlement requests are directed to the URL associated with the service provider that was paired with the target MVPD during the configuration phase.

Availability: v1.0+ Until: v3.0

Availability: v1.0+ Until: v3.0

Parameters:

Notes: If called without the serviceProviders parameter, the library will retrieve the configuration from the default service provider (that is,https://sp.auth.adobe.com for the production profile or https://sp.auth-staging.adobe.com for the staging profile). If the serviceProviders parameter is provided, it must be an array of URL’s. The configuration information is retrieved from all specified endpoints and is merged. If duplicate information exists in different service provider responses, the conflict is resolved in favor of the fastest responding server (i.e., the server with the shortest response time takes precedence).

Callbacks triggered: setRequestorComplete:

Back to top…

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

File: AccessEnabler/headers/AccessEnabler.h

Description: Establishes the identity of the Programmer. Each Programmer is assigned a unique ID upon registering with Adobe for the Adobe Pass Authentication system. This setting should be performed only once during the application’s life cycle.

The server response contains a list of MVPDs together with some configuration information that is attached to the identity of the Programmer. The server response is used internally by the AccessEnabler code. Only the status of the operation (i.e., SUCCESS/FAIL) is presented to your application via the setRequestorComplete: callback.

If the urls parameter is not used, the resulting network call targets the default service provider URL: the Adobe RELEASE/production environment.

If a value is provided for the urls parameter, the resulting network call targets all of the URLs provided in the urls parameter. All configuration requests are triggered simultaneously in separate threads. The first responder takes precedence when compiling the list of MVPDs. For each MVPD in the list, the AccessEnabler remembers the URL of the associated service provider. All subsequent entitlement requests are directed to the URL associated with the service provider that was paired with the target MVPD during the configuration phase.

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

Availability: v2.0+ Until: v3.0

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

Availability: v2.0+ Until: v3.0

Parameters:

If called without the serviceProviders parameter, the library will retrieve the configuration from the default service provider (i.e., https://sp.auth.adobe.com for the production profile or https://sp.auth-staging.adobe.com for the staging profile). If the serviceProviders parameter is provided, it must be an array of URL’s. The configuration information is retrieved from all specified endpoints and is merged. If duplicate information exists in different service provider responses, the conflict is resolved in favor of the fastest responding server (i.e., the server with the shortest response time takes precedence).

Callbacks triggered: setRequestorComplete:

Back to top…

setRequestorComplete: setReqComplete

File: AccessEnabler/headers/EntitlementDelegate.h

Description Callback triggered by the AccessEnabler that informs your application that the configuration phase is complete. This is a signal that the app can start issuing entitlement requests. No entitlement requests can be issued by the application until the configuration phase is complete.

- (void) setRequestorComplete:(int)status;

Availability: v1.0+

Parameters:

Triggered by:

setRequestor:setSignedRequestorId:, setRequestor:setSignedRequestorId:serviceProviders:

Back to top…

checkAuthentication checkAuthN

File: AccessEnabler/headers/AccessEnabler.h

Description: Checks the authentication status of the current user.
It does this by searching for a valid authentication token in the local
token storage space. This method performs no network calls and we recommend calling it on the main thread.
It is used by the application to query the user’s authentication status and
update the UI accordingly (i.e., update the login/logout UI). The
authentication status is communicated to the application via
the setAuthenticationStatus:errorCode: callback.

- (void) checkAuthentication;

Availability: v1.0+

Parameters: None

Callbacks triggered:
setAuthenticationStatus:errorCode:

Back to top…

getAuthentication, getAuthentication:withData: getAuthN

File: AccessEnabler/headers/AccessEnabler.h

Description: Starts the full authentication workflow. It starts by checking the authentication status. If not already authenticated, the authentication flow state-machine is started:

As the user’s credentials are verified on the MVPD login page, your application is required to monitor the multiple redirection operations that take place while the user authenticates at the MVPD’s login page. When the correct credentials are entered, the WebView control is redirected to a custom URL defined by the ADOBEPASS_REDIRECT_URL constant. This URL is not intended to be loaded by the WebView. The application must intercept this URL and interpret this event as a signal that the login phase is complete. It should then hand over control to the AccessEnabler in order to complete the authentication flow (by calling the handleExternalURL method).

Finally, the authentication status is communicated to the application via the setAuthenticationStatus:errorCode: callback.

- (void) getAuthentication;

Availability: v1.0+

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

Availability: v1.9+

Parameters:

Callbacks triggered: setAuthenticationStatus:errorCode:, displayProviderDialog:, sendTrackingData:forEventType:

Back to top…

getAuthentication:filter, getAuthentication:withData:andFilter getAuthN_filter

File: AccessEnabler/headers/AccessEnabler.h

Description: Starts the full authentication workflow. It starts by checking the authentication status. If not already authenticated, the authentication flow state-machine is started:

Finally, the authentication status is communicated to the application via the setAuthenticationStatus:errorCode: callback.

Availability: v2.4+

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

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

Parameters:

Availability: v2.0 - v2.3.1

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

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

Parameters:

Callbacks triggered: setAuthenticationStatus:errorCode:, presentTvProviderDialog, dismissTvProviderDialog

Back to top…

displayProviderDialog: dispProvDialog

File: AccessEnabler/headers/EntitlementDelegate.h

Description Callback triggered triggered by the AccessEnabler to inform the application that the appropriate UI elements need to be instantiated to allow the user to select the desired MVPD. The callback provides a list of MVPD objects with additional information that can help to correctly build the selection UI panel (such as the URL pointing to the MVPD’s logo, friendly display name, etc.)

Once the user has selected the desired MVPD, the upper-layer application is required to resume the authentication flow by calling setSelectedProvider: and passing it the ID of the MVPD corresponding to the user’s selection.

Aborting the authentication flow - This is a point where the user has the ability to press the “Back” button, which is equivalent to aborting the authentication flow. In that scenario, your application is required to call the setSelectedProvider: method, passing null as the parameter, to give the AccessEnabler the opportunity to reset its authentication state-machine.

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

Availability: v1.0+

Parameters:

Triggered by: getAuthentication, getAuthentication:withData:,getAuthorization:, getAuthorization:withData:

Back to top…

setSelectedProvider: setSelProv

File: AccessEnabler/headers/AccessEnabler.h

Description: This method is called by your application to inform the Access Enabler of the user’s MVPD selection. The application can use this method to select or change the service provider used for authentication.

If the MVPD selected is a TempPass MVPD it will automatically authenticate with that MVPD without needing to call getAuthentication() afterwards.

Please note that this is not possible for Promotional Temp Pass where extra parameters are given on getAuthentication() method.

When passing null as a parameter, the Access Enabler assumes that the user has canceled the authentication flow (i.e. pressed the “Back” button), and responds by resetting the authentication state-machine and by calling the setAuthenticationStatus:errorCode: callback with the AccessEnabler.PROVIDER_NOT_SELECTED_ERROR error code.

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

Availability: v1.0+

Parameters: None

Callbacks triggered: setAuthenticationStatus:errorCode:,sendTrackingData:forEventType:, navigateToUrl:

Back to top…

navigateToUrl: nav2url

File: AccessEnabler/headers/EntitlementDelegate.h

Description: Callback triggered by the AccessEnabler to request your application to instantiate a UIWebView/WKWebView controller and to load the URL provided in the callback’s url parameter. The callback passes the url parameter which represents the URL of the authentication endpoint or the URL of the logout endpoint.

As the UIWebView/WKWebView controller goes through several redirects, your application must monitor the activity of the controller and detect the moment when it loads a specific custom URL defined by the ADOBEPASS_REDIRECT_URL constant (i.e. adobepass://ios.app). Note that this specific custom URL is actually invalid, and it is not intended for the controller to actually load it. It must be only interpreted by your application as a signal that the authentication or logout flow has completed and that it is safe to close the controller. When the controller loads this specific custom URL your application must close the UIWebView/WKWebView and call AccessEnabler’s handleExternalURL:url API method.

Note: Please note that in case of the authetication flow this is a point where the user has the ability to press the “Back” button, which is equivalent to the aborting of the authentication flow. In such a scenario, your application is required to call the setSelectedProvider: method passing nil as the parameter and giving a chance to the AccessEnabler to reset its authentication state-machine.

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

Availability: v1.0+

Parameters:

Triggered by: setSelectedProvider:

Back to top…

navigateToUrl:useSVC: nav2urlSVC

File: AccessEnabler/headers/EntitlementDelegate.h

Description: Callback triggered by the AccessEnabler instead of the navigateToUrl: callback in case your application previously enabled manual Safari View Controller (SVC) handling via the setOptions([“handleSVC”:true"]) call, and only in case of MVPDs requiring Safari View Controller (SVC). For all other MVPDs the navigateToUrl: callback will be called. Please seeSFSafariViewController support on iOS SDK 3.2+ for details on how Safari View Controller (SVC) should be managed.

Similar to the navigateToUrl: callback the navigateToUrl:useSVC: is triggered by the AccessEnabler to request your application to instantiate a SFSafariViewController controller and to load the URL provided in the callback’s url parameter. The callback passes the url parameter which represents the URL of the authentication endpoint or the URL of the logout endpoint, and the useSVC parameter which specifies that the application must use a SFSafariViewController.

As the SFSafariViewController controller goes through several redirects, your application must monitor the activity of the controller and detect the moment when it loads a specific custom URL defined by your application's custom scheme (e.g.** **adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com). Note that this specific custom URL is actually invalid, and it is not intended for the controller to actually load it. It must be only interpreted by your application as a signal that the authentication or logout flow has completed and that it is safe to close the controller. When the controller loads this specific custom URL your application must close the SFSafariViewController and call AccessEnabler’s handleExternalURL:url API method.

Note: Please note that in case of the authetication flow this is a point where the user has the ability to press the “Back” button, which is equivalent to the aborting of the authentication flow. In such a scenario, your application is required to call the setSelectedProvider: method passing nil as the parameter and giving a chance to the AccessEnabler to reset its authentication state-machine.

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

**Availability:**v 3.2+

Parameters:

Triggered by:setOptions: before setSelectedProvider:

Back to top…

handleExternalURL:url handleExternalURL

File: AccessEnabler/headers/AccessEnabler.h

Description: This method is called by your application to complete the authentication or logout flow. This method should be called right after your application detects the moment when the UIWebView/WKWebView or SFSafariViewController controller is redirected to a specific custom URL. In case your application is required to use a SFSafariViewController controller the specifc custom URL is defined by your application's custom scheme (e.g.adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com), otherwise this specific custom URL is defined by the ADOBEPASS_REDIRECT_URL constant (i.e. adobepass://ios.app).

In case of the authentication flow the AccessEnabler completes the flow by retrieving the authentication token from the back-end server and storing it locally in the token storage. The AccessEnabler will inform your application that the authentication flow is complete by calling the setAuthenticationStatus() callback with a status code of 1, indicating success. If there is an error during the execution of these steps, the setAuthenticationStatus() callback is triggered with a status code of 0, indicating authentication failure, as well as a corresponding error code.

 (void) handleExternalURL:(NSString *)url;

Availability: v3.0+

Parameters:

Callbacks triggered: setAuthenticationStatus:errorCode, sendTrackingData:forEventType:

Back to top…

getAuthenticationToken - [DEPRECATED] getAuthNToken

File: AccessEnabler/headers/AccessEnabler.h

Description: Completes the authentication flow by requesting the authentication token from the back-end server. This method should be called by your application only in response to event where the WebView control hosting the MVPD login page is redirected to the custom URL defined by the ADOBEPASS_REDIRECT_URL constant.

- (void) getAuthenticationToken;

Availability: v1.0+ Until: v3.0

Parameters: None

Callbacks triggered: setAuthenticationStatus:errorCode,sendTrackingData:forEventType:

Back to top…

</br

setAuthenticationStatus:errorCode: setAuthNStatus

File: AccessEnabler/headers/EntitlementDelegate.h

Description Callback triggered by the AccessEnabler which informs the application of the status of the authentication flow. There are many places where this flow can fail, either as a result of user’s interaction or due to other unforeseen scenarios (i.e., network connectivity problems, etc.). This callback informs the application of the success/failure status of the authentication flow, while also providing additional information about the failure reason, when needed.

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

Availability: v1.0+

Parameters:

Triggered by: checkAuthentication, getAuthentication, getAuthentication:withData:, checkAuthorization:, checkAuthorization:withData:

Back to top…

checkPreauthorizedResources: checkPreauth

File: AccessEnabler/headers/AccessEnabler.h

Description: This method is used by the application to determine if the user is already authorized to view specific protected resources. The primary purpose of this method is to retrieve information for use in decorating the UI (for example, indicating access status with lock and unlock icons).

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

Availability: v1.3+

Parameters:

Callback triggered: preauthorizedResources:

Back to top…

checkPreauthorizedResources:cache: checkPreauthCache

File: AccessEnabler/headers/AccessEnabler.h

Description: This method is used by the application to determine if the user is already authorized to view specific protected resources. The primary purpose of this method is to retrieve information for use in decorating the UI (for example, indicating access status with lock and unlock icons). The cache parameter controls wether the internal cache is used for resolving resources.

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

Availability: v3.1+

Parameters:

Callback triggered: preauthorizedResources:

Back to top…

preauthorizedResources: preauthResources

File: AccessEnabler/headers/EntitlementDelegate.h

Description: Callback triggered by checkPreauthorizedResources:. Provides a list of resources the user is already authorized to view.

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

Availability: v1.3+

Parameters:

Triggered by: checkPreauthorizedResources:

Back to top…

checkAuthorization:, checkAuthorization:withData: checkAuthZ

File: AccessEnabler/headers/AccessEnabler.h

Description: This method is used by the application to check the authorization status. It starts by checking the authentication status first. If not authenticated, the tokenRequestFailed:errorCode:errorDescription: callback is triggered, and the method exits. If the user is authenticated, it also triggers the authorization flow. See details on the getAuthorization: method.

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

Availability: v1.0+

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

Availability: v1.9+

Parameters:

Callbacks triggered:

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

Back to top…

getAuthorization:, getAuthorization:withData: getAuthZ

File: AccessEnabler/headers/AccessEnabler.h

Description: This method is used by the application to initiate the authorization flow. If the user is not already authenticated, it also initiates the authentication flow. If the user gets authenticated, the AccessEnabler proceeds to issue requests for the authorization token (if no valid authorization token is present in the local token cache) and for the short-lived media token. Once the short media token is obtained, the authorization flow is considered complete. The setToken:forResource: callback gets triggered and the short media token is delivered as a parameter to the application. If for any reason, the authorization fails, the tokenRequestFailed:forEventType: callback is triggered and the error code/details are provided.

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

Availability: v1.0+

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

Availability: v1.9+

Parameters:

Callbacks triggered: tokenRequestFailed:errorCode:errorDescription:, setToken:forResource:,sendTrackingData:forEventType:

Additional callbacks triggered:
This method can also trigger the following callbacks (if the authentication flow is also initiated): setAuthenticationStatus:errorCode:, displayProviderDialog:

Back to top…

setToken:forResource: setToken

File: AccessEnabler/headers/EntitlementDelegate.h

Description Callback triggered by the AccessEnabler that informs your application that the authorization flow was completed successfully. The short-lived media token is also delivered as a parameter.

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

Availability: v1.0+

Parameters:

Triggered by: checkAuthorization: , checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:

Back to top…

tokenRequestFailed:errorCode:errorDescription: tokenReqFailed

File: AccessEnabler/headers/EntitlementDelegate.h

Description Callback triggered by the AccessEnabler that informs the upper-layer application that the authorization flow failed.

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

Availability: v1.0+

Parameters:

Triggered by: checkAuthorization:, checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:

Back to top…

logout logout

File: AccessEnabler/headers/AccessEnabler.h

Description: This method is called by your application to initiate the logout flow. The logout is the result of a series of HTTP redirect operations due to the fact that the user needs to be logged out from both Adobe Pass Authentication servers and also from the MVPD’s servers. Because this flow cannot be completed with a simple HTTP request issued by the AccessEnabler library, a UIWebView/WKWebView or SFSafariViewController controller needs to be instantiated in order to be able to follow the HTTP redirect operations.

The logout flow differs from the authentication flow in that the user is not required to interact with the UIWebView/WKWebView or SFSafariViewController controller in any way. Therefore, Adobe recommends that you make the control invisible (i.e. hidden) during the logout process.

A pattern similar with the authentication flow is employed. The iOS AccessEnabler triggers the navigateToUrl: callback or the navigateToUrl:useSVC: to create a UIWebView/WKWebView or SFSafariViewController controller and to load the URL provided in the callback’s url parameter. This is the URL of the logout endpoint on the backend server. For the tvOS AccessEnabler neither the navigateToUrl: callback or the navigateToUrl:useSVC: callback is called.

As it goes through several redirects, your application must monitor the activity of the UIWebView/WKWebView or SFSafariViewController controller and detect the moment when it loads a specific custom URL. Note that this specific custom URL is actually invalid, and it is not intended for the controller to actually load it. It must be only interpreted by your application as a signal that the logout flow has completed and that it is safe to close the controller. When the controller loads this specific custom URL your application must close the controller and call AccessEnabler’s handleExternalURL:url API method. In case your application is required to use a SFSafariViewController controller the specifc custom URL is defined by your application's custom scheme (e.g.adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com), otherwise this specific custom URL is defined by the ADOBEPASS_REDIRECT_URL constant (i.e. adobepass://ios.app).

In the end the AccessEnabler will call the setAuthenticationStatus() callback with a status code of 0, indicating success of the logout flow.

Note: If the user is logged in using Apple SSO the VSA203 status will be triggered. If this is the case, the user should be instructed to also logout from the system settings. Failure to do so will result in a re-authentication when the application is re-launched.

- (void) logout;

Availability: v1.0+

Parameters: None

Callbacks triggered: navigateToUrl:, setAuthenticationStatus:errorCode:

Back to top…

getSelectedProvider getSelProv

File: AccessEnabler/headers/AccessEnabler.h

Description: Use this method to determine the currently selected provider.

- (void) getSelectedProvider;

Availability: v1.0+

Parameters: None

Callbacks triggered: selectedProvider:

Back to top…

selectedProvider selProv

File: AccessEnabler/headers/EntitlementDelegate.h

Description Callback triggered by the AccessEnabler that delivers information about the currently selected MVPD to the application.

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

Availability: v1.0+

Parameters:

Triggered by: getSelectedProvider

Back to top…

getMetadata: getMeta

File: AccessEnabler/headers/AccessEnabler.h

Description: Use this method to retrieve information exposed as metadata by the AccessEnabler library. The application can access this data by providing a dictionary-based key input parameter.

There are two types of metadata available to Programmers:

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

Availability: v1.0+

Parameters:

Callbacks triggered: setMetadataStatus:encrypted:forKey:andArguments:

More Information: User Metadata

Back to top…

presentTVProviderDialog presentTvDialog

File: AccessEnabler/headers/EntitlementDelegate.h

Description Callback triggered by the AccessEnabler after callinggetAuthentication() if the current requestor supports at least one MVPD with SSO support.

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

Availability: v2.0+

Parameters:

Triggered by: getAuthentication

More Information: iOS/tvOS Single Sign On

Back to top…

dismissTVProviderDialog dismissTvDialog

File: AccessEnabler/headers/EntitlementDelegate.h

Description Callback triggered by the AccessEnabler after the user closes the Apple SSO Dialog.

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

Availability: v2.0+

Parameters:

Triggered by: User action

More Information: iOS/tvOS Single Sign On

Back to top…

setMetadataStatus:encrypted:forKey:andArguments: setMetaStatus

File: AccessEnabler/headers/EntitlementDelegate.h

Description Callback triggered by the AccessEnabler that delivers the metadata requested via a getMetadata: call.

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

Availability: v1.0+

Parameters:

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

Triggered by: getMetadata:

More Information: User Metadata

Back to top…

MVPD mvpd

File: AccessEnabler/headers/model/MVPD.h

Description Describes the MVPD object. Can be used to obtain information about the MVPD’s properties.

Availability: v1.0+ [boardingStatus property is available from v2.2]

Properties:

Back to top…

Tracking Events tracking

The AccessEnabler triggers an additional callback that is not necessarily related to the entitlement flows. Implementing the sendTrackingData() callback function is optional, but it enables the application to track specific events and compile statistics such as number of successful/failed authentication/authorization attempts.

sendTrackingData sendTracking

File: AccessEnabler/headers/EntitlementDelegate.h

Description Callback triggered by the AccessEnabler signaling to the application the occurrence of various events such as the completion/failure of authentication/authorization flows. With Adobe Pass Authentication 1.6, the device type, AccessEnabler client type, and operating system are reported by sendTrackingData(). The sendTrackingData() callback remains backwards compatible.

Callback: tracking events

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

Availability: v1.0+

Note: The device type and operating system are derived through the use of a public Java library (http://java.net/projects/user-agent-utils) and the user agent string. Be advised that this information is provided only as a coarse way to break down operational metrics into device categories, but that Adobe can take no responsibility for incorrect results. Please use the new functionality accordingly.

Parameters:

Triggered by: checkAuthentication, getAuthentication, getAuthentication:withData:, checkAuthorization:, checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:, setSelectedProvider:

Instructions for interpreting the values in the data array: