エラー処理
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_param | URLにトークンや資料情報がない(init()ではAggregateErrorの中)、versionIdがその資料の保存済みバージョンではない、またはkvstoreのkey形式が正しくない |
invalid_token | トークンの内容(payload)を読み取れない |
not_initialized | init()の前に呼び出した |
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_type | assets.postにPDF・PPTX・PNG・JPEG・WebP・GIF以外のファイル |
file_invalid_size | assets.postに0バイト、または上限(文書95MB・画像10MB)を超えるファイル |
script_load_failed | loadScriptがスクリプトを読み込めなかった |
script_namespace_not_found | loadScriptが読み込んだスクリプトがwindow[namespace]を作成しなかった |
storage_limit_exceeded | kvstoreへの保存で、この資料の自分の値が512KBを超えた |
request_failed | その他の失敗。サーバーのコードはerr.cause.cause.code |
sdk.mlapi.fetchはレスポンスをそのまま返すため、サーバーのエラーもレスポンスとして届きます。AI呼び出しをご覧ください。