（旧版）错误报告 error-reporting

概述 overview

Adobe Pass身份验证中的错误报告当前通过两种不同的方式实现：

高级错误报告 advanced-error-reporting

AccessEnabler JavaScript SDK accessenabler-javascript-sdk

新的错误报告系统是可选的，因此实施者可以显式注册错误处理程序回调以接收高级错误报告。 该系统包括动态注册和取消注册多个错误回调的能力。 此外，加载AccessEnabler JavaScript SDK后，您可以立即注册任何新的错误回调，而无需执行任何其他初始化（在调用setRequestor()之前），这意味着您能够接收有关初始化和配置错误的高级报告。

实现 access-enab-js-imp

yourErrorHandler(errorData:Object)

您的错误处理程序回调函数将接收具有以下结构的单个对象（映射）：

    {
      errorId: "CFG410",
      level: "error",
      message: "This a fancy message",  // Optional
      .
      .                                 // Optional key/value pairs
      .
    }

​1. 绑定 bind

.bind(eventType:String, handlerName:String):void

附加事件的处理程序。

eventType — 仅“errorEvent”值导致AccessEnabler JavaScript SDK触发高级错误报告回调。

handlerName — 指定错误处理程序函数名称的字符串。

两个绑定参数必须仅使用来自以下集合的字符： [0-9a-zA-Z][-._a-zA-Z0-9]；即，参数必须以数字或字母开头，然后只能包含连字符、句点、下划线和字母数字字符。 此外，参数不能超过1024个字符。

示例​绑定错误处理程序：

accessEnabler.bind('errorEvent', 'myCustomErrorHandler');
accessEnabler.bind('errorEvent', 'errorLogger');

由于技术限制，您无法绑定关闭或匿名函数。 必须在第二个参数中指定方法的名称。

​2. 取消绑定 unbind

.unbind(eventType:String, handlerName:String=null):void

删除以前附加的事件处理程序。

eventType — 仅“errorEvent”值导致AccessEnabler JavaScript SDK触发高级错误报告回调。

handlerName — 将删除指定错误处理程序函数名称的字符串（如果为null或缺少指定eventType的所有附加处理程序）。

两个绑定参数必须仅使用来自以下集合的字符： [0-9a-zA-Z][-._a-zA-Z0-9]；即，参数必须以数字或字母开头，然后只能包含连字符、句点、下划线和字母数字字符。 此外，参数不能超过1024个字符。

删除单个错误处理程序的​示例：

accessEnabler.unbind('errorEvent', 'errorLogger');

示例​删除所有错误处理程序：

accessEnabler.unbind('errorEvent');

AccessEnabler iOS/tvOS SDK accessenabler-ios-tvos-sdk

新的错误报告系统是强制性的，因此实施者必须明确遵守新的Objective C“EntitlementStatus”协议。 这种新方法允许程序员接收高级错误报告。

实现 accessenab-ios-tvossdk-imp

实施者需要符合以下​ EntitlementStatus ​协议：

EntitlementStatus.h

    #import <Foundation/Foundation.h>

    @protocol EntitlementStatus <NSObject>
    - (void)status:(NSDictionary *)statusDictionary;
    @end

您的​ status ​函数将接收具有以下结构的单个对象（一个NSDictionary）：

    {
          errorId: "CFG410",
          level: "error",
          message: "This a fancy message",  // Optional
      .
      .                                 // Optional key/value pairs
      .
    }

1. 声明

    @interface MyEntitlementStatusDelegate : NSObject <EntitlementStatus>

2. 实现

    @implementation DemoAppAppDelegate
    // very simple implementation
    - (void)status:(NSDictionary *)statusDict {
        NSLog(@"%@:\n%@", statusDict[@"level"], statusDict);
    }

AccessEnabler Android SDK accessenabler-android-sdk

新的错误报告系统是强制性的，因为实施者必须明确符合IAccessEnablerDelegate接口定义的协议。 这种新方法允许程序员接收高级错误报告。

实现 access-enablr-androidsdk-imp

实施者需要处理接口IAccessEnablerDelegate中的新status方法。 status​函数将接收具有以下模型的单个​ AdvancedStatus ​对象：

    class AdvancedStatus {

    String id; // Not Null
    String level; // Not Null
    String message; // Might be null
    String resource; // Might be null

    AdvancedStatus(String id, String level, String message, String resource) {
        this.id = id;
        this.level = level;
        this.message = message;
        this.resource = resource;
    }

    //other private/public methods
    }

样本

    @Override
    public void status(AdvancedStatus advancedStatus) {
        String status = "status(" + advancedStatus.id + ", " + advancedStatus.level + ", " + advancedStatus.message + ", " + advancedStatus.resource + ")";

        Log.i(LOG_TAG, status);
    }

AccessEnabler FireOS SDK accessenabler-fireos-sdk

新的错误报告系统是强制性的，因为实施者必须明确符合IAccessEnablerDelegate接口定义的协议。 这种新方法允许程序员接收高级错误报告。

实现 access-enab-fireos-sdk-

实施者需要处理接口IAccessEnablerDelegate中的新status方法。 status​函数将接收具有以下模型的单个​ AdvancedStatus ​对象：

    class AdvancedStatus {

    String id; // Not Null
    String level; // Not Null
    String message; // Might be null
    String resource; // Might be null

    AdvancedStatus(String id, String level, String message, String resource) {
        this.id = id;
        this.level = level;
        this.message = message;
        this.resource = resource;
    }

    //other private/public methods
    }

样本

    @Override
    public void status(AdvancedStatus advancedStatus) {
        String status = "status(" + advancedStatus.id + ", " + advancedStatus.level + ", " + advancedStatus.message + ", " + advancedStatus.resource + ")";

        Log.i(LOG_TAG, status);
    }

高级错误代码引用 advanced-error-codes-reference

下表列出并描述了新版错误API公开的错误代码，以及更正这些代码的建议操作：

原始错误报告 original-error-reporting

本节介绍原始错误报告系统以及原始错误代码。 在原始错误报告系统中，AccessEnabler将错误传递到这两个回调函数： setAuthenticationStatus()在调用checkAuthentication()之后；tokenRequestFailed()，在调用checkAuthorization()或getAuthorization()失败之后。

原始错误报告和状态API将继续与之前完全一样工作。 但是，以后将不更新原始错误报告API。 关于旧错误的所有新错误报告和更新将仅在新版高级错误报告系统中反映。

有关使用原始错误报告系统的示例，请参阅JavaScript API引用：setAuthenticationStatus()和tokenRequestFailed()函数、iOS/tvOS API引用： setAuthenticationStatus()和tokentRequestFailed()、Android API引用：setAuthenticationStatus()和tokenRequestFailed()。

原始回调错误代码 original-callback-error-codes