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

チュータリング (Tutoring)

tutoring オブジェクトは、チュータリングモードで使用できるメソッドとプロパティを提供します。

1. メソッド​

⚠️ すべての tutoring メソッドは、Eliceプラットフォームのチュータリングモードを通じて登録されたアカウントの外部コンテンツにアクセスした場合にのみ使用できます。

getAccountList (アカウントリスト)​

getAccountList メソッドを使用すると、コースに登録されているアカウントのリストを取得できます。offset と count のパラメータを渡すことができます。offset はアカウントリストの開始位置を示し、count は取得するアカウントの数を示します。

例えば、offset が 0 で count が 40 の場合、0 番目から 40 件のアカウントリストを取得します。次のアカウントリストを取得するには、offset を 40 に設定し、count を 40 に設定します。このように、offset と count を組み合わせることで、アカウントリストをページごとに取得することができます。

パラメータ​

変数型説明
offsetnumber取得するアカウントリストの開始位置を示します。最小値は 0 です。
countnumber取得するアカウントの数を示します。最小値は 0、最大値は 40 です。
import { eliceContents } from 'src/constants';

const getAccountList = async () => {
  const accountList = await eliceContents.tutoring.getAccountList();
  console.log(accountList); // [{ fullname: 'elice', uid: 123 }, ...]
};

getAccountKvstore (アカウントKvstore)​

getAccountKvstore メソッドを使用して、受講中の特定のアカウントの学習履歴を取得できます。

必須パラメータは次のとおりです：

  • uid: アカウントの一意の識別子。
  • key: kvstoreのキー。
import { eliceContents } from 'src/constants';

const getAccountKvstore = async () => {
  const kvstore = await eliceContents.tutoring.getAccountKvstore({
    uid: 123,
    key: 'quiz01.answer',
  });
  console.log(kvstore); // 'Elice'
};

getAccountKvstoreList (アカウント Kvstore リスト)​

このメソッドを使用して、特定のアカウントの Kvstore リストを取得できます。key と filterUids パラメーターを渡すことができます。key は Kvstore のキーを意味し、filterUids はアカウントの固有識別子のリストを意味します。レスポンスには、Kvstore オブジェクトを含む配列が含まれます。各オブジェクトは uid と value を持ちます。filterUids の最大数は 10 であり、これを超えるリクエストは送信できません。

パラメーター​
名前型説明
keystringKVストアのキーです。
filterUidsnumber[]アカウントの固有識別子リストです。filterUids の最大数は 10 です。
import { eliceContents } from 'src/constants';

const getAccountKvstoreList = async () => {
  const kvstoreList = await eliceContents.tutoring.getAccountKvstoreList({
    key: 'quiz01.answer',
    filterUids: [123, 456],
  });
  console.log(kvstoreList); // [{ uid: 123, value: 'Elice' }, { uid: 456, value: 'Elice' }]
};

2. プロパティ​

isTutoringMode (チュータリングモード)​

⚠️ isTutoringMode プロパティは v1.0.0 バージョンから削除される予定です。代わりに eliceContents.tutoring.isEnabled を使用してください。

import { eliceContents } from 'src/constants';

console.log(eliceContents.isTutoringMode); // false または true

isEnabled (チュータリング有効化状況)​

isEnabled プロパティは、チュータリングモードが有効化されているかどうかを確認するために使用されます。チュータリングモードが有効な場合、値は true になります。そうでない場合は false になります。

import { eliceContents } from 'src/constants';

eliceContents.init().then(() => {
  console.log(eliceContents.tutoring.isEnabled); // false または true
});

⚠️ チュータリングモードは、以下の条件をすべて満たす場合に有効化されます：

  • ユーザーが Elice プラットフォームのチュータリングモードを通じて登録されたアカウントの外部コンテンツにアクセスした場合
  • 外部コンテンツ SDK が初期化されている場合