iOS/tvOS SDK API リファレンス iostvos-sdk-api-reference

概要 intro

このページでは、iOS/tvOS のネイティブクライアントでAdobe Pass認証用に公開されるメソッドとコールバック関数について説明します。 ここで説明するメソッドとコールバック関数は、 AccessEnabler.h および EntitlementDelegate.h ヘッダーファイル。iOS AccessEnabler SDK の次の場所にあります。 [SDK directory]/AccessEnabler/headers/api/

関連ドキュメント：

API リファレンス apis

init:softwareStatement initWithSoftwareStatement

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： AccessEnabler オブジェクトをインスタンス化します。 アプリケーションインスタンスごとに 1 つの AccessEnabler インスタンスが必要です。

可用性： v3.0 以降

パラメーター：

トップに戻る…

init - [非推奨] init

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： AccessEnabler オブジェクトをインスタンス化します。 アプリケーションインスタンスごとに 1 つの AccessEnabler インスタンスが必要です。

可用性： v1.0 以降 次まで： v3.0

パラメーター： なし

トップに戻る…

setOptions:options setOptions

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： グローバル SDK オプションを設定します。 NSDictionary を引数として受け付けます。 辞書の値は、SDK がおこなうすべてのネットワーク呼び出しと共に、サーバーに渡されます。

注意： 値は、現在のフロー（認証/承認）とは無関係に、サーバーに渡されます。 値を変更する場合は、このメソッドをいつでも呼び出すことができます。

可用性： v2.3.0 以降

パラメーター：

トップに戻る…

setRequestor:requestorID, setRequestor:requestorID:serviceProviders: setReqV3

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： プログラマーの ID を確立します。 各プログラマーは、Adobe Pass認証システムのAdobeに登録する際に、一意の ID を割り当てられます。 SSO とリモートトークンを扱う場合、アプリケーションがバックグラウンドにあるときに認証状態が変わり、システム状態と同期するために、アプリケーションがフォアグラウンドに移行したときに setRequestor を再度呼び出すことができます（SSO が有効な場合はリモートトークンを取得し、ログアウト中にログアウトが発生した場合は削除）。

サーバ応答には、MVPD のリストと、プログラマの ID に付加されるいくつかの設定情報が含まれます。 サーバの応答は、AccessEnabler コードによって内部的に使用されます。 操作のステータス (SUCCESS/FAIL) のみが、 setRequestorComplete: コールバック。

次の場合、 urls パラメーターを使用しない場合、結果のネットワーク呼び出しは、デフォルトのサービスプロバイダー URL(AdobeRELEASE/実稼動環境 ) をターゲットにします。

値が urls パラメーターを渡すと、結果のネットワーク呼び出しでは、 urls パラメーター。 すべての設定リクエストは、別々のスレッドで同時にトリガーされます。 MVPD のリストをコンパイルする際には、最初の応答が優先されます。 リスト内の各 MVPD に対して、AccessEnabler は関連するサービスプロバイダの URL を記憶します。 以降のすべてのエンタイトルメントリクエストは、設定フェーズでターゲット MVPD とペアになったサービスプロバイダーに関連付けられた URL に送られます。

可用性： v3.0 以降

可用性： v3.0 以降

パラメーター：

コールバックがトリガーされました： setRequestorComplete:

トップに戻る…

setRequestor:setSignedRequestorId:, setRequestor:setSignedRequestorId:serviceProviders: - [非推奨] setReq

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： プログラマーの ID を確立します。 各プログラマーは、Adobe Pass認証システムのAdobeに登録する際に、一意の ID を割り当てられます。 SSO とリモートトークンを扱う場合、アプリケーションがバックグラウンドになっているときに認証状態が変わる可能性があります。システム状態と同期するために、アプリケーションがフォアグラウンドに移行したときに setRequestor を再び呼び出すことができます。

サーバ応答には、MVPD のリストと、プログラマの ID に付加されるいくつかの設定情報が含まれます。 サーバの応答は、AccessEnabler コードによって内部的に使用されます。 操作のステータス (SUCCESS/FAIL) のみが、 setRequestorComplete: コールバック。

次の場合、 urls パラメーターを使用しない場合、結果のネットワーク呼び出しは、デフォルトのサービスプロバイダー URL(AdobeRELEASE/実稼動環境 ) をターゲットにします。

