UserMessagingPlatform

class UserMessagingPlatform


Điểm truy cập cho SDK Nền tảng thông báo cho người dùng.

Tóm tắt

Loại lồng nhau

Định nghĩa giao diện cho lệnh gọi lại được gọi khi không tải được biểu mẫu đồng ý.

Định nghĩa giao diện cho lệnh gọi lại được gọi khi biểu mẫu đồng ý tải thành công.

Hàm công khai

java-static ConsentInformation!

Lấy ConsentInformation.

java-static Unit
loadAndShowConsentFormIfRequired(
    activity: Activity!,
    onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!
)

Tải biểu mẫu đồng ý và hiển thị ngay biểu mẫu đó từ Activity được cung cấp nếu getConsentStatusREQUIRED.

java-static Unit

Tải ConsentForm.

java-static Unit
showPrivacyOptionsForm(
    activity: Activity!,
    onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!
)

Hiển thị biểu mẫu lựa chọn về quyền riêng tư từ Activity được cung cấp nếu getPrivacyOptionsRequirementStatusREQUIRED.

Hàm công khai

getConsentInformation

java-static fun getConsentInformation(context: Context!): ConsentInformation!

Lấy ConsentInformation.

loadAndShowConsentFormIfRequired

java-static fun loadAndShowConsentFormIfRequired(
    activity: Activity!,
    onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!
): Unit

Tải biểu mẫu đồng ý và hiển thị ngay biểu mẫu đó từ Activity được cung cấp nếu getConsentStatusREQUIRED.

Gọi OnConsentFormDismissedListener khi phương thức này kết thúc. Điều này có thể xảy ra do một trong những lý do sau:

  • người dùng thấy biểu mẫu, chọn một tuỳ chọn và đóng biểu mẫu
  • không bắt buộc phải hiển thị biểu mẫu
  • biểu mẫu không tải được, trả về một FormError khác rỗng
  • biểu mẫu không hiển thị, trả về một FormError khác rỗng

Bạn phải gọi phương thức này trên luồng chính.

Tham số
activity: Activity!

Hoạt động hiển thị biểu mẫu lấy sự đồng ý.

onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!

Trình nghe được gọi khi đóng biểu mẫu đồng ý.

loadConsentForm

java-static fun loadConsentForm(
    context: Context!,
    successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!,
    failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener!
): Unit

Tải ConsentForm.

Kiểm tra để đảm bảo isConsentFormAvailable trả về true trước khi gọi phương thức này.

Bạn phải gọi phương thức này trên luồng chính.

Tham số
context: Context!

Ngữ cảnh.

successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!

Trình nghe tải thành công biểu mẫu lấy sự đồng ý.

failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener!

Trình nghe lỗi tải biểu mẫu lấy sự đồng ý.

showPrivacyOptionsForm

java-static fun showPrivacyOptionsForm(
    activity: Activity!,
    onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!
): Unit

Hiển thị biểu mẫu lựa chọn về quyền riêng tư từ Activity được cung cấp nếu getPrivacyOptionsRequirementStatusREQUIRED.

Phương thức này chỉ được gọi để phản hồi hoạt động đầu vào của người dùng nhằm yêu cầu hiển thị biểu mẫu về các lựa chọn về quyền riêng tư.

SDK sẽ tự động tải trước biểu mẫu lựa chọn về quyền riêng tư khi có biểu mẫu. Nếu không có biểu mẫu nào được tải trước, SDK sẽ cố gắng tải một biểu mẫu không đồng bộ.

OnConsentFormDismissedListener được gọi sau khi người dùng thấy một biểu mẫu, chọn một tuỳ chọn và đóng biểu mẫu đó.

OnConsentFormDismissedListener cũng có thể trả về không đồng bộ trong vòng lặp chạy tiếp theo với FormError khác rỗng trong một trong các điều kiện lỗi sau:

  • biểu mẫu không hoạt động
  • biểu mẫu không hiển thị
  • biểu mẫu vẫn đang được tải trước

Bạn phải gọi phương thức này trên luồng chính.

Tham số
activity: Activity!

Hoạt động hiển thị biểu mẫu lựa chọn về quyền riêng tư.

onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!

Trình nghe được gọi khi đóng biểu mẫu lựa chọn về quyền riêng tư.