초기화와 모듈 확인 | Appbox Android SDK 가이드

Android SDK 연동

초기화와 모듈 확인 개요

SDK 상태를 확인하는 API는 서로 다른 층을 검증합니다. is*Available()이 true인데 기능이 동작하지 않는다면, 아래 사다리에서 다음 층을 확인하세요.

층확인 방법증명하는 것
① artifact 포함is*Available()의존성 선언 여부만
② 초기화 성공initialize 반환값의 기능별 status설정, 초기화까지
③ 설정 완비 (로그인 한정)getAuthProviderDescriptors()의 configuredprovider key, 설정까지
④ 실제 동작기능 호출파이프라인 전체

모듈 확인 함수 여섯 개는 모두 같은 계약입니다: 동기 함수이며 즉시 Boolean을 반환하고, 초기화 전에도 호출할 수 있습니다. true는 artifact 포함 여부만 뜻합니다. 초기화 성공이나 설정 완비를 의미하지 않습니다.

SDK 초기화

SDK와 사용할 기능 모듈을 초기화합니다. 호출 위치와 설정 절차는 3단계: Manifest와 초기화에서 다루고, 이 문서는 인자와 반환값의 계약을 정의합니다.

SDK 초기화

AppBox.initialize(context, config)

Kotlin
1 val result = AppBox.initialize(context = this, config = config)
2
3 // 반환값은 기능별 초기화 결과를 각각 담습니다. 사용할 기능을 각각 확인하세요.
4 listOf(result.core, result.push, result.webView).forEach { feature ->
5 if (feature.status == AppBoxInitStatus.FAILED) {
6 Log.w("AppBox", feature.error?.message ?: feature.message ?: "init failed")
7 }
8 }
1 AppBoxInitResult result = AppBox.initialize(this, config);
2
3 // 반환값은 기능별 초기화 결과를 각각 담습니다. 사용할 기능을 각각 확인하세요.
4 if (result.getPush().getStatus() == AppBoxInitStatus.FAILED) {
5 Log.w("AppBox", String.valueOf(result.getPush().getMessage()));
6 }

Request 항목 정의

Request 항목필수여부설명기본값
context필수Application 또는 Activity context. 내부에서 application context를 사용합니다-
config필수공통 설정과 기능별 설정을 담은 AppBoxInitConfig-


Response 항목 정의

Response 결과값
AppBoxInitResult즉시 반환되는 초기화 결과. callback이 없습니다
.core, .push, .inApp, .webView, .auth, .health, .appsFlyer기능별 초기화 결과
.{기능}.statusINITIALIZED, SKIPPED, FAILED
.{기능}.message상태 설명 문자열
.{기능}.error실패 원인


값을 즉시 반환합니다. callback이 없습니다.

  • Application.onCreate()에서 한 번만 호출합니다. 중복 초기화를 막는 장치가 없으므로 Activity.onCreate()에서 호출하지 않습니다.
  • 예외를 던지지 않습니다. 실패는 각 항목의 status와 error로 전달됩니다.
  • 한 기능의 실패가 다른 기능을 막지 않습니다. 사용할 기능의 결과를 각각 확인합니다.
  • SKIPPED는 설정을 넣지 않았거나 artifact를 추가하지 않은 상태입니다. 사용하지 않는 기능이면 정상입니다.

기능별 설정 클래스(AppBoxPushConfig, AppBoxInAppConfig 등)의 항목은 각 기능 장의 개요에서 다룹니다.

Push 모듈 확인

appbox-push가 앱에 포함됐는지 확인합니다. 푸시 설정 메뉴의 노출 여부를 빌드 구성에 따라 갈라야 할 때 사용합니다.

Push 모듈 확인

AppBox.isPushAvailable()

Kotlin
1 if (AppBox.isPushAvailable()) showPushSettingsMenu()
1 if (AppBox.isPushAvailable()) showPushSettingsMenu();

Request 항목 정의

Request 항목필수여부설명기본값
--별도 요청 항목 없음-


Response 항목 정의

Response 결과값
Booleanappbox-push 포함 여부. 즉시 반환됩니다


모듈 확인 공통 계약을 따릅니다. true는 artifact 포함 여부만 뜻합니다. 초기화 설정에 push를 넣지 않았다면 대부분의 Push 함수는 실패합니다.

In-App 모듈 확인

appbox-inapp이 앱에 포함됐는지 확인합니다. 인앱 메시지 관련 동작을 빌드 구성에 따라 갈라야 할 때 사용합니다.

In-App 모듈 확인

AppBox.isInAppAvailable()

Kotlin
1 if (AppBox.isInAppAvailable()) {
2 AppBox.showInAppIfAvailable(this) { _, _ -> }
3 }
1 if (AppBox.isInAppAvailable()) {
2 AppBox.showInAppIfAvailable(this, new AppBoxOperationCallback() {
3 @Override
4 public void onComplete(boolean success, Throwable error) { }
5 });
6 }

Request 항목 정의

Request 항목필수여부설명기본값
--별도 요청 항목 없음-


Response 항목 정의

Response 결과값
Booleanappbox-inapp 포함 여부. 즉시 반환됩니다


