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

앱 기본 정보 및 환경체크

앱 내 데이터 가져오기

저장된 값을 읽습니다.

앱 내에 데이터를 가져오기

AppBox.shared.get(key:completion:)

Swift
1 AppBox.shared.get(key: "nickName") { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared storageGetWithKey:@"nickName" completion:^(NSString *value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%@", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
key필수가져올 데이터의 키-
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값String?
오류실패 원인. NSError


화면 불필요. 값이 없으면 빈 문자열

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

AppBox Project Id

AppBox 앱 ID를 조회합니다.

AppBox Project Id 가져오기

AppBox.shared.getAppId(completion:)

Swift
1 AppBox.shared.getAppId { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared getAppIdWithCompletion:^(NSString *value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%@", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값String?
오류실패 원인. NSError


화면 불필요. AppBox project ID

웹 브릿지에서는 AppBox Project Id의 getAppId입니다.

앱 이름

앱 이름을 조회합니다.

앱 이름 가져오기

AppBox.shared.getAppName(completion:)

Swift
1 AppBox.shared.getAppName { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared getAppNameWithCompletion:^(NSString *value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%@", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값String?
오류실패 원인. NSError


화면 불필요. CFBundleDisplayName이 없으면 CFBundleName을 사용합니다

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

앱 버전

앱 버전을 조회합니다.

앱 버전

AppBox.shared.getAppVersion(completion:)

Swift
1 AppBox.shared.getAppVersion { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared getAppVersionWithCompletion:^(NSString *value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%@", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값String?
오류실패 원인. NSError


화면 불필요. CFBundleShortVersionString 값입니다

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

배터리 상태

배터리 잔량(%)을 조회합니다.

배터리 잔량 가져오기

AppBox.shared.getBatteryLevel(completion:)

Swift
1 AppBox.shared.getBatteryLevel { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared getBatteryLevelWithCompletion:^(NSInteger value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%d", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값Int
오류실패 원인. NSError


화면 불필요. Int입니다. Android는 Float라 값 처리가 다릅니다

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

클립보드 가져오기

클립보드의 문자열을 읽습니다.

클립보드 가져오기

AppBox.shared.getClipBoard(completion:)

Swift
1 AppBox.shared.getClipBoard { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared getClipBoardWithCompletion:^(NSString *value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%@", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값String?
오류실패 원인. NSError


화면 불필요. 클립보드가 비어 있으면 빈 문자열

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

사용 언어

현재 언어 코드를 조회합니다.

사용 언어 가져오기

AppBox.shared.getCurrentLanguage(completion:)

Swift
1 AppBox.shared.getCurrentLanguage { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared getCurrentLanguageWithCompletion:^(NSString *value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%@", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값String?
오류실패 원인. NSError


화면 불필요. 언어 코드만 반환합니다 (ko, en)

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

AppBox Device Info

단말 정보를 조회합니다.

AppBox Device Info 가져오기

AppBox.shared.getDeviceInfo(completion:)

Swift
1 AppBox.shared.getDeviceInfo { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared getDeviceInfoWithCompletion:^(NSDictionary *value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%@", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값[String: Any]?
오류실패 원인. NSError


화면 불필요. 키는 deviceUserId, pushToken.

웹 브릿지에서는 AppBox Device Info의 getDeviceInfo입니다.

디바이스 모델

기기 모델명을 조회합니다.

디바이스 모델 가져오기

AppBox.shared.getDeviceModel(completion:)

Swift
1 AppBox.shared.getDeviceModel { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared getDeviceModelWithCompletion:^(NSString *value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%@", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값String?
오류실패 원인. NSError


화면 불필요. 기기 식별자입니다. 마케팅 제품명과 다를 수 있습니다

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

OS 버전

OS 버전을 조회합니다.

OS 버전 가져오기

AppBox.shared.getOSVersion(completion:)

Swift
1 AppBox.shared.getOSVersion { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared getOSVersionWithCompletion:^(NSString *value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%@", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값String?
오류실패 원인. NSError


화면 불필요. iOS 버전 문자열

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

패키지 명

번들 식별자를 조회합니다.

패키지 명 가져오기

AppBox.shared.getPackageName(completion:)

Swift
1 AppBox.shared.getPackageName { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared getPackageNameWithCompletion:^(NSString *value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%@", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값String?
오류실패 원인. NSError


화면 불필요. iOS의 Bundle Identifier입니다

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

SDK 버전

AppBox SDK 버전을 조회합니다.

SDK 버전 가져오기

AppBox.shared.getSDKVersion(completion:)

Swift
1 AppBox.shared.getSDKVersion { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared getSDKVersionWithCompletion:^(NSString *value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%@", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값String?
오류실패 원인. NSError


화면 불필요. AppBox SDK 버전

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

디바이스 타입

플랫폼 종류를 조회합니다.

디바이스 타입 (Android, iOS)

AppBox.shared.getType(completion:)

Swift
1 AppBox.shared.getType { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared getTypeWithCompletion:^(NSString *value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%@", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값String?
오류실패 원인. NSError


화면 불필요. 항상 "iOS"

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

안드로이드 여부

안드로이드인지 알려줍니다.

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

AppBox.shared.isAndroid(completion:)

Swift
1 AppBox.shared.isAndroid { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared isAndroidWithCompletion:^(BOOL value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%d", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값Bool
오류실패 원인. NSError


화면 불필요. 항상 false

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

앱 최초 실행 여부

설치 후 첫 실행인지 알려줍니다.

앱 최초 실행 인지 확인

AppBox.shared.isFirstInstallLaunch(completion:)

Swift
1 AppBox.shared.isFirstInstallLaunch { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared isFirstInstallLaunchWithCompletion:^(BOOL value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%d", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값Bool
오류실패 원인. NSError


화면 불필요. 설치 단위로 한 번입니다. 첫 호출에서 true를 돌려준 뒤 기기에 기록이 남아, 앱을 지우고 다시 설치하기 전까지 계속 false입니다

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

앱 실행 세션 최초 여부

이번 세션의 첫 실행인지 알려줍니다.

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

AppBox.shared.isFirstSessionLaunch(completion:)

Swift
1 AppBox.shared.isFirstSessionLaunch { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared isFirstSessionLaunchWithCompletion:^(BOOL value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%d", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값Bool
오류실패 원인. NSError


화면 불필요. 앱 실행 단위로 한 번입니다. 첫 호출에서 true를 돌려준 뒤 그 실행 동안 false이며, 앱을 완전히 종료했다가 다시 켜면 다시 true가 됩니다. 설치 단위로 한 번인 isFirstInstallLaunch와 지속 범위가 다릅니다

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

아이폰 여부

iOS인지 알려줍니다.

아이폰 인지 여부를 체크

AppBox.shared.isIOS(completion:)

Swift
1 AppBox.shared.isIOS { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared isIOSWithCompletion:^(BOOL value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%d", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값Bool
오류실패 원인. NSError


화면 불필요. 항상 true

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

앱 내 데이터 삭제

저장된 값을 지웁니다.

앱에 저장된 데이터 삭제

AppBox.shared.remove(key:completion:)

Swift
1 AppBox.shared.remove(key: "nickName") { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared storageRemoveWithKey:@"nickName" completion:^(BOOL value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%d", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
key필수삭제할 데이터의 키-
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값Bool
오류실패 원인. NSError


화면 불필요. 셀렉터에 storage 접두사가 붙습니다(storageRemoveWithKey:completion:)

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

앱 내 데이터 저장

키-값을 저장합니다.

앱 내에 데이터를 저장

AppBox.shared.set(key:value:completion:)

Swift
1 AppBox.shared.set(key: "nickName", value: "교양있는 고양이") { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared storageSetWithKey:@"nickName" value:@"교양있는 고양이" completion:^(BOOL value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%d", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
key필수저장할 데이터의 키-
value필수저장할 값-
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값Bool
오류실패 원인. NSError


화면 불필요. 셀렉터에 storage 접두사가 붙습니다

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

클립보드 저장

클립보드에 문자열을 넣습니다.

클립보드에 저장하기

AppBox.shared.setClipBoard(message:completion:)

Swift
1 AppBox.shared.setClipBoard(message: "저장했습니다") { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared setClipBoardWithMessage:@"저장했습니다" completion:^(BOOL value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%d", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
message필수클립보드에 저장할 내용-
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

Response 결과값
값Bool
오류실패 원인. NSError


화면 불필요.

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

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