SDKエラーは例外及びエラーイベントで取得できる。

SDKエラーはErrorDetail型で表現される。

type ErrorType = "ParameterError" | "NetworkError" | "UnexpectedError";
interface ErrorDetail {
  code: Number;
  type: ErrorType;
  error: string;
}

Exception

関数呼び出し時のエラーはErrorクラスの派生クラスであるSDKErrorクラスで取得できる。

エラー詳細はSDKErrorクラスのdetailメンバに含まれる。

SDK開発者への問い合わせの際にtoReportString()メソッドで取得した文字列が使用できる。
※ SDK開発者への問い合わせ以外の目的で当メソッドを利用することはサポートしない

SDKErrorクラス

class SDKError extends Error {
    public detail: ErrorDetail;
    public toReportString(): string;
}

利用例

try {
  client.connect();
} catch (e: SDKError) {
  console.log(e.detail.code);
  console.log(e.detail.type);
  console.log(e.detail.error);
}

エラーイベント

その他のエラーはerrorイベントをlistenすることで取得できる。
イベントハンドラにはSDKErrorEventクラスが通知される。

エラー詳細はSDKErrorEventクラスのdetailメンバに含まれる。

SDK開発者への問い合わせの際にtoReportString()メソッドで取得した文字列が使用できる。
※ SDK開発者への問い合わせ以外の目的で当メソッドを利用することはサポートしない

SDKErrorEventクラス

class SDKErrorEvent extends CustomEvent<any> {
  public detail: ErrorDetail;
  public toReportString(): string;
}

利用例

client.addEventListener("error", (e: SDKErrorEvent) => {
  console.log(e.detail.code);
  console.log(e.detail.type);
  console.log(e.detail.error);
});

エラー一覧

ParameterError

NetworkError

UnexpectedError