모듈 확인 공통 계약을 따릅니다. 설정 완료나 표시 가능 여부를 의미하지 않습니다.

WebView 모듈 확인

appbox-webview가 앱에 포함됐는지 확인합니다. attachWebView는 실패를 알려주지 않으므로, 연결 전에 이 함수로 확인하면 원인 파악이 쉬워집니다.

WebView 모듈 확인

AppBox.isWebViewAvailable()

Kotlin
1 if (AppBox.isWebViewAvailable()) AppBox.attachWebView(webView)
1 if (AppBox.isWebViewAvailable()) AppBox.attachWebView(webView);

Request 항목 정의

Request 항목필수여부설명기본값
--별도 요청 항목 없음-


Response 항목 정의

Response 결과값
Booleanappbox-webview 포함 여부. 즉시 반환됩니다


모듈 확인 공통 계약을 따릅니다.

Health 모듈 확인

appbox-health가 앱에 포함됐는지 확인합니다. 걸음 수 메뉴의 노출 여부를 빌드 구성에 따라 갈라야 할 때 사용합니다.

Health 모듈 확인

AppBox.isHealthAvailable()

Kotlin
1 if (!AppBox.isHealthAvailable()) hideHealthMenu()
1 if (!AppBox.isHealthAvailable()) hideHealthMenu();

Request 항목 정의

Request 항목필수여부설명기본값
--별도 요청 항목 없음-


Response 항목 정의

Response 결과값
Booleanappbox-health 포함 여부. 즉시 반환됩니다


모듈 확인 공통 계약을 따릅니다. 기기의 Health Connect 설치, 권한 상태와는 무관합니다. 그 두 가지는 걸음 수 조회의 오류 코드로 구분합니다.

AppsFlyer 모듈 확인

appbox-appsflyer가 앱에 포함됐는지 확인합니다. 딥링크 listener 등록 여부를 빌드 구성에 따라 갈라야 할 때 사용합니다.

AppsFlyer 모듈 확인

AppBox.isAppsFlyerAvailable()

Kotlin
1 if (AppBox.isAppsFlyerAvailable()) registerDeepLinkListener()
1 if (AppBox.isAppsFlyerAvailable()) registerDeepLinkListener();

Request 항목 정의

Request 항목필수여부설명기본값
--별도 요청 항목 없음-


Response 항목 정의

Response 결과값
Booleanappbox-appsflyer 포함 여부. 즉시 반환됩니다


모듈 확인 공통 계약을 따릅니다. devKey 설정 여부나 AppsFlyer 초기화 성공을 의미하지 않습니다.

로그인 제공자 모듈 확인

특정 제공자의 artifact가 앱에 포함됐는지 확인합니다. 로그인 버튼 노출 판단에는 이 함수 대신 getAuthProviderDescriptors()의 configured를 사용하세요 → 로그인 제공자 목록 조회.

로그인 제공자 모듈 확인

AppBox.isAuthAvailable(type)

Kotlin
1 if (AppBox.isAuthAvailable(AuthProviderType.KAKAO)) prepareKakaoButton()
1 if (AppBox.isAuthAvailable(AuthProviderType.KAKAO)) prepareKakaoButton();

Request 항목 정의

Request 항목필수여부설명기본값
type필수AuthProviderType. GOOGLE, APPLE, NAVER, KAKAO-


Response 항목 정의

Response 결과값
Boolean해당 제공자 artifact 포함 여부. 즉시 반환됩니다


모듈 확인 공통 계약을 따릅니다. 이 함수는 artifact 포함 여부(사다리 ①층)만 알려주며, 버튼 노출 판단은 configured(③층)로 합니다.

기기 사용자 식별자 조회

SDK가 만든 기기 사용자 식별자를 조회합니다. 사용자 여정 데이터와 연결할 때 사용합니다.

기기 사용자 식별자 조회

AppBox.getDeviceUserId(callback)

Kotlin
1 AppBox.getDeviceUserId { deviceUserId, error ->
2 if (error != null) return@getDeviceUserId
3 linkDeviceUser(deviceUserId)
4 }
1 AppBox.getDeviceUserId(new AppBoxValueCallback<String>() {
2 @Override
3 public void onComplete(String deviceUserId, Throwable error) {
4 if (error != null) return;
5 linkDeviceUser(deviceUserId);
6 }
7 });

Request 항목 정의

Request 항목필수여부설명기본값
callback필수AppBoxValueCallback<String>-


Response 항목 정의

Response 결과값
deviceUserId기기 사용자 식별자 문자열. 실패 시 null
오류error: 초기화 전 호출, 또는 appbox-push, appbox-webview 둘 다 없는 구성


appbox-push 또는 appbox-webview 중 하나가 필요합니다. appbox-core만 추가한 구성에서는 실패합니다. 서비스 회원 ID가 아니며 광고 식별자도 아닙니다. 기기 단위 식별자입니다. 값을 로그에 그대로 출력하지 않습니다.

웹 브릿지에서는 appbox.getDeviceUserId입니다.

www.naver.com
QR 코드를 촬영하면 입력하신 주소의
앱 예시 화면을 테스트할 수 있습니다.
* 스캔 후 바로 앱 다운로드 이동합니다.