결과 받는 법 | 공통 규칙 | Appbox SDK 가이드

결과 받는 법

대부분의 함수는 마지막 인자로 콜백을 받고, 동시에 Promise 를 돌려줍니다. 둘 중 편한 쪽을 쓰면 됩니다.

기본 모양

상황콜백 (err, data)Promise
성공err 는 null, data 에 결과(대개 data.result, data.message)resolve { ack: true, ...data }
앱이 실패를 돌려줌(권한 거부, 사용자가 닫음 등)err.code, err.messageresolve { ack: false, error, code } (reject 하지 않음)
앱 밖(일반 브라우저)에서 부름err.code 가 NOT_APPBOXresolve { ack: false, error, code: "NOT_APPBOX" } (reject 하지 않음)
넘긴 값이 형식에 맞지 않음err.code 가 VALIDATIONreject (err.code 가 VALIDATION)
  • 콜백의 data 에는 ack 가 없습니다. ack 는 Promise 결과에만 있습니다.
  • 실패해도 Promise 가 reject 되지 않는 경우가 많습니다. await 결과의 ack 가 false 인지 꼭 확인하세요.
  • 입력값 오류만 reject 됩니다. 그래서 try 와 ack 확인을 함께 써야 모든 실패를 잡을 수 있습니다.

입력값 오류를 바로 던지는 함수

아래 함수는 메뉴 항목이나 이미지 항목 같은 배열 안의 값이 틀리면 Promise 를 돌려주기 전에 오류를 바로 던집니다(콜백도 불리지 않음). try 로 감싸 주세요.
함수바로 던지는 경우
gmenu.openTabsMenu메뉴 항목에 action 이 없음
gmenu.openHamburgerMenu메뉴 항목에 text 나 action 이 없음
gmenu.openBrowserMenu메뉴 항목의 function 이 허용 값이 아님
gmenu.openFloatingMenu메뉴 항목의 icon 이 없거나 http(s) 주소가 아님
ui.imageViewerOpenitem[].imageUrl 이 없거나 http(s) 주소가 아님
message.subscribeToTopic, message.unsubscribeFromTopictopicScheme 안에 빈 값
배열 자체가 없거나 개수가 틀린 경우는 위 기본 모양처럼 콜백과 reject 로 옵니다.

모양이 다른 함수

함수결과
AppboxSDK.getDeviceInfo(){ deviceUserId, pushToken, message }. ack 없음. 실패해도 오류가 없고 값이 빈 문자열 "" 입니다(앱 밖에서도 같음)
AppboxSDK.getDeviceUserId()성공 { result, message }(ack 없음), 실패 { ack: false, error, code: "NO_DEVICE_ID" }
AppboxSDK.journey.track(){ ok, status } 또는 { ok: false, error }
message.updateTopics()일부라도 실패하면 reject(UPDATE_TOPICS_PARTIAL, 상세는 err.result). 앱 밖에서 부르면 reject 하지 않고 { ack: false, code: "NOT_APPBOX" }
application.isAppBoxSDK()true 또는 false 를 바로 돌려줌(Promise 아님)
앱 밖에서 부를 때 오류 코드가 함수마다 다릅니다. 대부분 NOT_APPBOX 이고, getDeviceUserId 와 journey.track 은 NO_DEVICE_ID, getDeviceInfo 는 오류 없이 빈 값입니다. 앱 안인지는 "앱 안인지 확인" 방법으로 먼저 확인하세요.

시간 제한

SDK 는 앱의 응답을 기다리는 시간 제한을 두지 않습니다. 응답이 올 때까지 Promise 가 끝나지 않으니, 결과를 기다리는 동안 다른 화면 처리를 막지 마세요.

권장 코드

Javascript
1 async function callAppbox(run) {
2 try {
3 const res = await run();
4 if (res && res.ack === false) {
5 return { ok: false, code: res.code, message: res.error };
6 }
7 return { ok: true, data: res };
8 } catch (err) {
9 return { ok: false, code: err.code, message: err.message };
10 }
11 }
12
13 const r = await callAppbox(function () {
14 return AppboxSDK.application.getAppVersion();
15 });
16 if (r.ok) {
17 console.log("앱 버전", r.data.result);
18 } else {
19 console.warn("실패", r.code, r.message);
20 }
함수를 run 으로 넘기는 이유: 위 "입력값 오류를 바로 던지는 함수"는 오류를 바로 던지므로 try 안에서 불러야 잡힙니다.
www.naver.com
QR 코드를 촬영하면 입력하신 주소의
앱 예시 화면을 테스트할 수 있습니다.
* 스캔 후 바로 앱 다운로드 이동합니다.