メインコンテンツまでスキップ

エラー処理

SDKが投げるエラーはEliceCDKErrorで、codeで区別します。例外は、init()がフラグメントを読み取れなかったときのAggregateErrorです(以下を参照)。

import { EliceCDKError } from '@eliceio/cdk';

try {
await sdk.submit(answer);
} catch (err) {
if (err.code === EliceCDKError.code.ReadOnlyMode) {
// 튜터 화면: 제출 버튼을 숨김
}
}
  • コード定数はEliceCDKError.code.ReadOnlyModeのように使います。値は以下の表の文字列です。
  • causeには元のエラーが入っています。サーバーがリクエストを拒否した場合は、err.cause.causeにサーバーのレスポンス{ code, message, status, detail }があります。

init()のAggregateError​

フラグメントにtoken・preview・editのいずれもない、トークンがJWT形式でない、またはversionIdがUUIDでない場合、init()はAggregateErrorを投げます。errors配列には、問題ごとにinvalid_paramコードのEliceCDKErrorが入っています。

try {
await sdk.init();
} catch (err) {
const errors = err instanceof AggregateError ? err.errors : [err];
console.error(errors.map(e => e.code));
}

init()が失敗するとLXPが失敗画面を表示するため、コンテンツは通常ログを残すだけで十分です。

エラーコード​

codeタイミング
invalid_paramURLにトークンや資料情報がない(init()ではAggregateErrorの中)、versionIdがその資料の保存済みバージョンではない、またはkvstoreのkey形式が正しくない
invalid_tokenトークンの内容(payload)を読み取れない
not_initializedinit()の前に呼び出した
unauthorizedトークンが無効。学習資料を開き直すと新しいトークンを受け取る
session_expired新しいトークンが届く前にトークンが期限切れになった、またはサーバーがセッションを終了した。再読み込みを案内
permission_deniedトークンでは行えないリクエスト
read_only_modeチューターが提出した、またはkvstoreの値を保存・削除した
screen_not_supportedこの画面では行えないリクエスト(例:設定画面でのsubmit、学習画面でのsaveSettings)
draft_not_saved保存前のアップロードの設定画面(#edit=1)でのsaveSettings・assets.post。資料を先に保存
content_not_readyまだ保存済みバージョンがない資料、またはdraftが処理中・失敗のためsaveSettingsを拒否した
invalid_input解答が64KBを超えるなどでリクエストが拒否された、またはkvstoreのkeyパスの途中の値がオブジェクトでない
rate_limited短時間に提出しすぎた(1分あたり30回)、またはkvstoreの保存・削除が多すぎる(1秒あたり20回)
external_service_errorサーバーがAI採点や点数の反映に失敗した。提出は保存されていないので再提出
navigation_timeout学習ページが前・次のページの有無に1秒以内に応答しなかった
file_invalid_typeassets.postにPDF・PPTX・PNG・JPEG・WebP・GIF以外のファイル
file_invalid_sizeassets.postに0バイト、または上限(文書95MB・画像10MB)を超えるファイル
script_load_failedloadScriptがスクリプトを読み込めなかった
script_namespace_not_foundloadScriptが読み込んだスクリプトがwindow[namespace]を作成しなかった
storage_limit_exceededkvstoreへの保存で、この資料の自分の値が512KBを超えた
request_failedその他の失敗。サーバーのコードはerr.cause.cause.code

sdk.mlapi.fetchはレスポンスをそのまま返すため、サーバーのエラーもレスポンスとして届きます。AI呼び出しをご覧ください。