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

ファイル(assets)

設定画面でPDF・PPTXの文書とPNG・JPEG・WebP・GIFの画像をアップロードし、どの画面からでもそのファイルのURLを読み取ります。動画はここではアップロードしません(動画プレーヤー)。

個人情報の禁止

学習者の個人情報を含むファイル(顔写真・身分証・名簿など)はアップロードしないでください。アップロードしたファイルのIDはsettingsに保存され、settingsは学生を含むすべての閲覧者に渡されます。

// 설정 화면: 올리고 id를 settings에 저장
const controller = new AbortController();
const asset = await sdk.assets.post(input.files[0], {
onProgress: ({ loaded, total }) => (bar.value = loaded / total),
signal: controller.signal, // controller.abort()로 취소
});
await sdk.saveSettings({ ...sdk.material.settings, file: asset.id });

// 학습 화면: id로 서명된 주소 읽기
const file = await sdk.assets.get(sdk.material.settings.file);
if (file) viewer.src = file.url;

アップロード(post)​

post(file, { onProgress?, signal? })は{ id, name, size, mime, url }を返します。

  • editトークンで開いた設定画面でのみ使えます。その他の画面はscreen_not_supported、保存前のアップロードの設定画面(#edit=1)はdraft_not_savedです。
  • 種類はファイルのMIMEタイプ、なければ拡張子で決まります。
種類MIME・拡張子最大サイズ
PDFapplication/pdf, .pdf95MB
PPTX.pptx95MB
PNGimage/png, .png10MB
JPEGimage/jpeg, .jpg · .jpeg10MB
WebPimage/webp, .webp10MB
GIFimage/gif, .gif10MB
  • SVGを含むその他のファイルはfile_invalid_typeです。
  • 0バイト、または上限を超えるファイルは、サーバーに問い合わせる前にfile_invalid_sizeで拒否します。
  • 画像は受け取ったままアップロードします。縮小したりメタデータ(EXIF・GPS)を削除したりする場合は、アップロード前に自分で処理してください。
  • ファイルは最大50MBのブロックに分けて送信します。onProgressはブロックを1つ送るたびに、またアップロードが完了するとloaded === totalで呼ばれます。50MBより小さいファイルは完了時にのみ呼ばれます。
  • キャンセルすると、postはsignalの理由(AbortError)で失敗します。削除機能はまだありません。

読み取り(get)​

get(id)は{ id, url }またはnullを返します。

  • nullになる場合:init()の前、画面のバージョンに署名付きURLがないとき、この資料のファイルIDではないとき。
  • 名前・サイズ・形式は返しません。必要であれば、アップロード時に受け取った値をsettingsに一緒に保存します。
urlではなくidを保存してください

idはサーバーが決めた保存キー(assets/{material_id}/{asset_id}.pdfの形式、画像はその拡張子)です。urlは画面のURLと同様に期限が切れるため、settingsにはidを保存し、表示するたびにget(id)でURLを取得します。