(기존) 사전 인증 preuthorize-android
NOTE
이 페이지의 컨텐츠는 정보용으로만 제공됩니다. 이 API를 사용하려면 Adobe의 현재 라이선스가 필요합니다. 허가되지 않은 사용은 허용되지 않습니다.
IMPORTANT
제품 알림 페이지에서 집계한 최신 Adobe Pass 인증 제품 알림 및 서비스 중단 타임라인에 대한 정보를 계속 받아 보십시오.
하나 이상의 리소스에 대한 사전 권한 부여 결정을 받으려면 애플리케이션에서 사전 권한 부여 API 메서드를 사용해야 합니다. API 사전 인증 요청은 UI 힌트 및/또는 콘텐츠 필터링에 사용해야 합니다. 사용자에게 지정된 리소스에 대한 액세스 권한을 부여하기 전에 실제 인증 API 요청을 수행해야 합니다.
Adobe Pass 인증 서비스에서 사전 인증 API 요청을 처리할 때 예기치 않은 오류(예: 네트워크 문제, MVPD 인증 끝점을 사용할 수 없음 등)가 발생하는 경우, 영향을 받는 리소스에 대해 하나 이상의 분리된 오류 정보가 사전 인증 API 응답 결과의 일부로 포함됩니다.
public void preauthorize(PreauthorizeRequest request, AccessEnablerCallback<PreauthorizeResponse> callback);
설명:
가용성: v3.6.0+
매개 변수:
- PreauthorizeRequest: 요청을 정의하는 데 사용되는 빌더 개체
- AccessEnablerCallback : API 응답을 반환하는 데 사용되는 콜백입니다
- PreauthorizeResponse : API 반환에 사용되는 개체
응답 콘텐츠
공용 클래스 PreauthorizeRequest androidpreauthorizerequest
클래스 PreauthorizeRequest.Builder
///
/// Sets the `List` of resources for which you want to obtain preauthorization decisions.
///
/// Each element in the list must be a `String` representing either the resource ID value or the media RSS fragment which must be agreed with the MVPD.
///
/// This function sets the information only in the context of current `Builder` object instance which is the receiver of this function call.
///
/// To build an actual `PreauthorizeRequest` you can have a look at `Builder`'s function:
/// ```
/// public func build() -> PreauthorizeRequest
/// ```
///
/// - Parameter resources: The `List` of resources for which you want to obtain preauthorization decisions.
///
/// - Returns: The reference to the same `Builder` object instance which is the receiver of the function call. It does this in order to allow the creation of function chaining.
///
공용 빌더 setResources(List<String> resources)
///
/// Sets the features which you want to have them disabled when obtaining preauthorization decisions.
///
/// The list of available features are provided by `PreauthorizeRequest.Feature` enumeration.
///
/// This function sets the information only in the context of current `Builder` object instance which is the receiver of this function call.
///
/// To build an actual `PreauthorizeRequest` you can have a look at `Builder`'s function:
/// ```
/// public func build() -> PreauthorizeRequest
/// ```
///
/// - Parameter features: The set of features which you want to have them disabled.
///
/// - Returns: The reference to the same `Builder` object instance which is the receiver of the function call. It does this in order to allow the creation of function chaining.
///
공용 빌더 disableFeatures(Set<PreauthorizeRequest.Feature>
기능)
///
/// Creates and retrieves the reference of a new `PreauthorizeRequest` object instance.
///
/// This function instantiates a new `PreauthorizeRequest` object every time it is called.
///
/// This function uses the values set in advance in the context of current `Builder` object instance which is the receiver of this function call.
///
/// Bear in mind that this function does not produce any side effects, therefore it does not alter the state of the SDK or the state of the `Builder` object instance which is the receiver of this function call.
///
/// It means that successive calls of this function for the same receiver will create different new `PreauthorizeRequest` object instances, but having the same information, in case the values set to the `Builder` where not modified between the calls.
///
/// In case you do not need to update any of the provided information (resources, features, etc.) you may reuse the `PreauthorizeRequest` instance for multiple uses of the `preauthorize` API.
///
/// - Returns: The reference to a new `PreauthorizeRequest` object instance.
///
공용 PreauthorizeRequest 빌드()
enum PreauthorizeRequest.Feature
///
/// This feature controls whether to use the information from the AccessEnabler SDK cache or to bypass it and
/// rely on Adobe Pass server information via a network call.
///
LOCAL_CACHE
///
/// This feature controls whether to use the information from the Adobe Pass server cache or to bypass it and
/// rely on MVPD server information via a network call.
///
REMOTE_CACHE
abstract class AccessEnablerCallback<PreauthorizeResponse>
accessenablercallback
/// Response callback called by the SDK when the preauthorize API request was fulfilled. The result is either a successful or an error result containing a status.
**public void onResponse(PreauthorizeResponse result)**
/// Failure callback called by the SDK when the preauthorize API request could not be serviced. The result is a failure result containing a status.
**public void onFailure(PreauthorizeResponse result)**
클래스 PreauthorizeResponse preauthorizeresponse
///
/// - Returns: Additional status (state) information in case of failure.
/// Might hold a `null` value.
///
**public [Status](#status) getStatus()**
///
/// - Returns: The list of preauthorization decisions. One decision for each resource.
/// The list might be empty in case of failure.
///
**public List\<[Decision](#status)\> getDecisions()**
클래스 상태
///
/// - Returns: The HTTP response status code as documented in RFC 7231.
/// Might be 0 in case the \`Status\` comes from the SDK instead of Adobe Pass Authentication services.
///
**public int getStatus()**
///
/// - Returns: The standard Adobe Pass Authentication services error code.
/// Might hold an empty string or a `null` value.
///
**public String getCode()**
///
/// - Returns: The human readable message which can be displayed to the end user.
/// Might hold an empty string or a `null` value.
///
**public String getMessage()**
///
/// - Returns: The detailed message which in some cases is provided by the MVPD authorization endpoints or by Programmer degradation rules.
/// Might hold an empty string or a `null` value.
///
**public String getDetails()**
///
/// - Returns: The URL that links to more information about why this state/error occurred and possible solutions.
/// Might hold an empty string or a `null` value.
///
**public String getHelpUrl()**
///
/// - Returns: The unique identifier for this response, which can be used when contacting support to identify specific issues in more complex scenarios.
/// Might hold an empty string or a `null` value.
///
**public String getTrace()**
///
/// - Returns: The recommended action to remediate the situation.
/// - none: Unfortunately there is no predefined action to remediate this issue. This might indicate an improper invocation of the public API
/// - configuration: A configuration change is needed through TVE dashboard or by contacting support.
/// - application-registration: The application must register itself again.
/// - authentication: The user must authenticate or re-authenticate.
/// - authorization: The user must obtain authorization for the specific resource.
/// - degradation: Some form of degradation should be applied.
/// - retry: Retrying the request might solve the issue
/// - retry-after: Retrying the request after the indicated period of time might solve the issue.
/// Might hold an empty string or a `null` value.
///
**public String getAction()**
클래스 결정
///
/// This is a getter function.
///
/// - Returns: The resource id for which the decision was obtained.
///
public Status getId()
///
/// This is a getter function.
///
/// - Returns: The value of the flag indicating if the decision is successful or not.
///
**public boolean isAuthorized()**
///
/// This is a getter function.
///
/// - Returns: Additional status (state) information in case some error has occurred.
/// Might hold a `null` value.
///
**public Status getError()**
예 :
// build request object
Preauthorize request = new PreauthorizeRequest.Builder()
.setResources(resourcesList)
.disableFeatures(PreauthorizeRequest.FEATURE.LOCAL_CACHE) // optional, use only to disable local cache for preauthorized resources
.build();
}
// execute preauthorize call, passing a callback function to process the response
accessEnabler.preauthorize(request, new AccessEnablerCallback<PreauthorizeResponse>() {
@Override
public void onResponse(PreauthorizeResponse result) {
// Handle onResponse
}
@Override
public void onFailure(PreauthorizeResponse result) {
// Handle onFailure
}
});
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b