공통 규칙 | Appbox Android SDK 가이드
Android SDK 연동
공통 규칙 개요
이 문서의 모든 함수에 적용되는 규칙입니다.
| 규칙 | 내용 |
|---|---|
| 호출 형태 | 모든 함수는 AppBox.함수명(...) 정적 API. Java도 같은 형태 |
| 비동기 결과 | AppBoxOperationCallback 또는 AppBoxValueCallback<T>. main thread에서 최대 한 번 호출 |
success == true | SDK가 요청을 처리했다는 의미. 서버 저장, 화면 노출 완료를 항상 보장하지 않음 (함수별 주의사항 확인) |
| artifact 부재 시 | 앱을 중단시키지 않고 callback의 error로 실패 전달 |
| 미제공 | 공개 suspend 함수, Result<T> 반환 함수 |
콜백 타입
콜백 타입
Kotlin
1
public fun interface AppBoxOperationCallback {
2
public fun onComplete(success: Boolean, error: Throwable?)
3
}
4
5
public fun interface AppBoxValueCallback<T> {
6
public fun onComplete(value: T?, error: Throwable?)
7
}
항목 정의
두 타입은 Kotlin fun interface이므로 람다로 전달할 수 있습니다. 이 문서는 마지막 인자일 때 trailing lambda 형태를 사용합니다. Java에서는 익명 클래스로 구현합니다.
| 인터페이스 | Kotlin 람다 | Java 구현 |
|---|---|---|
AppBoxOperationCallback | 가능 | new AppBoxOperationCallback() { onComplete(boolean, Throwable) } |
AppBoxValueCallback<T> | 가능 | new AppBoxValueCallback<T>() { onComplete(T, Throwable) } |
AppBoxInAppActionListener | 가능 | new AppBoxInAppActionListener() { onAction(AppBoxInAppActionEvent) } |
AppBoxAppsFlyerDeepLinkListener | 가능 | new AppBoxAppsFlyerDeepLinkListener() { onDeepLink(AppBoxAppsFlyerDeepLinkResult) } |
PushEventListener | 불가 | new PushEventListener() { onPushClicked(Context, PushEventPayload) } |
PushEventListener만 일반 interface이므로 Kotlin에서도 람다를 쓸 수 없고 object : PushEventListener { ... } 형태로 구현합니다.
Java 호출 규칙
- Kotlin 프로퍼티는 getter로 읽습니다. 예:
payload.getTitle(),result.getCore().getStatus() - 기본값이 있는 생성자는 Java에서 쓸 수 없으므로 설정 클래스는
Builder를 사용합니다. Boolean?,Double?같은 nullable 타입은 Java에서 박싱 타입(Boolean,Double)입니다. non-null 타입은 원시 타입(boolean,double,long,float)입니다.
예외 카탈로그
error로 전달되는 예외 타입의 의미를 정의합니다. 각 함수 문서에는 그 함수에서 발생 가능한 예외와 발생 조건만 적혀 있으며, 의미는 이 표가 정본입니다.항목 정의
| 예외 | 의미 |
|---|---|
AppBox{기능}UnavailableException | 해당 기능 artifact 미포함. Push, InApp, Auth, Health, AppsFlyer, WebView, Conversion |
AppBox{기능}NotConfiguredException | 초기화 설정 누락 (artifact는 있음). Push, InApp, Auth, AppsFlyer |
AuthCancelledException | 사용자의 정상적인 로그인 취소. 오류 화면을 띄우지 않습니다 |
AppBoxPushPromptInterruptedException | 권한 프롬프트가 응답 없이 종료됨. 거부가 아닙니다 |
AppBoxBridgeException | 기기 기능 실행 실패. errorCode에 숫자 코드를 담습니다 → 기기 기능 공통 규칙의 코드 표 |
AppBoxHealthException | 걸음 수 조회 실패. errorCode로 원인을 구분합니다 → 걸음 수 조회 |
AppBoxDeviceBridgeUnavailableException | 기기 기능 호출 시 appbox-webview 미포함 |
Unavailable은 설치 확인의 1층(artifact 포함), NotConfigured는 2층(초기화 설정)에 대응합니다. 어떤 예외가 왔는지가 곧 어느 단계로 돌아가야 하는지를 알려줍니다.