사용자 경험, 알림, 인터랙션 | Appbox iOS SDK 가이드

사용자 경험, 알림, 인터랙션

생체 인증

생체 인증을 요청합니다.

생체정보 인증하기

AppBox.shared.biometricAuth(haptic:completion:)

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

Request 항목 정의

Request 항목필수여부설명기본값
haptic-성공 또는 실패시 진동 햅틱 (true, false)-
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

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


화면 불필요. 축약형 (completion:)

웹 브릿지에서는 생체 인증의 application.biometricAuth입니다.

앱 종료

앱을 종료합니다.

앱을 강제 종료

AppBox.shared.exit(completion:)

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

Request 항목 정의

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

Response 항목 정의

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


화면 불필요. 셀렉터가 exitApp...입니다. iOS는 앱의 임의 종료를 권장하지 않습니다. 심사에서 문제가 될 수 있습니다

웹 브릿지에서는 앱 종료의 application.exit입니다.

앱 설정으로 이동

앱의 시스템 설정 화면을 엽니다.

OS의 앱 설정으로 이동

AppBox.shared.openAppSettings(completion:)

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

Request 항목 정의

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

Response 항목 정의

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


화면 불필요. 이 앱의 iOS 설정 화면을 엽니다

웹 브릿지에서는 앱 설정으로 이동의 application.openAppSettings입니다.

앱 평가

스토어 리뷰 요청 팝업을 띄웁니다.

마켓의 앱 평가 점수 올리기

AppBox.shared.reviewRequest(completion:)

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

Request 항목 정의

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

Response 항목 정의

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


화면 불필요. 화면을 띄우는 다른 함수가 진행 중이면 -1003으로 실패합니다. SKStoreReviewController 요청입니다. iOS가 실제 표시 여부를 결정하므로 성공이 노출을 보장하지 않습니다

웹 브릿지에서는 앱 평가의 application.reviewRequest입니다.

토스트 메시지

토스트 메시지를 띄웁니다.

토스트 메시지 띄우기

AppBox.shared.toastShow(message:delaySecond:backColor:textColor:fontSize:haptic:completion:)

Swift
1 AppBox.shared.toastShow(message: "저장했습니다", delaySecond: 2.0, backColor: "#000000", textColor: "#FFFFFF", fontSize: 12, haptic: true) { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared toastShowWithMessage:@"저장했습니다" delaySecond:2.0 backColor:@"#000000" textColor:@"#FFFFFF" fontSize:12 haptic:YES completion:^(BOOL value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%d", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
message필수메시지-
delaySecond필수유지 시간(초). 0이면 사라지지 않고 터치해야 닫힙니다-
backColor-배경 색#000000
textColor-텍스트 색#FFFFFF
fontSize-텍스트 크기12
haptic-표시할 때 햅틱 진동 여부true
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

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


화면 필요. 축약형 (message:delaySecond:completion:)

웹 브릿지에서는 토스트 메시지의 application.toastShow입니다.

앱 업데이트

스토어 버전과 비교해 업데이트 팝업을 띄웁니다.

앱을 최신 버전으로 업데이트

AppBox.shared.updatePrompt(message:cancelButton:updateButton:appStore:require:updateAlert:completion:)

Swift
1 AppBox.shared.updatePrompt(message: "저장했습니다", cancelButton: "다음에", updateButton: "업데이트", appStore: "https://apps.apple.com/kr/app/id000000000", require: false, updateAlert: false) { value, error in
2 guard error == nil else { return }
3 print(value)
4 }
1 [AppBox.shared updatePromptWithMessage:@"저장했습니다" cancelButton:@"다음에" updateButton:@"업데이트" appStore:@"https://apps.apple.com/kr/app/id000000000" require:NO updateAlert:NO completion:^(NSDictionary *value, NSError *error) {
2 if (error) { return; }
3 NSLog(@"%@", value);
4 }];

Request 항목 정의

Request 항목필수여부설명기본값
message필수업데이트 안내 메시지-
cancelButton-취소 버튼 텍스트. require가 false면 사실상 필수입니다-
updateButton필수업데이트 버튼 텍스트-
appStore필수App Store 다운로드 URL. https://apps.apple.com/kr/app/id{Apple ID} 형식-
require필수true면 강제 업데이트(닫을 수 없음), false면 권장-
updateAlert-업데이트 안내를 SDK가 띄울지 여부. false면 앱이 직접 띄웁니다true
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

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


화면 필요. 축약형 (message:cancelButton:updateButton:appStore:require:completion:)

웹 브릿지에서는 앱 업데이트의 application.updatePrompt입니다.

로딩 인디케이터 표시

로딩 인디케이터를 화면에 띄웁니다.

로딩 인디케이터 표시

AppBox.shared.loadingShow(loadingIcon:sizePercentage:backColor:iconColor:completion:)

Swift
1 AppBox.shared.loadingShow(
2 loadingIcon: "<ICON_URL>",
3 sizePercentage: 10,
4 backColor: "#1a000000",
5 iconColor: "#999999"
6 ) { success, error in
7 guard error == nil else { return }
8 print(success)
9 }
1 [AppBox.shared loadingShowWithLoadingIcon:@"<ICON_URL>"
2 sizePercentage:10
3 backColor:@"#1a000000"
4 iconColor:@"#999999"
5 completion:^(BOOL success, NSError *error) {
6 if (error != nil) { return; }
7 NSLog(@"%d", success);
8 }];

Request 항목 정의

Request 항목필수여부설명기본값
loadingIcon필수표시할 아이콘 리소스-
sizePercentage-화면 가로 대비 크기 비율(%)10
backColor-배경 색#1a000000
iconColor-아이콘 틴트 색#999999
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

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


화면 필요. 축약형 (loadingIcon:completion:)

웹 브릿지에서는 application.loadingShow입니다.

진동 울리기

기기를 진동시킵니다.

진동으로 알림을 명확하게

AppBox.shared.vibrate(type:vibrationCount:completion:)

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

Request 항목 정의

Request 항목필수여부설명기본값
type필수진동 타입: haptic / short / long-
vibrationCount필수진동 횟수-
completion필수결과를 받는 콜백. 메인 스레드에서 한 번 호출됩니다-

Response 항목 정의

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


화면 불필요. type으로 진동 종류를 지정합니다

웹 브릿지에서는 진동 울리기의 application.vibrate입니다.

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