値が urls パラメーターを渡すと、結果のネットワーク呼び出しでは、 urls パラメーター。 すべての設定リクエストは、別々のスレッドで同時にトリガーされます。 MVPD のリストをコンパイルする際には、最初の応答が優先されます。 リスト内の各 MVPD に対して、AccessEnabler は関連するサービスプロバイダの URL を記憶します。 以降のすべてのエンタイトルメントリクエストは、設定フェーズでターゲット MVPD とペアになったサービスプロバイダーに関連付けられた URL に送られます。

可用性： v1.0 以降 次まで： v3.0

可用性： v1.0 以降 次まで： v3.0

パラメーター：

メモ： を指定せずに呼び出した場合、 serviceProviders パラメーターを渡す場合、ライブラリはデフォルトのサービスプロバイダー (https://sp.auth.adobe.com （実稼動プロファイルの場合）または https://sp.auth-staging.adobe.com （ステージングプロファイル用）。 次の場合、 serviceProviders パラメーターを指定する場合は、URL の配列である必要があります。設定情報は、指定されたすべてのエンドポイントから取得され、結合されます。 異なるサービスプロバイダ応答に重複した情報が存在する場合、競合は解決され、最も速い応答サーバが優先されます（つまり、応答時間が最も短いサーバが優先されます）。

コールバックがトリガーされました： setRequestorComplete:

トップに戻る…

setRequestor:setSignedRequestorId:secret:publicKey, setRequestor:setSignedRequestorId:serviceProviders:secret:publicKey - [非推奨] setReq_tvos

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： プログラマーの ID を確立します。 各プログラマーは、Adobe Pass認証システムのAdobeに登録する際に、一意の ID を割り当てられます。 この設定は、アプリケーションのライフサイクルの間に 1 回だけ実行する必要があります。

サーバ応答には、MVPD のリストと、プログラマの ID に付加されるいくつかの設定情報が含まれます。 サーバの応答は、AccessEnabler コードによって内部的に使用されます。 操作のステータス (SUCCESS/FAIL) のみが、 setRequestorComplete: コールバック。

次の場合、 urls パラメーターを使用しない場合、結果のネットワーク呼び出しは、デフォルトのサービスプロバイダー URL(AdobeRELEASE/実稼動環境 ) をターゲットにします。

値が urls パラメーターを渡すと、結果のネットワーク呼び出しでは、 urls パラメーター。 すべての設定リクエストは、別々のスレッドで同時にトリガーされます。 MVPD のリストをコンパイルする際には、最初の応答が優先されます。 リスト内の各 MVPD に対して、AccessEnabler は関連するサービスプロバイダの URL を記憶します。 以降のすべてのエンタイトルメントリクエストは、設定フェーズでターゲット MVPD とペアになったサービスプロバイダーに関連付けられた URL に送られます。

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

可用性： v2.0 以降 次まで： v3.0

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

可用性： v2.0 以降 次まで： v3.0

パラメーター：

を指定せずに呼び出した場合、 serviceProviders パラメーターを渡す場合、ライブラリはデフォルトのサービスプロバイダーから設定を取得します ( https://sp.auth.adobe.com 実稼動プロファイルの場合はhttps://sp.auth-staging.adobe.com 、ステージングプロファイルの場合は )。 次の場合、 serviceProviders パラメーターを指定する場合は、URL の配列である必要があります。設定情報は、指定されたすべてのエンドポイントから取得され、結合されます。 異なるサービスプロバイダ応答に重複した情報が存在する場合、競合は解決され、最も速い応答サーバが優先されます（つまり、応答時間が最も短いサーバが優先されます）。

コールバックがトリガーされました： setRequestorComplete:

トップに戻る…

setRequestorComplete: setReqComplete

ファイル： AccessEnabler/headers/EntitlementDelegate.h

説明 構成フェーズが完了したことをアプリケーションに通知する AccessEnabler によってトリガーされるコールバック。 これは、アプリがエンタイトルメントリクエストの発行を開始できることを示すシグナルです。 設定フェーズが完了するまで、アプリケーションはエンタイトルメントリクエストを発行できません。

- (void) setRequestorComplete:(int)status;

可用性： v1.0 以降

パラメーター:

トリガー元：

setRequestor:setSignedRequestorId:, setRequestor:setSignedRequestorId:serviceProviders:

トップに戻る…

checkAuthentication checkAuthN

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： 現在のユーザーの認証状態を確認します。
これをおこなうには、ローカルトークンストレージスペースで有効な認証トークンを検索します。 このメソッドは、ネットワーク呼び出しを実行しないので、メインスレッドで呼び出すことをお勧めします。
アプリケーションは、ユーザーの認証状態を問い合わせ、それに応じて UI を更新するために使用します（つまり、ログイン/ログアウト UI を更新します）。 認証ステータスは、 setAuthenticationStatus:errorCode: コールバック。

- (void) checkAuthentication;

可用性： v1.0 以降

パラメーター： なし

コールバックがトリガーされました：
setAuthenticationStatus:errorCode:

トップに戻る…

getAuthentication, getAuthentication:withData: getAuthN

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： 完全な認証ワークフローを開始します。 まず、認証状態を確認します。 認証済みでない場合は、認証フロー状態マシンが起動します。

ユーザーの資格情報が MVPD ログインページで検証されるので、ユーザーが MVPD のログインページで認証を行う際に実行される複数のリダイレクト操作を監視するには、アプリケーションが必要です。 正しい資格情報が入力されると、WebView コントロールは、 ADOBEPASS_REDIRECT_URL 定数。 この URL は、WebView によって読み込まれるものではありません。 アプリケーションは、この URL を切断し、このイベントをログインフェーズが完了したシグナルとして解釈する必要があります。 次に、認証フローを完了するために、AccessEnabler に制御を渡す必要があります ( handleExternalURL メソッド )。

最後に、認証ステータスは、 setAuthenticationStatus:errorCode: コールバック。

- (void) getAuthentication;

可用性： v1.0 以降

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

可用性： v1.9 以降

パラメーター：

コールバックがトリガーされました： setAuthenticationStatus:errorCode:, displayProviderDialog:, sendTrackingData:forEventType:

トップに戻る…

getAuthentication:filter, getAuthentication:withData:andFilter getAuthN_filter

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： 完全な認証ワークフローを開始します。 まず、認証状態を確認します。 認証済みでない場合は、認証フロー状態マシンが起動します。

最後に、認証ステータスは、 setAuthenticationStatus:errorCode: コールバック。

可用性： v2.4 以降

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

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

パラメーター：

可用性： v2.0 - v2.3.1

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

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

パラメーター：

コールバックがトリガーされました： setAuthenticationStatus:errorCode:, presentTvProviderDialog, dismissTvProviderDialog

トップに戻る…

displayProviderDialog: dispProvDialog

ファイル： AccessEnabler/headers/EntitlementDelegate.h

説明 AccessEnabler によってトリガーされるコールバック。ユーザーが目的の MVPD を選択できるように、適切な UI 要素をインスタンス化する必要があることをアプリケーションに通知します。 このコールバックは、選択 UI パネルを正しく構築するのに役立つ追加情報と共に、MVPD オブジェクトのリストを提供します（MVPD のロゴを示す URL、わかりやすい表示名など）。

ユーザーが目的の MVPD を選択したら、上位レイヤーアプリケーションは、 setSelectedProvider: ユーザーの選択に対応する MVPD の ID を渡す。

認証フローの中止 — これは、ユーザーが「戻る」ボタンを押す機能を持つポイントです。これは、認証フローの中止と同じです。 このシナリオでは、アプリケーションは setSelectedProvider: メソッドで null をパラメータとして渡し、AccessEnabler に認証状態マシンをリセットする機会を与えます。

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

可用性： v1.0 以降

パラメーター:

トリガー元： getAuthentication, getAuthentication:withData:,getAuthorization:, getAuthorization:withData:

トップに戻る…

setSelectedProvider: setSelProv

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： このメソッドは、ユーザーの MVPD 選択を Access Enabler に通知するために、アプリケーションによって呼び出されます。 アプリケーションは、このメソッドを使用して、認証に使用するサービスプロバイダーを選択または変更できます。

選択した MVPD が TempPass MVPD の場合、後で getAuthentication() を呼び出す必要なく、その MVPD で自動的に認証されます。

getAuthentication() メソッドで追加のパラメータが指定されるプロモーション一時パスでは、これは使用できないことに注意してください。

を渡す場合 null パラメータとして、Access Enabler は、ユーザーが認証フローをキャンセルした（つまり「戻る」ボタンを押した）と仮定し、認証状態マシンをリセットし、 setAuthenticationStatus:errorCode: コールバック AccessEnabler.PROVIDER_NOT_SELECTED_ERROR エラーコード。

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

可用性： v1.0 以降

パラメーター： なし

コールバックがトリガーされました： setAuthenticationStatus:errorCode:,sendTrackingData:forEventType:, navigateToUrl:

トップに戻る…

navigateToUrl: nav2url

ファイル： AccessEnabler/headers/EntitlementDelegate.h

説明： AccessEnabler によってトリガーされ、アプリケーションに対して UIWebView/WKWebView コントローラーをインスタンス化し、コールバックの url パラメーター。 このコールバックは、 url 認証エンドポイントの URL またはログアウトエンドポイントの URL を表すパラメーター。

UIWebView/WKWebView として コントローラは、複数のリダイレクトを経由します。アプリケーションは、コントローラのアクティビティを監視し、 ADOBEPASS_REDIRECT_URL 定数 ( adobepass://ios.app) をクリックします。 この特定のカスタム URL は実際には無効で、コントローラが実際に読み込むことを意図していないことに注意してください。 認証フローまたはログアウトフローが完了し、コントローラを安全に閉じられることを示すシグナルとして、アプリケーションでのみ解釈する必要があります。 コントローラがこの特定のカスタム URL を読み込むとき、アプリケーションは UIWebView/WKWebView を閉じて、AccessEnabler の handleExternalURL:url API メソッド。

注意： 認証フローの場合、これは、ユーザーが「戻る」ボタンを押す機能を持つポイントです。これは、認証フローの中止と同じです。 このシナリオでは、アプリケーションは setSelectedProvider: メソッドの受け渡し nil をパラメータとして追加し、AccessEnabler が認証状態マシンをリセットする機会を与える。

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

可用性： v1.0 以降

パラメーター:

トリガー元： setSelectedProvider:

トップに戻る…

navigateToUrl:useSVC: nav2urlSVC

ファイル： AccessEnabler/headers/EntitlementDelegate.h

説明： AccessEnabler ではなく、 navigateToUrl: アプリケーションが以前に手動で Safari ビューコントローラ (SVC) を有効にしていた場合に備え、 setOptions(["handleSVC":true"]) を呼び出し、Safari ビューコントローラ (SVC) を必要とする MVPD の場合にのみ呼び出します。 他のすべての MVPD に対して、 navigateToUrl: コールバックが呼び出されます。 詳しくは、iOS SDK 3.2 以降での SFSafariViewController のサポート Safari View Controller(SVC) の管理方法の詳細。

次に類似 navigateToUrl: コールバック navigateToUrl:useSVC: を呼び出し、AccessEnabler によってアプリケーションにインスタンス化を要求する SFSafariViewController コントローラー、およびコールバックの url パラメーター。 このコールバックは、 url 認証エンドポイントの URL またはログアウトエンドポイントの URL を表すパラメーター、および useSVC アプリケーションが SFSafariViewController.

を SFSafariViewController コントローラは、複数のリダイレクトを経由します。アプリケーションは、コントローラのアクティビティを監視し、お客様の application's custom scheme ( 例：**​ **adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com) をクリックします。 この特定のカスタム URL は実際には無効で、コントローラが実際に読み込むことを意図していないことに注意してください。 認証フローまたはログアウトフローが完了し、コントローラを安全に閉じられることを示すシグナルとして、アプリケーションでのみ解釈する必要があります。 コントローラーがこの特定のカスタム URL を読み込むと、アプリケーションは SFSafariViewController AccessEnabler の handleExternalURL:url API メソッド。

注意： 認証フローの場合、これは、ユーザーが「戻る」ボタンを押す機能を持つポイントです。これは、認証フローの中止と同じです。 このシナリオでは、アプリケーションは setSelectedProvider: メソッドの受け渡し nil をパラメータとして追加し、AccessEnabler が認証状態マシンをリセットする機会を与える。

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

利用可能： ​v 3.2 以降

パラメーター:

トリガー元： ​ setOptions: 前 setSelectedProvider:

トップに戻る…

handleExternalURL:url handleExternalURL

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： このメソッドは、認証フローまたはログアウトフローを完了するために、アプリケーションによって呼び出されます。 このメソッドは、アプリケーションが UIWebView/WKWebView or SFSafariViewController コントローラが特定のカスタム URL にリダイレクトされる。 アプリケーションで SFSafariViewController コントローラー：指定したカスタム URL は、 application's custom scheme ( 例：adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com) が含まれていない場合、この特定のカスタム URL は ADOBEPASS_REDIRECT_URL 定数 ( adobepass://ios.app) をクリックします。

認証フローが発生した場合、AccessEnabler は、バックエンドサーバから認証トークンを取得し、トークンストレージにローカルに保存することで、フローを完了します。 AccessEnabler は、 setAuthenticationStatus() ステータスコードが 1 のコールバック。成功を示します。 これらの手順の実行中にエラーが発生した場合、 setAuthenticationStatus() コールバックは、ステータスコード 0 でトリガーされ、認証の失敗を示し、対応するエラーコードも示します。

 (void) handleExternalURL:(NSString *)url;

可用性： v3.0 以降

パラメーター：

コールバックがトリガーされました： setAuthenticationStatus:errorCode, sendTrackingData:forEventType:

トップに戻る…

getAuthenticationToken - [非推奨] getAuthNToken

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： バックエンドサーバーから認証トークンをリクエストして、認証フローを完了します。 このメソッドは、MVPD ログインページをホストする WebView コントロールが、 ADOBEPASS_REDIRECT_URL 定数。

- (void) getAuthenticationToken;

可用性： v1.0 以降 次まで： v3.0

パラメーター： なし

コールバックがトリガーされました： setAuthenticationStatus:errorCode,sendTrackingData:forEventType:

トップに戻る…

</br

setAuthenticationStatus:errorCode: setAuthNStatus

ファイル： AccessEnabler/headers/EntitlementDelegate.h

説明 認証フローの状態をアプリケーションに通知する AccessEnabler によってトリガーされるコールバック。 ユーザーの操作や、その他の予期しないシナリオ（ネットワーク接続の問題など）の結果、このフローが失敗する場所は多数あります。 このコールバックは、アプリケーションに認証フローの成功/失敗ステータスを通知し、必要に応じて失敗理由に関する追加情報も提供します。

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

可用性： v1.0 以降

パラメーター:

トリガー元： checkAuthentication, getAuthentication, getAuthentication:withData:, checkAuthorization:, checkAuthorization:withData:

トップに戻る…

checkPreauthorizedResources: checkPreauth

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： このメソッドは、ユーザーが既に特定の保護されたリソースの表示を許可されているかどうかを判断するために、アプリケーションで使用されます。 このメソッドの主な目的は、UI の装飾に使用する情報を取得することです （例えば、ロックアイコンとロック解除アイコンを使用したアクセスステータスを示す）。

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

可用性： v1.3 以降

パラメーター：

コールバックがトリガーされました： preauthorizedResources:

トップに戻る…

checkPreauthorizedResources:cache: checkPreauthCache

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： このメソッドは、ユーザーが既に特定の保護されたリソースの表示を許可されているかどうかを判断するために、アプリケーションで使用されます。 このメソッドの主な目的は、UI の修飾に使用する情報（例えば、ロックアイコンとロック解除アイコンによるアクセスステータスを示す情報）を取得することです。 The キャッシュ パラメータは、リソースの解決に内部キャッシュを使用するかどうかを制御します。

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

可用性： v3.1 以降

パラメーター：

コールバックがトリガーされました： preauthorizedResources:

トップに戻る…

preauthorizedResources: preauthResources

ファイル： AccessEnabler/headers/EntitlementDelegate.h

説明： 次によってトリガーされるコールバック： checkPreauthorizedResources:. ユーザーが既に表示を許可しているリソースのリストを提供します。

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

可用性： v1.3 以降

パラメーター：

トリガー元： checkPreauthorizedResources:

トップに戻る…

checkAuthorization:, checkAuthorization:withData: checkAuthZ

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： このメソッドは、アプリケーションが認証ステータスを確認するために使用します。 まず、認証状態を最初に確認します。 認証されていない場合、 tokenRequestFailed:errorCode:errorDescription: コールバックがトリガーされ、メソッドが終了します。 ユーザーが認証されると、認証フローもトリガーされます。 詳細は、 getAuthorization: メソッド。

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

可用性： v1.0 以降

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

可用性： v1.9 以降

パラメーター：

コールバックがトリガーされました：

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

トップに戻る…

getAuthorization:, getAuthorization:withData: getAuthZ

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： このメソッドは、アプリケーションで承認フローを開始するために使用されます。 ユーザーがまだ認証されていない場合は、認証フローも開始します。 ユーザーが認証されると、AccessEnabler は認証トークン（有効な認証トークンがローカルトークンキャッシュに存在しない場合）と短時間有効なメディアトークンの要求を発行します。 ショートメディアトークンが取得されると、認証フローは完了と見なされます。 The setToken:forResource: コールバックがトリガーされ、ショートメディアトークンがアプリケーションのパラメーターとして配信されます。 何らかの理由で認証が失敗した場合、 tokenRequestFailed:forEventType: コールバックがトリガーされ、エラーコード/詳細が表示されます。

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

可用性： v1.0 以降

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

可用性： v1.9 以降

パラメーター：

コールバックがトリガーされました： tokenRequestFailed:errorCode:errorDescription:, setToken:forResource:,sendTrackingData:forEventType:

追加のコールバックがトリガーされました：
このメソッドは、次のコールバックをトリガーすることもできます（認証フローも開始する場合）。 setAuthenticationStatus:errorCode:, displayProviderDialog:

トップに戻る…

setToken:forResource: setToken

ファイル： AccessEnabler/headers/EntitlementDelegate.h

説明 承認フローが正常に完了したことをアプリケーションに通知する、AccessEnabler によってトリガーされるコールバック。 短時間のみ有効なメディアトークンは、パラメーターとしても提供されます。

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

可用性： v1.0 以降

パラメーター:

トリガー元： checkAuthorization: , checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:

トップに戻る…

tokenRequestFailed:errorCode:errorDescription: tokenReqFailed

ファイル： AccessEnabler/headers/EntitlementDelegate.h

説明 認証フローが失敗したことを上位レイヤ・アプリケーションに通知する、AccessEnabler によってトリガーされるコールバック。

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

可用性： v1.0 以降

パラメーター:

トリガー元： checkAuthorization:, checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:

トップに戻る…

ログアウト logout

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： このメソッドは、アプリケーションによって呼び出され、ログアウトフローを開始します。 ログアウトは、一連の HTTP リダイレクト操作の結果です。これは、ユーザーがAdobe Pass認証サーバーと MVPD サーバーの両方からログアウトする必要があるためです。 このフローは、AccessEnabler ライブラリによって発行された単純な HTTP リクエストでは完了できないため、 UIWebView/WKWebView or SFSafariViewController HTTP リダイレクト操作に従うには、コントローラをインスタンス化する必要があります。

ログアウトフローは、ユーザーが UIWebView/WKWebView or SFSafariViewController コントローラーを使用します。 したがって、Adobeでは、ログアウトプロセス中にコントロールを非表示（非表示）にすることをお勧めします。

認証フローと同様のパターンを用いる。 iOS AccessEnabler は、 navigateToUrl: コールバックまたは navigateToUrl:useSVC: を作成するには、 UIWebView/WKWebView or SFSafariViewController コントローラー、およびコールバックの url パラメーター。 これは、バックエンドサーバー上のログアウトエンドポイントの URL です。 tvOS AccessEnabler の場合、 navigateToUrl: コールバックまたは navigateToUrl:useSVC: コールバックが呼び出されます。

複数のリダイレクトを経る場合、アプリケーションは、 UIWebView/WKWebView or SFSafariViewController コントローラーを使用し、特定のカスタム URL を読み込むときのタイミングを検出します。 この特定のカスタム URL は実際には無効で、コントローラが実際に読み込むことを意図していないことに注意してください。 ログアウトフローが完了し、コントローラを安全に閉じられることを示すシグナルとして、アプリケーションでのみ解釈する必要があります。 コントローラがこの特定のカスタム URL を読み込むと、アプリケーションはコントローラを閉じて、AccessEnabler の handleExternalURL:url API メソッド。 アプリケーションで SFSafariViewController コントローラー：指定したカスタム URL は、 application's custom scheme ( 例：adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com) が含まれていない場合、この特定のカスタム URL は ADOBEPASS_REDIRECT_URL 定数 ( adobepass://ios.app) をクリックします。

最後に、AccessEnabler が setAuthenticationStatus() ステータスコード 0 のコールバック。ログアウトフローの成功を示します。

注意： ユーザーがApple SSO を使用してログインすると、VSA203 ステータスがトリガーされます。 この場合、ユーザーに対して、システム設定からログアウトするように指示する必要があります。 そうしないと、アプリケーションが再起動されたときに再認証がおこなわれます。

- (void) logout;

可用性： v1.0 以降

パラメーター： なし

コールバックがトリガーされました： navigateToUrl:, setAuthenticationStatus:errorCode:

トップに戻る…

getSelectedProvider getSelProv

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： このメソッドを使用して、現在選択されているプロバイダーを特定します。

- (void) getSelectedProvider;

可用性： v1.0 以降

パラメーター： なし

コールバックがトリガーされました： selectedProvider:

トップに戻る…

selectedProvider selProv

ファイル： AccessEnabler/headers/EntitlementDelegate.h

説明 現在選択されている MVPD に関する情報をアプリケーションに配信する AccessEnabler によってトリガーされるコールバック。

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

可用性： v1.0 以降

パラメーター:

トリガー元： getSelectedProvider

トップに戻る…

getMetadata: getMeta

ファイル： AccessEnabler/headers/AccessEnabler.h

説明： AccessEnabler ライブラリによってメタデータとして公開された情報を取得するには、このメソッドを使用します。 アプリケーションは、辞書ベースの key 入力パラメーター。

プログラマーは、次の 2 種類のメタデータを使用できます。

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

可用性： v1.0 以降

パラメーター：

コールバックがトリガーされました： setMetadataStatus:encrypted:forKey:andArguments:

詳細情報： ユーザーメタデータ

トップに戻る…

presentTVProviderDialog presentTvDialog

ファイル： AccessEnabler/headers/EntitlementDelegate.h

説明 呼び出し後に AccessEnabler によってトリガーされるコールバックgetAuthentication() 現在のリクエスト元が SSO をサポートする MVPD を少なくとも 1 つサポートしている場合。

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

可用性： v2.0 以降

パラメーター:

トリガー元： getAuthentication

詳細情報： iOS/tvOS シングルサインオン

トップに戻る…

dismissTVProviderDialog dismissTvDialog

ファイル： AccessEnabler/headers/EntitlementDelegate.h

説明 ユーザーがApple SSO ダイアログを閉じた後に AccessEnabler によってトリガーされるコールバック。

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

可用性： v2.0 以降

パラメーター:

トリガー元： ユーザーアクション

詳細情報： iOS/tvOS シングルサインオン

トップに戻る…

setMetadataStatus:encrypted:forKey:andArguments: setMetaStatus

ファイル： AccessEnabler/headers/EntitlementDelegate.h

説明 AccessEnabler によってトリガーされるコールバック。 getMetadata: を呼び出します。

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

可用性： v1.0 以降

パラメーター:

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

トリガー元： getMetadata:

詳細情報： ユーザーメタデータ

トップに戻る…

MVPD mvpd

ファイル： AccessEnabler/headers/model/MVPD.h

説明 MVPD オブジェクトを表します。 MVPD のプロパティに関する情報を取得するために使用できます。

可用性： v1.0 以降 [boardingStatus プロパティは v2.2 から使用可能です。]

プロパティ:

トップに戻る…

イベントの追跡 tracking

AccessEnablerトリガーは、エンタイトルメントフローとは必ずしも関連しない追加のコールバックです。 の実装 sendTrackingData() コールバック関数はオプションですが、アプリケーションは、特定のイベントを追跡し、認証/承認の試行の成功/失敗の回数などの統計をコンパイルできます。

sendTrackingData sendTracking

ファイル： AccessEnabler/headers/EntitlementDelegate.h

説明 認証/承認フローの完了/失敗など、様々なイベントの発生をアプリケーションに対する AccessEnabler シグナリングによってトリガーされるコールバック。 Adobe Pass Authentication 1.6 では、デバイスの種類、AccessEnabler のクライアントの種類、オペレーティング・システムは、次の方法で報告されます。 sendTrackingData(). The sendTrackingData() コールバックは後方互換性を維持します。

コールバック：イベントの追跡

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

可用性： v1.0 以降

注意： デバイスタイプとオペレーティングシステムは、パブリック Java ライブラリ (http://java.net/projects/user-agent-utils) およびユーザーエージェント文字列。 この情報は、運用指標をAdobeのカテゴリに分類する簡単な方法としてのみ提供されますが、誤った結果に対する責任はに与えられません。 適宜、新しい機能を使用してください。

パラメーター:

トリガー元： checkAuthentication, getAuthentication, getAuthentication:withData:, checkAuthorization:, checkAuthorization:withData:, getAuthorization:, getAuthorization:withData:, setSelectedProvider:

の値を解釈するための手順 データ 配列：