資料情報と設定の保存
資料情報
sdk.material;
// {
// description: { type: 'text', text: '…' } 또는 { type: 'html', html: '…' },
// entries: { learn: 'index.html', instructor: 'instructor.html', edit: 'edit.html' },
// settings: { … }, // 설정 화면이 저장한 값
// completionPolicy: 'on_submit', // 이 페이지의 학습 완료 설정 (읽기만. 서버가 주지 않으면 null)
// }
entriesには、metadata.jsonで有効にした画面のエントリーファイルが入っています。settingsは学生を含むすべての閲覧者に渡される公開値です。正解や秘密の値、学習者の個人情報は入れないでください。例外は採点設定のsettings.gradingだけです。サーバーは学習ページ(学生・チューター・教育者)のレスポンスからgradingを除外し、編集画面でのみ見えます。
設定画面で保存する
編集ページはentries.editファイルをeditスコープのトークンで表示します。このときmaterial.settingsは資料のdraftの値(draftがなければ現在のバージョンの値)です。保存ボタンを設定画面の中に置いてsaveSettings()を呼び出すとdraftのsettingsが保存され、保存が完了するとmaterial.settingsが保存された値に変わります。学習者は、編集ページでdraftを反映(新しいバージョンとして保存)した後にこの値を受け取ります。
import { EliceCDKError } from '@eliceio/cdk';
if (sdk.screen === 'edit') {
document.getElementById('save').addEventListener('click', async () => {
try {
await sdk.saveSettings({ difficulty: 'hard', questionCount: 10 });
showMessage('저장했습니다.');
} catch (err) {
showMessage(
err.code === EliceCDKError.code.DraftNotSaved
? '자료를 먼저 저장하세요.'
: '저장하지 못했습니다.'
);
}
});
}
- 同時に保存すると、後のものが残ります。
- draftがまだ処理中、または処理に失敗した場合は
content_not_readyで失敗します。 - 保存前のアップロードの設定画面(
#edit=1、トークンなし)ではdraft_not_savedで失敗します。ここで保存すると以前のバージョンの設定が変わり、アップロードが削除されるためです。資料を先に保存してから、設定画面を開き直します。 - 設定画面の外で呼び出すと
screen_not_supported、セッションが終了していればsession_expiredで失敗します。
保存結果は編集ページにもメッセージで通知されます。成功すると、編集ページは資料を再読み込みします。コンテンツが別途処理することはありません。
{ source: 'eliceio-content-sdk', type: 'settings-saved', materialId, payload: { status: 'saved' } }
{ source: 'eliceio-content-sdk', type: 'settings-saved', materialId, payload: { status: 'failed', code } }