초기화와 모듈 확인 | Appbox Android SDK 가이드
Android SDK 연동
초기화와 모듈 확인 개요
SDK 상태를 확인하는 API는 서로 다른 층을 검증합니다. is*Available()이 true인데 기능이 동작하지 않는다면, 아래 사다리에서 다음 층을 확인하세요.
| 층 | 확인 방법 | 증명하는 것 |
|---|---|---|
| ① artifact 포함 | is*Available() | 의존성 선언 여부만 |
| ② 초기화 성공 | initialize 반환값의 기능별 status | 설정, 초기화까지 |
| ③ 설정 완비 (로그인 한정) | getAuthProviderDescriptors()의 configured | provider key, 설정까지 |
| ④ 실제 동작 | 기능 호출 | 파이프라인 전체 |
모듈 확인 함수 여섯 개는 모두 같은 계약입니다: 동기 함수이며 즉시 Boolean을 반환하고, 초기화 전에도 호출할 수 있습니다. true는 artifact 포함 여부만 뜻합니다. 초기화 성공이나 설정 완비를 의미하지 않습니다.
SDK 초기화
SDK 초기화
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
| context | 필수 | Application 또는 Activity context. 내부에서 application context를 사용합니다 | - |
| config | 필수 | 공통 설정과 기능별 설정을 담은 AppBoxInitConfig | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
AppBoxInitResult | 즉시 반환되는 초기화 결과. callback이 없습니다 |
.core, .push, .inApp, .webView, .auth, .health, .appsFlyer | 기능별 초기화 결과 |
.{기능}.status | INITIALIZED, SKIPPED, FAILED |
.{기능}.message | 상태 설명 문자열 |
.{기능}.error | 실패 원인 |
값을 즉시 반환합니다. callback이 없습니다.
Application.onCreate()에서 한 번만 호출합니다. 중복 초기화를 막는 장치가 없으므로Activity.onCreate()에서 호출하지 않습니다.- 예외를 던지지 않습니다. 실패는 각 항목의
status와error로 전달됩니다. - 한 기능의 실패가 다른 기능을 막지 않습니다. 사용할 기능의 결과를 각각 확인합니다.
SKIPPED는 설정을 넣지 않았거나 artifact를 추가하지 않은 상태입니다. 사용하지 않는 기능이면 정상입니다.
기능별 설정 클래스(AppBoxPushConfig, AppBoxInAppConfig 등)의 항목은 각 기능 장의 개요에서 다룹니다.
Push 모듈 확인
appbox-push가 앱에 포함됐는지 확인합니다. 푸시 설정 메뉴의 노출 여부를 빌드 구성에 따라 갈라야 할 때 사용합니다.Push 모듈 확인
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
| - | - | 별도 요청 항목 없음 | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
Boolean | appbox-push 포함 여부. 즉시 반환됩니다 |
모듈 확인 공통 계약을 따릅니다. true는 artifact 포함 여부만 뜻합니다. 초기화 설정에 push를 넣지 않았다면 대부분의 Push 함수는 실패합니다.
In-App 모듈 확인
appbox-inapp이 앱에 포함됐는지 확인합니다. 인앱 메시지 관련 동작을 빌드 구성에 따라 갈라야 할 때 사용합니다.In-App 모듈 확인
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
| - | - | 별도 요청 항목 없음 | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
Boolean | appbox-inapp 포함 여부. 즉시 반환됩니다 |
모듈 확인 공통 계약을 따릅니다. 설정 완료나 표시 가능 여부를 의미하지 않습니다.
WebView 모듈 확인
appbox-webview가 앱에 포함됐는지 확인합니다. attachWebView는 실패를 알려주지 않으므로, 연결 전에 이 함수로 확인하면 원인 파악이 쉬워집니다.WebView 모듈 확인
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
| - | - | 별도 요청 항목 없음 | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
Boolean | appbox-webview 포함 여부. 즉시 반환됩니다 |
모듈 확인 공통 계약을 따릅니다.
Health 모듈 확인
appbox-health가 앱에 포함됐는지 확인합니다. 걸음 수 메뉴의 노출 여부를 빌드 구성에 따라 갈라야 할 때 사용합니다.Health 모듈 확인
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
| - | - | 별도 요청 항목 없음 | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
Boolean | appbox-health 포함 여부. 즉시 반환됩니다 |
모듈 확인 공통 계약을 따릅니다. 기기의 Health Connect 설치, 권한 상태와는 무관합니다. 그 두 가지는 걸음 수 조회의 오류 코드로 구분합니다.
AppsFlyer 모듈 확인
appbox-appsflyer가 앱에 포함됐는지 확인합니다. 딥링크 listener 등록 여부를 빌드 구성에 따라 갈라야 할 때 사용합니다.AppsFlyer 모듈 확인
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
| - | - | 별도 요청 항목 없음 | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
Boolean | appbox-appsflyer 포함 여부. 즉시 반환됩니다 |
모듈 확인 공통 계약을 따릅니다. devKey 설정 여부나 AppsFlyer 초기화 성공을 의미하지 않습니다.
로그인 제공자 모듈 확인
getAuthProviderDescriptors()의 configured를 사용하세요 → 로그인 제공자 목록 조회.로그인 제공자 모듈 확인
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
| type | 필수 | AuthProviderType. GOOGLE, APPLE, NAVER, KAKAO | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
Boolean | 해당 제공자 artifact 포함 여부. 즉시 반환됩니다 |
모듈 확인 공통 계약을 따릅니다. 이 함수는 artifact 포함 여부(사다리 ①층)만 알려주며, 버튼 노출 판단은 configured(③층)로 합니다.
기기 사용자 식별자 조회
기기 사용자 식별자 조회
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
| callback | 필수 | AppBoxValueCallback<String> | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
deviceUserId | 기기 사용자 식별자 문자열. 실패 시 null |
| 오류 | error: 초기화 전 호출, 또는 appbox-push, appbox-webview 둘 다 없는 구성 |
appbox-push 또는 appbox-webview 중 하나가 필요합니다. appbox-core만 추가한 구성에서는 실패합니다. 서비스 회원 ID가 아니며 광고 식별자도 아닙니다. 기기 단위 식별자입니다. 값을 로그에 그대로 출력하지 않습니다.
웹 브릿지에서는 appbox.getDeviceUserId입니다.