iOS/tvOS SDK API 참조 iostvos-sdk-api-reference

소개 intro

이 페이지에서는 Adobe Pass 인증용 iOS/tvOS 기본 클라이언트가 노출하는 메소드 및 콜백 함수에 대해 설명합니다. 여기에 설명된 메서드와 콜백 함수는 AccessEnabler.h 및 EntitlementDelegate.h 헤더 파일에 정의되어 있습니다. 여기에서 찾을 수 있는 iOS AccessEnabler SDK는 [SDK directory]/AccessEnabler/headers/api/입니다.

관련 설명서:

API 참조 apis

init:softwareStatement initWithSoftwareStatement

파일: AccessEnabler/headers/AccessEnabler.h

설명: AccessEnabler 개체를 인스턴스화합니다. 애플리케이션 인스턴스당 하나의 AccessEnabler 인스턴스가 있어야 합니다.

가용성: v3.0+

매개 변수:

맨 위로…

init - [사용되지 않음] init

파일: AccessEnabler/headers/AccessEnabler.h

설명: AccessEnabler 개체를 인스턴스화합니다. 애플리케이션 인스턴스당 하나의 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가 활성화된 경우 원격 토큰을 가져오고, 그 사이에 로그아웃이 발생한 경우 로컬 토큰을 삭제).

서버 응답에는 프로그래머의 ID에 첨부된 일부 구성 정보와 함께 MVPD 목록이 포함됩니다. 서버 응답은 AccessEnabler 코드에서 내부적으로 사용됩니다. 작업의 상태(즉, SUCCESS/FAIL)만 setRequestorComplete: 콜백을 통해 응용 프로그램에 표시됩니다.

urls 매개 변수를 사용하지 않으면 결과 네트워크 호출은 기본 서비스 공급자 URL(Adobe RELEASE/프로덕션 환경)을 대상으로 합니다.

urls 매개 변수에 대한 값이 제공되면 결과 네트워크 호출은 urls 매개 변수에 제공된 모든 URL을 대상으로 합니다. 모든 구성 요청은 별도의 스레드에서 동시에 트리거됩니다. 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를 다시 호출할 수 있습니다(SSO가 활성화된 경우 원격 토큰을 가져오고 그 사이에 로그아웃이 발생한 경우 로컬 토큰을 삭제).

서버 응답에는 프로그래머의 ID에 첨부된 일부 구성 정보와 함께 MVPD 목록이 포함됩니다. 서버 응답은 AccessEnabler 코드에서 내부적으로 사용됩니다. 작업의 상태(즉, SUCCESS/FAIL)만 setRequestorComplete: 콜백을 통해 응용 프로그램에 표시됩니다.

urls 매개 변수를 사용하지 않으면 결과 네트워크 호출은 기본 서비스 공급자 URL(Adobe RELEASE/프로덕션 환경)을 대상으로 합니다.

urls 매개 변수에 대한 값이 제공되면 결과 네트워크 호출은 urls 매개 변수에 제공된 모든 URL을 대상으로 합니다. 모든 구성 요청은 별도의 스레드에서 동시에 트리거됩니다. 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가 지정됩니다. 이 설정은 응용 프로그램 수명 주기 동안 한 번만 수행해야 합니다.

서버 응답에는 프로그래머의 ID에 첨부된 일부 구성 정보와 함께 MVPD 목록이 포함됩니다. 서버 응답은 AccessEnabler 코드에서 내부적으로 사용됩니다. 작업의 상태(즉, SUCCESS/FAIL)만 setRequestorComplete: 콜백을 통해 응용 프로그램에 표시됩니다.

urls 매개 변수를 사용하지 않으면 결과 네트워크 호출은 기본 서비스 공급자 URL(Adobe RELEASE/프로덕션 환경)을 대상으로 합니다.

urls 매개 변수에 대한 값이 제공되면 결과 네트워크 호출은 urls 매개 변수에 제공된 모든 URL을 대상으로 합니다. 모든 구성 요청은 별도의 스레드에서 동시에 트리거됩니다. 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

