실행 데이터 저장
Platform.api.savePlayData()
콘텐츠 실행 중 관리가 필요한 데이터를 저장한다. 저장한 데이터는 Platform.api.loadPlayData()를 이용하여 불러올 수 있다.
구문
Platform.api.savePlayData(playData, [mock])
매개변수
- playData: {Object}
- type:[필수] {String} 실행데이터 구분. 콘텐츠에서 필요로 하는 값을 사용
예를 들면 다음과 같다- “ENV”: 실행 환경 정보
- “IN”: 실행 입력 정보
- “OUT”: 실행 결과 정보
- data: {String} 저장 데이터
- 형식은 콘텐츠 별로 자유롭게 결정. 단 텍스트 형식이어야 한다.
- 이미지등의 Binary 정보는 Base64 인코딩 등의 방법으로 문자열화 한다.
- type:[필수] {String} 실행데이터 구분. 콘텐츠에서 필요로 하는 값을 사용
- mock
개발시 응답으로 받을 값. 서비스에 배포된 후에는 무시된다.- 성공 또는 실패값. 아래 반환값 참조.
반환 값
응답 객체로 이행하는 Promise 객체.
성공 시
- result: {String} "SUCCESS"
- data: {Object}
- historyNo: {Number} 기록된 현재 실행 이력 번호
- seqNo: {Number} 저장 연번
- saveTime: {String} 저장된 일시를 의미하는 ISO 8601 형식의 문자열. 예) "2023-05-12T15:23:05"
실패 시
- result: {String} "FAIL"
- message: {String} 오류 내용
- help: {String} 도움말. 없을 수 있음.
예제
Platform.api.savePlayData({
type: 'ENV',
data: JSON.stringify({
color: 'skyblue',
width: 1024,
height: 768
});
})
.then(function(resposne) {
if (response.result != 'SUCCESS') {
alert(response.message || '조회에 실패하였습니다.');
return;
}
var data = response.data;
console.log('실행 데이터가 저장되었습니다. 이력번호-%d, 연번-%d, 일시-%s', data.historyNo, data.seqNo, data.saveTime.toISOString());
});