SDK 초기화 및 데이터 저장(key-value)
SDK에서 지원되는 메소드를 정의합니다.
Last updated
SDK에서 지원되는 메소드를 정의합니다.
Last updated
⚠️ SDK에서 제공하는 모든 기능은 init 메서드를 통해 초기화가 완료된 이후에 사용할 수 있습니다. 반드시 해당 함수의 실행이 완료된 이후 SDK 기능을 사용해주세요.
Vanilla JS example
React example
설치된 SDK에서 제공하는 init()
함수를 사용하여 SDK를 초기화합니다.
해당 함수는 기본적으로 window.location.search
를 통해 URL에 포함된 쿼리스트링을 파싱하여 엘리스 플랫폼과 연동하기 위한 정보인 materialId
, extToken
을 추출합니다.
window.location.search에서 연동하기 위한 정보를 제공하기 어려울 경우, init()
함수에 search
인자를 통해 직접 정보를 제공할 수 있습니다.
baseUrl은 기본적으로 엘리스 플랫폼 production 환경에 설정되어 있습니다. 테스트 환경에서 사용하려면 baseUrl을 인자로 설정해주세요.
콘텐츠를 사용자가 모두 완료하였을 때, 점수를 엘리스 플랫폼으로 전달하도록 구성합니다.
콘텐츠가 왼료되는 시점에 @eliceio/content-sdk
에서 제공하는 sendScore()
함수를 호출합니다. 함수에는 score
라는 인자 값이 필요로 하며, 일반적으로 콘텐츠를 완료하였을 때에는 100
을 보내도록 합니다.
상기 설명과 같이 콘텐츠를 엘리스 수업 자료로 설정하였다면, 수업 자료의 점수가 그림과 같이 100점이 되는지 확인합니다.
학생의 콘텐츠 변경사항을 엘리스 플랫폼에 저장하기 위해서는 @eliceio/content-sdk
에서 제공하는 postKeyValue()
함수를 사용합니다. 해당 함수는 key
와 value
를 저장하는 역할을 합니다.
⚠️ 실습 변경사항은 각 사용자 및 수업 자료마다 별도로 저장되며, 타 유저 혹은 수업 자료에는 영향을 주지 않습니다.
⚠️ key 및 value 작성 규칙
key는 항상 camelCase로 작성되어야 히며, 영문자 및 숫자로만 작성되어야 합니다. (
[a-zA-Z0-9]+]
)value의 가능한 타입은 string, number, boolean, object, array 이며, object의 key는 항상 camelCase로 작성되어야 합니다.
학생의 콘텐츠 변경사항을 불러올 떄에는 @eliceio/content-sdk
에서 제공하는 getKeyValue()
함수를 사용합니다. 해당 함수는 key
에 해당하는 value
를 불러옵니다.
이 메서드는 Key-Value 저장소에서 키-값 쌍을 삭제하는 데 사용됩니다.
파라미터
JavaScript 예제
React 예제
⚠️
account.accountId
속성은 v1.0.0 버전부터 삭제될 예정입니다. 대신account.uid
를 사용해주세요.
엘리스 플랫폼에 접속된 계정의 정보를 불러올 수 있습니다. 해당 정보는 account
속성을 통해 불러올 수 있습니다. 계정 정보에는 accountId(계정 ID)
, fullname(이름)
, uid(통합 ID)
가 포함되어 있습니다.
엘리스 플랫폼에 등록된 학습자료의 메타데이터를 불러올 수 있습니다. 해당 정보는 metadata
속성을 통해 불러올 수 있습니다. 메타데이터 정보에는 materialId(자료 ID)
가 포함되어 있습니다.
locale
는 현재 사용자의 설정된 언어를 의미하며 타입은 문자열입니다. IETF 언어 하위 태그로 기본 언어는 en
입니다. 현재 Elice 플랫폼에서 지원하는 언어는 다음과 같습니다.
이름 | 타입 | 설명 |
---|
언어 | 코드 |
---|
|
| kvstore에서 삭제할 데이터의 고유한 키를 의미합니다. |
한국어 |
|
영어 |
|
일본어 |
|
태국어 |
|