설명: 전체 인증 워크플로를 시작합니다. 인증 상태를 확인하는 것으로 시작됩니다. 아직 인증되지 않은 경우 인증 흐름 state-machine이 시작됩니다.

사용자의 자격 증명이 MVPD 로그인 페이지에서 확인되므로 응용 프로그램은 사용자가 MVPD의 로그인 페이지에서 인증을 받는 동안 발생하는 여러 리디렉션 작업을 모니터링해야 합니다. 올바른 자격 증명을 입력하면 WebView 컨트롤이 ADOBEPASS_REDIRECT_URL 상수로 정의된 사용자 지정 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

설명: 전체 인증 워크플로를 시작합니다. 인증 상태를 확인하는 것으로 시작됩니다. 아직 인증되지 않은 경우 인증 흐름 state-machine이 시작됩니다.

마지막으로 인증 상태는 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

설명 사용자가 원하는 MVPD를 선택할 수 있도록 적절한 UI 요소를 인스턴스화해야 함을 응용 프로그램에 알리기 위해 AccessEnabler에 의해 트리거된 콜백입니다. 콜백은 MVPD 개체 목록에 선택 UI 패널을 올바르게 구성하는 데 도움이 되는 추가 정보(예: 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

설명: 응용 프로그램에서 이 메서드를 호출하여 Access Enabler에 사용자의 MVPD 선택을 알립니다. 애플리케이션은 이 방법을 사용하여 인증에 사용되는 서비스 제공자를 선택 또는 변경할 수 있다.

선택한 MVPD가 TempPass MVPD인 경우 나중에 getAuthentication()을 호출할 필요 없이 해당 MVPD에 대해 자동으로 인증됩니다.

getAuthentication() 메서드에 추가 매개 변수가 제공되는 프로모션 임시 패스에는 이 작업이 가능하지 않습니다.

null ​을(를) 매개 변수로 전달할 때 Access Enabler는 사용자가 인증 흐름을 취소했다고 가정하고(즉, "뒤로" 단추를 누름) 인증 상태 컴퓨터를 다시 설정하고 AccessEnabler.PROVIDER_NOT_SELECTED_ERROR 오류 코드로 setAuthenticationStatus:errorCode: 콜백을 호출하여 응답합니다.

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

가용성: v1.0+

매개 변수: 없음

트리거된 콜백: setAuthenticationStatus:errorCode:,sendTrackingData:forEventType:, navigateToUrl:

맨 위로…

navigateToUrl: nav2url

파일: AccessEnabler/headers/EntitlementDelegate.h

설명: 응용 프로그램에 UIWebView/WKWebView 컨트롤러를 인스턴스화하고 콜백의 url 매개 변수에 제공된 URL을 로드하도록 요청하기 위해 AccessEnabler에 의해 트리거된 콜백입니다. 콜백은 인증 끝점의 URL 또는 로그아웃 끝점의 URL을 나타내는 url 매개 변수를 전달합니다.

UIWebView/WKWebView 컨트롤러가 여러 리디렉션을 거치면서 응용 프로그램에서 컨트롤러의 활동을 모니터링하고 ADOBEPASS_REDIRECT_URL 상수로 정의된 특정 사용자 지정 URL을 로드하는 순간을 감지해야 합니다(예: adobepass://ios.app). 이 특정 사용자 지정 URL은 실제로 유효하지 않으며 제어자가 실제로 로드하기 위한 것이 아닙니다. 인증 또는 로그아웃 흐름이 완료되었으며 컨트롤러를 닫는 것이 안전하다는 신호로 응용 프로그램에서 해석해야 합니다. 컨트롤러가 이 특정 사용자 지정 URL을 로드하면 응용 프로그램에서 UIWebView/WKWebView를 닫고 AccessEnabler의 handleExternalURL:url API 메서드를 호출해야 합니다.

참고: 인증 흐름의 경우 사용자가 "뒤로" 단추를 누를 수 있는 지점이며, 이는 인증 흐름을 중단하는 것과 같습니다. 이러한 경우 응용 프로그램에서 매개 변수로 nil ​을(를) 전달하고 AccessEnabler에 인증 상태 컴퓨터를 다시 설정할 수 있는 기회를 제공하는 setSelectedProvider: 메서드를 호출해야 합니다.

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

가용성: v1.0+

매개 변수:

트리거: setSelectedProvider:

맨 위로…

navigateToUrl:useSVC: nav2urlSVC

파일: AccessEnabler/headers/EntitlementDelegate.h

설명: 이전에 응용 프로그램에서 setOptions(["handleSVC":true"]) 호출을 통해 수동 Safari View Controller(SVC) 처리를 사용하도록 설정한 경우 및 Safari View Controller(SVC)가 필요한 MVPD의 경우에만 navigateToUrl: 콜백 대신 AccessEnabler에서 트리거된 콜백입니다. 다른 모든 MVPD에 대해 navigateToUrl: 콜백이 호출됩니다. SVC(Safari View Controller)를 관리하는 방법에 대한 자세한 내용은 iOS SDK 3.2 이상에서 SFSafariViewController 지원을 참조하십시오.

navigateToUrl: 콜백과 마찬가지로 AccessEnabler가 navigateToUrl:useSVC:을(를) 트리거하여 응용 프로그램에 SFSafariViewController 컨트롤러를 인스턴스화하고 콜백의 url 매개 변수에 제공된 URL을 로드하도록 요청합니다. 콜백은 인증 끝점의 URL 또는 로그아웃 끝점의 URL을 나타내는 url 매개 변수와 응용 프로그램에서 SFSafariViewController을(를) 사용해야 함을 지정하는 useSVC 매개 변수를 전달합니다.

SFSafariViewController 컨트롤러가 여러 리디렉션을 거치는 동안 응용 프로그램은 컨트롤러의 활동을 모니터링하고 application's custom scheme에 의해 정의된 특정 사용자 지정 URL을 로드하는 순간을 감지해야 합니다(예: ​ adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com. 이 특정 사용자 지정 URL은 실제로 유효하지 않으며 제어자가 실제로 로드하기 위한 것이 아닙니다. 인증 또는 로그아웃 흐름이 완료되었으며 컨트롤러를 닫는 것이 안전하다는 신호로 응용 프로그램에서 해석해야 합니다. 컨트롤러가 이 특정 사용자 지정 URL을 로드하면 응용 프로그램에서 SFSafariViewController을(를) 닫고 AccessEnabler의 handleExternalURL:url API 메서드를 호출해야 합니다.

참고: 인증 흐름의 경우 사용자가 "뒤로" 단추를 누를 수 있는 지점이며, 이는 인증 흐름을 중단하는 것과 같습니다. 이러한 경우 응용 프로그램에서 매개 변수로 nil ​을(를) 전달하고 AccessEnabler에 인증 상태 컴퓨터를 다시 설정할 수 있는 기회를 제공하는 setSelectedProvider: 메서드를 호출해야 합니다.

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

가용성: ​v 3.2+

매개 변수:

setSelectedProvider: 전에 트리거: ​ setOptions:

맨 위로…

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는 성공을 나타내는 상태 코드가 1인 setAuthenticationStatus() 콜백을 호출하여 인증 흐름이 완료되었음을 응용 프로그램에 알립니다. 이 단계를 실행하는 동안 오류가 발생하면 setAuthenticationStatus() 콜백이 인증 실패와 해당 오류 코드를 나타내는 상태 코드 0으로 트리거됩니다.

 (void) handleExternalURL:(NSString *)url;

가용성: v3.0+

매개 변수:

트리거된 콜백: setAuthenticationStatus:errorCode, sendTrackingData:forEventType:

맨 위로…

getAuthenticationToken - [사용되지 않음] getAuthNToken

파일: AccessEnabler/headers/AccessEnabler.h

설명: 백 엔드 서버에서 인증 토큰을 요청하여 인증 흐름을 완료합니다. 이 메서드는 MVPD 로그인 페이지를 호스팅하는 WebView 컨트롤이 ADOBEPASS_REDIRECT_URL 상수로 정의된 사용자 지정 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를 장식하는 데 사용할 정보를 검색하는 것입니다(예: 잠금 및 잠금 해제 아이콘으로 액세스 상태를 표시). cache 매개 변수는 내부 캐시가 리소스 확인에 사용되는지 여부를 제어합니다.

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

가용성: v3.1+

매개 변수:

트리거된 콜백: preauthorizedResources:

맨 위로…

preauthorizedSources: 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는 인증 토큰(로컬 토큰 캐시에 유효한 인증 토큰이 없는 경우) 및 단기 미디어 토큰에 대한 요청을 계속 발행합니다. 짧은 미디어 토큰을 얻으면 인증 흐름이 완료된 것으로 간주됩니다. 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

설명: 로그아웃 흐름을 시작하기 위해 응용 프로그램에서 이 메서드를 호출합니다. 로그아웃은 사용자가 Adobe Pass 인증 서버와 MVPD의 서버 모두에서 로그아웃해야 하므로 일련의 HTTP 리디렉션 작업의 결과입니다. AccessEnabler 라이브러리에서 발급한 간단한 HTTP 요청으로는 이 흐름을 완료할 수 없으므로 HTTP 리디렉션 작업을 수행하려면 UIWebView/WKWebView or SFSafariViewController 컨트롤러를 인스턴스화해야 합니다.

로그아웃 흐름은 사용자가 UIWebView/WKWebView or SFSafariViewController 컨트롤러와 어떤 식으로든 상호 작용할 필요가 없다는 점에서 인증 흐름과 다릅니다. 따라서 Adobe은 로그아웃 프로세스 중에 컨트롤을 보이지 않게(즉, 숨겨지도록) 만들 것을 권장합니다.

인증 흐름과 유사한 패턴이 사용됩니다. iOS AccessEnabler가 navigateToUrl: 콜백 또는 navigateToUrl:useSVC:을(를) 트리거하여 UIWebView/WKWebView or SFSafariViewController 컨트롤러를 만들고 콜백의 url 매개 변수에 제공된 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가 상태 코드가 0인 setAuthenticationStatus() 콜백을 호출하여 로그아웃 흐름이 성공했음을 나타냅니다.

참고: 사용자가 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 라이브러리에서 메타데이터로 노출된 정보를 검색합니다. 응용 프로그램에서 사전 기반 키 입력 매개 변수를 제공하여 이 데이터에 액세스할 수 있습니다.

프로그래머가 사용할 수 있는 메타데이터에는 두 가지 유형이 있습니다.

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

가용성: v1.0+

매개 변수:

트리거된 콜백: setMetadataStatus:encrypted:forKey:andArguments:

추가 정보: 사용자 메타데이터

맨 위로…

presentTVProviderDialog presentTvDialog

파일: AccessEnabler/headers/EntitlementDelegate.h

설명 현재 요청자가 SSO를 지원하는 MVPD를 하나 이상 지원하는 경우 getAuthentication()을 호출한 후 AccessEnabler에 의해 트리거된 콜백입니다.

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

가용성: v2.0+

매개 변수:

트리거 대상: getAuthentication

추가 정보: iOS/tvOS Single Sign On

맨 위로…

dismissTVProviderDialog dismissTvDialog

파일: AccessEnabler/headers/EntitlementDelegate.h

사용자가 Apple SSO 대화 상자를 닫은 후 AccessEnabler에서 트리거된 설명 콜백입니다.

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

가용성: v2.0+

매개 변수:

트리거한 사람: 사용자 작업

추가 정보: iOS/tvOS Single Sign On

맨 위로…

setMetadataStatus:encrypted:forKey:andArguments: setMetaStatus

파일: AccessEnabler/headers/EntitlementDelegate.h

getMetadata: 호출을 통해 요청된 메타데이터를 전달하는 AccessEnabler에 의해 트리거된 설명 콜백입니다.

- (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 인증 1.6을 사용하면 장치 유형, AccessEnabler 클라이언트 유형 및 운영 체제가 sendTrackingData()에 의해 보고됩니다. 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:

data 배열의 값을 해석하기 위한 지침: