OPTED_IN_SCREENS_ONLY 구성에서 메시지를 띄울 화면의 onResume()마다 호출합니다.| 전제 | 내용 |
|---|---|
| 필요 artifact | appbox-inapp + 초기화 설정의 inApp (예외는 함수별 표기) |
| 전제 미충족 시 | 콜백 error로 AppBoxInAppUnavailableException 또는 AppBoxInAppNotConfiguredException → 예외 카탈로그 |
| 콘솔, 서버 전제 | 캠페인 생성과 캠페인 코드 발급은 AppBox 콘솔에서 합니다 (캠페인 설정 가이드) |
| 웹 브릿지 대응 | inapp.requestShow: 관리 화면 전용. 고객 WebView에서는 -8000으로 차단되며, 네이티브에서는 showInAppCampaign을 사용합니다 |
표시 대상과 옵트인
표시 대상은 초기화 설정 AppBoxInAppConfig.displayScope가 결정합니다.
| displayScope | 동작 |
|---|---|
ALL_SCREENS (기본) | 사일런트 Push 캠페인이 화면 종류, onInAppResume 호출과 무관하게 표시 |
OPTED_IN_SCREENS_ONLY | onInAppResume을 호출한 화면만 표시 대상. 옵트인은 onInAppPause에 해제되므로 매 onResume마다 호출 |
전체 흐름: 사일런트 Push 도착 → 캠페인 동기화(setInAppSyncListener) → 표시 대기열 → 노출 조건 통과 시 표시. 관리 화면 메인은 SDK가 이미 연결합니다.
OPTED_IN_SCREENS_ONLY 구성에서 메시지를 띄울 화면의 onResume()마다 호출합니다.표시 화면 등록
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
| activity | 필수 | 메시지를 표시할 foreground Activity | - |
| delayMillis | - | 평가 전 지연 시간(ms). 음수는 0으로 보정됩니다 | 500 |
| callback | 필수 | AppBoxOperationCallback | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
success | 평가 요청 전달 성공 여부 (true | false) |
Activity의 onResume()에서 직접 호출합니다. 함수 이름이 callback처럼 보이지만 SDK가 Activity lifecycle을 자동으로 가로채지 않습니다. AppBox 관리 화면의 메인 화면은 SDK가 이미 연결합니다. 같은 Activity에서 추가로 호출하면 중복 평가됩니다. displayScope = ALL_SCREENS(기본)에서는 사일런트 Push 캠페인 표시가 이 함수의 호출 여부와 무관합니다 → Native In-App 개요.
onInAppResume을 호출한 Activity의 onPause()에서 반드시 짝을 맞춰 호출합니다.표시 화면 해제
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
| activity | 필수 | 표시 대상에서 제외할 Activity | - |
| callback | 필수 | AppBoxOperationCallback | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
success | 해제 처리 성공 여부 (true | false) |
super.onPause() 전에 호출합니다. 표시 중인 메시지가 닫히고 대기 중인 표시 요청이 정리됩니다. 화면 회전처럼 설정 변경으로 인한 일시 중지에서는 표시 세션이 강제로 종료되지 않습니다. OPTED_IN_SCREENS_ONLY인 경우 이 호출로 해당 화면의 옵트인이 해제됩니다. 이후 사일런트 Push가 도착하면 캠페인 동기화만 수행되고 표시되지 않으며, 다시 옵트인 화면에 진입할 때 재평가됩니다.
조건에 맞는 메시지 표시 요청
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
| activity | 필수 | 메시지를 표시할 foreground Activity | - |
| callback | 필수 | AppBoxOperationCallback | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
success | 표시 요청 처리 성공 여부 (true | false) |
강제 표시 함수가 아닙니다. 서버 노출 조건, 캠페인 기간, 노출 빈도, 오늘 보지 않기 설정을 모두 통과한 경우에만 표시됩니다. 표시할 메시지가 없거나 이미 다른 메시지가 떠 있어도 성공으로 처리됩니다. success == true로 노출 여부를 판단할 수 없습니다. displayScope 설정과 무관하게 호출한 화면에서 평가, 표시되며, 호출하면 해당 화면이 옵트인 상태로도 기록됩니다.
특정 캠페인 표시 요청
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
| activity | 필수 | 메시지를 표시할 foreground Activity | - |
| campaignCode | 필수 | 콘솔의 캠페인 코드. 빈 문자열이면 아무 것도 하지 않고 성공합니다 | - |
| callback | 필수 | AppBoxOperationCallback | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
success | 표시 요청 처리 성공 여부 (true | false) |
강제 표시 함수가 아닙니다. 캠페인 코드를 지정해도 서버 노출 조건, 기간, 빈도, 오늘 보지 않기 설정을 통과해야 표시되며, 조건에 걸려 표시되지 않아도 성공으로 처리됩니다. 전달한 Activity가 포그라운드 상태여야 합니다. 이 함수는 전달받은 Activity를 표시 대상으로 등록하므로 onInAppResume을 먼저 호출할 필요는 없습니다.
function 액션으로 앱 고유 동작을 연결할 때 사용합니다.액션 listener 설정
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
| listener | - | AppBoxInAppActionListener. null이면 등록을 해제합니다 | - |
| callback | 필수 | 등록 결과를 받는 AppBoxOperationCallback | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
success | listener 등록 성공 여부 (true | false) |
event.campaignCode | listener로 전달되는 캠페인 식별자 |
event.action | 실행된 동작 종류. 항상 소문자 |
event.actionValue | 동작에 설정된 값 |
| 오류 | 등록 시 (callback): AppBoxInAppUnavailableException. appbox-inapp 미포함이벤트 수신 시 (listener): 오류 전달 없음 |
listener는 알림용입니다. link와 external의 URL 열기는 SDK가 계속 담당합니다. listener에서 같은 URL을 다시 열면 화면이 두 번 열립니다.
action 값은 서버 설정과 무관하게 소문자로 전달됩니다.Application.onCreate()에서 등록을 권장합니다.In-App 동기화 listener 설정
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
| listener | - | AppBoxInAppSyncListener. null이면 등록을 해제합니다 | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
context | listener로 전달되는 context |
campaignCode | 동기화 대상 캠페인 식별자. 값이 없으면 빈 문자열 |
handledBySdk | SDK가 이 신호를 처리했는지 여부 |
| 오류 | 이 함수에는 오류 전달이 없습니다. 등록은 appbox-core만으로 되지만 발화는 appbox-push가 담당합니다. appbox-push가 없으면 listener는 등록되지만 호출되지 않습니다. appbox-webview는 필요하지 않습니다. |
| handledBySdk | 의미 |
|---|---|
true | SDK가 신호를 처리함. 표시됐다는 뜻이 아님. 상세는 아래 동작 설명 |
false | 표시 조건 화면 없음, artifact 없음, 미초기화, 처리 중 예외 |
동기화 신호가 아닌 일반 알림 Push는 전달되지 않습니다. listener의 예외는 SDK가 삼켜 Push 처리에 영향을 주지 않습니다. 마지막에 등록한 하나만 유지됩니다. Application.onCreate()에서 등록합니다.
if (!handledBySdk) { 화면 전환 } 패턴을 In-App을 쓰지 않는 앱에 넣지 마세요. 그런 앱에서는 이 값이 항상 false라 Push마다 화면이 전환됩니다.
동작 설명
handledBySdk 판정 상세입니다.
true는 표시 대기열에 정상 진입한 경우 외에도, 조건에 맞는 캠페인이 없어 대기열이 비었거나 In-App 설정이 enabled = false이거나 이미 처리한 중복 Push인 경우에도 true입니다.false는 표시 조건을 만족하는 화면이 없어 보류됐거나(다시 옵트인 화면에 진입할 때 재평가), appbox-inapp artifact가 없거나, In-App이 초기화되지 않았거나, 처리 중 예외가 발생한 경우입니다.handledBySdk 조건 분기를 사용하세요.