앱 기본 정보 및 환경체크 | Appbox Android SDK 가이드

기기 기능

앱 내 데이터 가져오기

네이티브 영역에 저장된 값을 읽습니다. 웹과 네이티브가 공유하는 값을 가져올 때 사용합니다.

get(key, callback)

호출 형태: 패턴 B(인자 있는 값 조회).

앱 내에 데이터를 가져오기

AppBox.get(key, callback)

Kotlin
1 AppBox.get(key = "nickName") { value, error ->
2 if (error != null) return@get
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.get("nickName", (value, error) -> {
2 if (error != null) return;
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

Request 항목필수여부설명기본값
key필수가져올 데이터의 키-


Response 항목 정의

Response 결과값
값저장된 값 (String). 값이 없으면 빈 문자열

웹 브릿지에서는 앱 내 데이터 가져오기의 storage.get입니다.

AppBox Project Id

AppBox project ID를 조회합니다. 웹, 서버와 프로젝트 식별자를 맞춰야 할 때 사용합니다.

getAppId(callback)

호출 형태: 패턴 A(인자 없는 값 조회).

AppBox Project Id 가져오기

AppBox.getAppId(callback)

Kotlin
1 AppBox.getAppId { value, error ->
2 if (error != null) return@getAppId
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.getAppId((value, error) -> {
2 if (error != null) return;
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
값AppBox project ID (String). 설정되지 않았으면 빈 문자열

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

앱 이름

실행 중인 앱의 이름을 조회합니다. UI 표시나 환경별 문구 구성에 사용합니다.

getAppName(callback)

호출 형태: 패턴 A(인자 없는 값 조회).

앱 이름 가져오기

AppBox.getAppName(callback)

Kotlin
1 AppBox.getAppName { value, error ->
2 if (error != null) return@getAppName
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.getAppName((value, error) -> {
2 if (error != null) return;
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
값앱 이름 (String). 예: 모두의 배달

웹 브릿지에서는 앱 이름의 application.getAppName입니다.

앱 버전

설치된 앱의 버전을 조회합니다. 버전별 기능 분기나 업데이트 유도 판단에 사용합니다.

getAppVersion(callback)

호출 형태: 패턴 A(인자 없는 값 조회).

앱 버전

AppBox.getAppVersion(callback)

Kotlin
1 AppBox.getAppVersion { value, error ->
2 if (error != null) return@getAppVersion
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.getAppVersion((value, error) -> {
2 if (error != null) return;
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
값앱 버전 (String). 예: 1.0.5

웹 브릿지에서는 앱 버전의 application.getAppVersion입니다.

배터리 상태

배터리 잔량(%)을 조회합니다. 배터리 소모가 큰 기능 실행 전 안내에 사용합니다.

getBatteryLevel(callback)

호출 형태: 패턴 A(인자 없는 값 조회).

배터리 잔량 가져오기

AppBox.getBatteryLevel(callback)

Kotlin
1 AppBox.getBatteryLevel { value, error ->
2 if (error != null || value == null) return@getBatteryLevel // value null 확인 필수
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.getBatteryLevel((value, error) -> {
2 if (error != null || value == null) return; // value null 확인 필수
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
값배터리 잔량 (Float). 예: 75


배터리 정보를 읽지 못하면 error 없이 value가 null로 옵니다. value를 반드시 확인하세요.

웹 브릿지에서는 배터리 상태의 application.getBatteryLevel입니다.

클립보드 가져오기

기기 클립보드에 저장된 문자열을 읽습니다. 사용자가 복사해 둔 값을 자동 입력할 때 사용합니다.

getClipBoard(callback)

호출 형태: 패턴 A(인자 없는 값 조회).

클립보드 가져오기

AppBox.getClipBoard(callback)

Kotlin
1 AppBox.getClipBoard { value, error ->
2 if (error != null) return@getClipBoard
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.getClipBoard((value, error) -> {
2 if (error != null) return;
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
값클립보드에 저장된 값 (String). 비어 있으면 빈 문자열

웹 브릿지에서는 클립보드 가져오기의 application.getClipBoard입니다.

사용 언어

현재 언어 코드를 조회합니다. 다국어 화면의 언어 분기에 사용합니다.

getCurrentLanguage(callback)

호출 형태: 패턴 A(인자 없는 값 조회).

사용 언어 가져오기

AppBox.getCurrentLanguage(callback)

Kotlin
1 AppBox.getCurrentLanguage { value, error ->
2 if (error != null) return@getCurrentLanguage
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.getCurrentLanguage((value, error) -> {
2 if (error != null) return;
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
값언어 코드 (String). 예: ko, en


언어 코드만 반환합니다. 국가 코드는 포함되지 않습니다.

웹 브릿지에서는 사용 언어의 application.getCurrentLanguage입니다.

AppBox Device Info

기기 사용자 식별자와 Push token을 한 번에 조회합니다. 두 값을 함께 쓰는 연동 코드에서 호출 횟수를 줄일 때 사용합니다.

getDeviceInfo(callback)

호출 형태: 패턴 E(Map 반환).

AppBox Device Info 가져오기

AppBox.getDeviceInfo(callback)

Kotlin
1 AppBox.getDeviceInfo { info, error ->
2 if (error != null || info == null) return@getDeviceInfo
3 link(info["deviceUserId"], info["pushToken"])
4 }
1 AppBox.getDeviceInfo(new AppBoxValueCallback<Map<String, String>>() {
2 @Override
3 public void onComplete(Map<String, String> info, Throwable error) {
4 if (error != null || info == null) return;
5 link(info.get("deviceUserId"), info.get("pushToken"));
6 }
7 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
값Map<String, String>: 키는 deviceUserId, pushToken 두 개이며 항상 존재합니다


Push token이 없어도 실패가 아니라 빈 문자열입니다 (appbox-push 미포함, 미초기화, 발급 실패 모두 동일).

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

디바이스 모델

기기 모델명을 조회합니다. 특정 모델 이슈 대응이나 기기별 최적화에 사용합니다.

getDeviceModel(callback)

호출 형태: 패턴 A(인자 없는 값 조회).

디바이스 모델 가져오기

AppBox.getDeviceModel(callback)

Kotlin
1 AppBox.getDeviceModel { value, error ->
2 if (error != null) return@getDeviceModel
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.getDeviceModel((value, error) -> {
2 if (error != null) return;
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
값기기 모델명 (String)


Build.MODEL 값입니다. 마케팅 제품명과 다를 수 있습니다.

웹 브릿지에서는 디바이스 모델의 application.getDeviceModel입니다.

OS 버전

OS 버전을 조회합니다. OS 버전별 동작 분기나 이슈 리포트 수집에 사용합니다.

getOSVersion(callback)

호출 형태: 패턴 A(인자 없는 값 조회).

OS 버전 가져오기

AppBox.getOSVersion(callback)

Kotlin
1 AppBox.getOSVersion { value, error ->
2 if (error != null) return@getOSVersion
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.getOSVersion((value, error) -> {
2 if (error != null) return;
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
값OS 버전 문자열 (String). 예: 14


Build.VERSION.RELEASE 값입니다. API level이 아닙니다.

웹 브릿지에서는 OS 버전의 application.getOSVersion입니다.

패키지 명

앱의 패키지 명(번들 식별자)을 조회합니다. 환경 식별이나 플랫폼 설정 검증에 사용합니다.

getPackageName(callback)

호출 형태: 패턴 A(인자 없는 값 조회).

패키지 명 가져오기

AppBox.getPackageName(callback)

Kotlin
1 AppBox.getPackageName { value, error ->
2 if (error != null) return@getPackageName
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.getPackageName((value, error) -> {
2 if (error != null) return;
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
값패키지 명 (String). 예: com.company.service

웹 브릿지에서는 패키지 명의 application.getPackageName입니다.

SDK 버전

AppBox SDK 버전을 조회합니다. 기능 호환 체크나 버전별 동작 분기에 사용합니다.

getSDKVersion(callback)

호출 형태: 패턴 A(인자 없는 값 조회).

SDK 버전 가져오기

AppBox.getSDKVersion(callback)

Kotlin
1 AppBox.getSDKVersion { value, error ->
2 if (error != null) return@getSDKVersion
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.getSDKVersion((value, error) -> {
2 if (error != null) return;
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
값AppBox SDK 버전 (String)


설치 확인의 3층 진단에서 파이프라인 전체 동작 검증에 쓰입니다. 이 콜백이 응답하면 기기 기능 파이프라인이 동작하는 것입니다.

웹 브릿지에서는 SDK 버전의 application.getSDKVersion입니다.

디바이스 타입

플랫폼 종류를 문자열로 조회합니다. 웹과 코드를 공유하는 하이브리드 화면의 플랫폼 분기용입니다.

getType(callback)

호출 형태: 패턴 A(인자 없는 값 조회).

디바이스 타입 (Android, iOS)

AppBox.getType(callback)

Kotlin
1 AppBox.getType { value, error ->
2 if (error != null) return@getType
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.getType((value, error) -> {
2 if (error != null) return;
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
값디바이스 타입 (String). 네이티브 호출에서는 항상 "Android"

웹 브릿지에서는 디바이스 타입의 application.getType입니다.

안드로이드 여부

Android인지 알려줍니다. 웹과 코드를 공유하는 하이브리드 화면의 플랫폼 분기용이며, 네이티브 호출에서는 값이 고정입니다.

isAndroid(callback)

호출 형태: 패턴 A(인자 없는 값 조회).

안드로이드 인지 여부를 체크

AppBox.isAndroid(callback)

Kotlin
1 AppBox.isAndroid { value, error ->
2 if (error != null) return@isAndroid
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.isAndroid((value, error) -> {
2 if (error != null) return;
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
값Boolean. 네이티브 호출에서는 항상 true

웹 브릿지에서는 안드로이드 여부의 application.isAndroid입니다.

앱 최초 실행 여부

설치 후 첫 실행인지 알려줍니다. 온보딩 화면 노출이나 초기 설정 안내 분기에 사용합니다.

isFirstInstallLaunch(callback)

호출 형태: 패턴 A(인자 없는 값 조회).

앱 최초 실행 인지 확인

AppBox.isFirstInstallLaunch(callback)

Kotlin
1 AppBox.isFirstInstallLaunch { first, error ->
2 if (error != null) return@isFirstInstallLaunch
3 if (first == true) showOnboarding()
4 }
1 AppBox.isFirstInstallLaunch((first, error) -> {
2 if (error != null) return;
3 if (Boolean.TRUE.equals(first)) showOnboarding();
4 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
값설치 후 첫 실행 여부 (Boolean)


1회성입니다. 읽는 즉시 값이 소비되어 다음 호출부터 false가 됩니다. 여러 곳에서 호출하지 말고 한 번 읽어 앱이 보관하세요.

웹 브릿지에서는 앱 최초 실행 여부의 application.isFirstInstallLaunch입니다.

앱 실행 세션 최초 여부

앱을 완전히 종료한 뒤 첫 진입인지 알려줍니다. 세션 초기화나 재실행 시점 전용 동작 분기에 사용합니다.

isFirstSessionLaunch(callback)

호출 형태: 패턴 A(인자 없는 값 조회).

앱 실행 세션 최초 여부를 체크

AppBox.isFirstSessionLaunch(callback)

Kotlin
1 AppBox.isFirstSessionLaunch { first, error ->
2 if (error != null) return@isFirstSessionLaunch
3 if (first == true) resetSessionState()
4 }
1 AppBox.isFirstSessionLaunch((first, error) -> {
2 if (error != null) return;
3 if (Boolean.TRUE.equals(first)) resetSessionState();
4 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
값세션 첫 실행 여부 (Boolean)


1회성입니다. 읽는 즉시 값이 소비되어 다음 호출부터 false가 됩니다. 여러 곳에서 호출하지 말고 한 번 읽어 앱이 보관하세요.

웹 브릿지에서는 앱 실행 세션 최초 여부의 application.isFirstSessionLaunch입니다.

아이폰 여부

iOS인지 알려줍니다. 웹과 코드를 공유하는 하이브리드 화면의 플랫폼 분기용이며, 네이티브 호출에서는 값이 고정입니다.

isIOS(callback)

호출 형태: 패턴 A(인자 없는 값 조회).

아이폰 인지 여부를 체크

AppBox.isIOS(callback)

Kotlin
1 AppBox.isIOS { value, error ->
2 if (error != null) return@isIOS
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.isIOS((value, error) -> {
2 if (error != null) return;
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
값Boolean. 네이티브 호출에서는 항상 false

웹 브릿지에서는 아이폰 여부의 application.isIOS입니다.

앱 내 데이터 삭제

네이티브 영역에 저장된 값을 지웁니다. 로그아웃 처리나 환경 초기화에 사용합니다.

remove(key, callback)

호출 형태: 패턴 B(인자 있는 값 조회).

앱에 저장된 데이터 삭제

AppBox.remove(key, callback)

Kotlin
1 AppBox.remove(key = "nickName") { value, error ->
2 if (error != null) return@remove
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.remove("nickName", (value, error) -> {
2 if (error != null) return;
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

Request 항목필수여부설명기본값
key필수삭제할 데이터의 키-


Response 항목 정의

Response 결과값
값성공 여부 (Boolean)

웹 브릿지에서는 앱 내 데이터 삭제의 storage.remove입니다.

앱 내 데이터 저장

키-값을 네이티브 영역에 저장합니다. 앱을 재실행하거나 WebView가 새로 로딩돼도 유지되어, 웹과 네이티브가 값을 공유할 때 사용합니다.

set(key, value, callback)

호출 형태: 패턴 B(인자 있는 값 조회).

앱 내에 데이터를 저장

AppBox.set(key, value, callback)

Kotlin
1 AppBox.set(key = "nickName", value = "교양있는 고양이") { value, error ->
2 if (error != null) return@set
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.set("nickName", "교양있는 고양이", (value, error) -> {
2 if (error != null) return;
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

Request 항목필수여부설명기본값
key필수저장할 데이터의 키-
value필수저장할 값-


Response 항목 정의

Response 결과값
값성공 여부 (Boolean)
오류 코드-2000: key 또는 value 누락

웹 브릿지에서는 앱 내 데이터 저장의 storage.set입니다.

클립보드 저장

기기 클립보드에 문자열을 넣습니다. 쿠폰 코드, 주소 복사 같은 편의 기능에 사용합니다.

setClipBoard(message, callback)

호출 형태: 패턴 C(인자 있는 동작).

클립보드에 저장하기

AppBox.setClipBoard(message, callback)

Kotlin
1 AppBox.setClipBoard(message = "저장했습니다") { value, error ->
2 if (error != null) return@setClipBoard
3 Log.d("AppBox", value.toString())
4 }
1 AppBox.setClipBoard("저장했습니다", (value, error) -> {
2 if (error != null) return;
3 Log.d("AppBox", String.valueOf(value));
4 });

Request 항목 정의

Request 항목필수여부설명기본값
message필수클립보드에 저장할 내용-


Response 항목 정의

Response 결과값
값성공 여부 (Boolean)


Android 13 이상에서는 민감 정보 플래그가 설정되어 클립보드 미리보기에 내용이 표시되지 않습니다.

웹 브릿지에서는 클립보드 저장의 application.setClipBoard입니다.

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