UserMessagingPlatform

public final class UserMessagingPlatform


User Messaging Platform SDK의 진입점입니다.

요약

중첩된 유형

동의 양식 로드에 실패할 때 호출되는 콜백의 인터페이스 정의입니다.

동의 양식이 성공적으로 로드될 때 호출되는 콜백의 인터페이스 정의입니다.

공개 메서드

static ConsentInformation

ConsentInformation를 가져옵니다.

static void
loadAndShowConsentFormIfRequired(
    Activity activity,
    ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener
)

동의 양식을 로드하고 getConsentStatusREQUIRED인 경우 제공된 Activity에서 즉시 표시합니다.

static void

ConsentForm를 로드합니다.

static void
showPrivacyOptionsForm(
    Activity activity,
    ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener
)

getPrivacyOptionsRequirementStatusREQUIRED인 경우 제공된 Activity의 개인 정보 보호 옵션 양식을 표시합니다.

공개 메서드

getConsentInformation

public static ConsentInformation getConsentInformation(Context context)

ConsentInformation를 가져옵니다.

loadAndShowConsentFormIfRequired

public static void loadAndShowConsentFormIfRequired(
    Activity activity,
    ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener
)

동의 양식을 로드하고 getConsentStatusREQUIRED인 경우 제공된 Activity에서 즉시 표시합니다.

이 메서드가 완료되면 OnConsentFormDismissedListener를 호출합니다. 이는 다음 중 하나로 인해 발생할 수 있습니다.

  • 사용자에게 양식이 표시되고 옵션을 선택한 후 양식을 닫습니다.
  • 양식을 표시할 필요가 없습니다.
  • 양식이 로드되지 않고 null이 아닌 FormError를 반환함
  • 양식이 표시되지 않고 null이 아닌 FormError를 반환함

이 메서드는 기본 스레드에서 호출해야 합니다.

매개변수
Activity activity

동의 양식을 보여주는 활동

ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener

동의 양식이 닫힐 때 호출되는 리스너입니다.

loadConsentForm

public static void loadConsentForm(
    Context context,
    UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener,
    UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener
)

ConsentForm를 로드합니다.

이 메서드를 호출하기 전에 isConsentFormAvailabletrue를 반환하는지 확인합니다.

이 메서드는 기본 스레드에서 호출해야 합니다.

매개변수
Context context

맥락

UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener

동의 양식 로드 성공 리스너

UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener

동의 양식 로드 실패 리스너입니다.

showPrivacyOptionsForm

public static void showPrivacyOptionsForm(
    Activity activity,
    ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener
)

getPrivacyOptionsRequirementStatusREQUIRED인 경우 제공된 Activity의 개인 정보 보호 옵션 양식을 표시합니다.

이 메서드는 개인 정보 보호 옵션 양식 표시를 요청하는 사용자 입력에 대한 응답으로만 호출해야 합니다.

양식을 사용할 수 있게 되면 SDK에서 개인 정보 보호 옵션 양식을 자동으로 미리 로드합니다. 사전 로드된 양식이 없으면 SDK는 양식을 비동기식으로 로드하려고 시도합니다.

OnConsentFormDismissedListener는 사용자가 양식을 보고 옵션을 선택한 후 양식을 닫으면 호출됩니다.

OnConsentFormDismissedListener는 다음 오류 조건 중 하나에서 다음 실행 루프에서 비null FormError와 함께 비동기식으로 반환될 수도 있습니다.

  • 양식을 사용할 수 없습니다.
  • 양식이 표시되지 않음
  • 양식이 아직 미리 로드되고 있는 경우

이 메서드는 기본 스레드에서 호출해야 합니다.

매개변수
Activity activity

개인 정보 보호 옵션 양식이 표시된 활동

ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener

개인 정보 보호 옵션 양식이 닫힐 때 호출되는 리스너입니다.