본문으로 건너뛰기

튜터링 (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 { cdk } from './path/to/cdk';

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

getAccountKvstore (계정 Kvstore)​

getAccountKvstore 메서드를 사용하여 수강중인 특정 계정의 학습이력을 불러올 수 있습니다.

필수 파라미터는 다음과 같습니다:

  • uid: 계정의 고유 식별자.
  • key: kvstore의 키.
import { cdk } from './path/to/cdk';

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

getAccountKvstoreList (계정 Kvstore 목록)​

해당 메서드를 사용하여 특정 계정들의 Kvstore 목록을 조회할 수 있습니다. key와 filterUids 매개변수를 전달할 수 있습니다. key는 Kvstore의 키를 의미하고 filterUids는 계정의 고유 식별자 목록을 의미합니다. 응답에는 Kvstore 객체를 갖는 배열이 포함됩니다. 각 객체는 uid와 value를 가집니다. filterUids의 최대 개수는 10이며 이를 초과하여 요청할 수 없습니다.

Parameters​
이름타입설명
keystringKV 스토어의 키입니다.
filterUidsnumber[]계정의 고유 식별자 목록입니다. filterUids의 최대 개수는 10입니다.
import { cdk } from './path/to/cdk';

const getAccountKvstoreList = async () => {
  const kvstoreList = await cdk.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 버전부터 삭제될 예정입니다. 대신 cdk.tutoring.isEnabled를 사용해주세요.

import { cdk } from './path/to/cdk';

console.log(cdk.isTutoringMode); // false 또는 true

isEnabled (튜터링 활성화 여부)​

isEnabled 속성은 튜터링 모드가 활성화되어 있는지 여부를 확인하는데 사용됩니다. 튜터링 모드가 활성화되어 있으면 값이 true이고, 그렇지 않으면 false입니다.

import { cdk } from './path/to/cdk';

cdk.init().then(() => {
  console.log(cdk.tutoring.isEnabled); // false 또는 true
});

⚠️ 튜터링 모드는 아래 조건을 모두 충족할 때 활성화됩니다:

  • 사용자가 Elice 플랫폼 튜터링 모드를 통해 등록된 계정의 외부 콘텐츠에 접근한 경우
  • 외부 콘텐츠 SDK가 초기화된 경우