초기화 및 화면 | Appbox iOS SDK 가이드
초기화 및 화면
SDK 초기화
SDK 초기화
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
config | 필수 | 공통 설정과 기능별 설정을 담은 AppBoxInitConfig | - |
config.common | 필수 | projectId, debugMode를 담은 공통 설정 | - |
config.webView | 선택 | AppBox 화면과 WebView 설정 | nil |
config.push | 선택 | Push 설정 | nil |
config.inApp | 선택 | Native In-App 설정 | 활성 config |
config.auth | 선택 | SNS 로그인 설정 | nil |
config.appsFlyer | 선택 | AppsFlyer 설정 | nil |
config.initializationTimeout | 선택 | 기능 모듈 초기화 제한 시간 | 30초, 최소 1초 |
completion | 필수 | 기능별 초기화 결과를 받는 callback | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
AppBoxInitResult | 비동기로 전달되는 초기화 결과 |
.core, .webView, .push, .inApp, .auth, .health, .appsFlyer | 기능별 AppBoxModuleInitResult |
.{기능}.status | .INITIALIZED, .SKIPPED, .FAILED 중 하나 |
.{기능}.message | 상태 설명 |
.{기능}.error | 실패 원인. 성공 또는 건너뜀 상태에서는 nil일 수 있음 |
앱 시작 지점 한 곳에서 한 번 호출합니다.
- 같은 설정으로 초기화가 진행 중이면 작업을 공유하고 각 completion을 한 번씩 호출합니다. 완료 후 같은 설정으로 호출하면 저장된 결과를 반환합니다.
- 다른 설정으로 다시 호출하면
.conflictingInitialization오류가 발생합니다. core성공이 다른 모듈의 성공을 의미하지 않습니다. 사용할 기능의 결과를 각각 확인합니다..SKIPPED는 해당 Product 또는 config를 사용하지 않은 상태입니다.config.webView는 선택 인자입니다. AppBox 관리 화면을 쓰지 않는 앱은 생략하며, 이때webView의 status는.SKIPPED가 됩니다.
AppBox 화면 시작
UIViewController에서 시작합니다.
AppBox 화면 시작
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
viewController | 필수 | AppBox 화면을 표시할 UIViewController | - |
completion | 선택 | 화면 시작 요청 처리 결과 | nil |
Response 항목 정의
| Response 결과값 | |
|---|---|
success | 화면 시작 요청이 SDK에 전달되면 true |
error | 시작 요청 실패 원인 |
webView 초기화 결과가 .INITIALIZED인지 먼저 확인합니다. UI를 표시할 수 있는 시점에 현재 화면 계층의 view controller를 전달합니다. success == true는 웹 페이지 로딩 완료를 의미하지 않습니다.
WebView 미리 로드
WebView 미리 로드
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
completion | 선택 | 미리 로드 결과 callback | nil |
Response 항목 정의
| Response 결과값 | |
|---|---|
loaded | WebView 준비 성공 여부 |
webView 초기화가 완료된 뒤 호출합니다. 이 completion에는 별도 NSError가 없습니다. 상세 원인은 초기화 결과와 SDK 진단 로그를 함께 확인합니다. 미리 로드는 선택 사항이며 start 호출의 필수 조건이 아닙니다.
기본 URL 설정
기본 URL 설정
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
baseURL | 필수 | host가 있는 http 또는 https URL 문자열 | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
| 없음 | 반환값과 callback이 모두 없습니다 |
입력 타입은 URL이 아니라 String입니다. 새 앱에서는 가능하면 AppBoxWebViewConfig(baseURL:)로 초기화 시점에 설정합니다. 잘못된 URL은 화면 시작 또는 로딩 실패 원인이 됩니다.
로딩 indicator 설정
로딩 indicator 설정
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
enabled | 필수 | indicator 표시 여부 | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
| 없음 | 반환값과 callback이 모두 없습니다 |
AppBox 관리 화면의 로딩 UI에만 적용됩니다. indicator 모양과 색상은 setLoadingData(_:)로 설정합니다.
로딩 화면 설정
로딩 화면 설정
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
config | 필수 | 로딩 화면 설정 | - |
config.sizePercentage | 선택 | indicator 크기 비율 | 10 |
config.iconColor | 선택 | indicator hex 색상 | #999999 |
config.backColor | 선택 | 배경 hex 색상 | #1a000000 |
Response 항목 정의
| Response 결과값 | |
|---|---|
| 없음 | 반환값과 callback이 모두 없습니다 |
색상은 SDK가 지원하는 hex 문자열로 전달합니다. 앱 디자인과 명도 대비를 확인합니다. indicator 표시 자체는 setIndicatorEnabled(_:)로 제어합니다.
시스템 바 외관 설정
시스템 바 외관 설정
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
backgroundHex | 선택 | 6자리 또는 8자리 hex 배경색 | nil |
style | 선택 | .auto, .light, .dark | .auto |
Response 항목 정의
| Response 결과값 | |
|---|---|
| 없음 | 반환값과 callback이 모두 없습니다 |
.light와 .dark는 배경이 아니라 상태바 글자, 아이콘의 밝기입니다. 잘못된 hex를 전달하면 배경과 style을 모두 변경하지 않습니다. Objective-C에서는 기본 인자가 없으므로 두 인자를 모두 전달합니다.
당겨서 새로고침 설정
당겨서 새로고침 설정
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
used | 필수 | pull-to-refresh 사용 여부 | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
| 없음 | 반환값과 callback이 모두 없습니다 |
AppBox 관리 화면에만 적용됩니다. 페이지 자체의 스크롤, 새로고침 정책과 충돌하지 않는지 확인합니다.
Intro 설정
Intro 설정
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
items | 필수 | Intro 색상과 이미지 목록을 담은 AppBoxIntro | - |
items.item | 필수 | 유효한 이미지 URL을 가진 AppBoxIntroItems 배열 | - |
items.indicatorDefColor | 선택 | 비선택 indicator 색상 | #a7abab |
items.indicatorSelColor | 선택 | 선택 indicator 색상 | #000000 |
items.fontColor | 선택 | 글자 색상 | #000000 |
Response 항목 정의
| Response 결과값 | |
|---|---|
| 없음 | 반환값과 callback이 모두 없습니다 |
AppBoxIntroItems(imageUrl:)는 imageUrl이 빈 문자열일 때만 nil을 반환합니다. URL 형식은 검증하지 않으므로, 비어 있지 않은 문자열은 잘못된 URL이어도 통과합니다. 원격 이미지 로딩 실패를 고려해 서비스 화면의 대체 동작을 확인합니다. 이미지 URL과 색상값을 로그에 반복 출력하지 않습니다.