ConsentInformation

interface ConsentInformation

Metode utilitas untuk mengumpulkan izin dari pengguna.

Ringkasan

Jenis bertingkat
@Retention(value = SOURCE)
@IntDef(value = [ConsentStatus.UNKNOWN, ConsentStatus.NOT_REQUIRED, ConsentStatus.REQUIRED, ConsentStatus.OBTAINED])
annotation ConsentInformation.ConsentStatus

Nilai status izin.

Definisi antarmuka untuk callback yang akan dipanggil saat info izin gagal diperbarui.

Definisi antarmuka untuk callback yang akan dipanggil saat info izin berhasil diperbarui.

Status persyaratan opsi privasi.

Fungsi publik
Boolean

Menunjukkan apakah SDK telah mengumpulkan izin yang selaras dengan pesan yang dikonfigurasi aplikasi.
Int

Mendapatkan status izin saat ini.
ConsentInformation.PrivacyOptionsRequirementStatus!

Mendapatkan status yang menunjukkan apakah tombol opsi privasi diperlukan.
Boolean

Menampilkan true jika ConsentForm tersedia, false jika tidak.
Unit
requestConsentInfoUpdate(
    activity: Activity!,
    consentRequestParameters: ConsentRequestParameters!,
    successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!,
    failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!
)

Meminta pembaruan informasi izin.
Unit

Mereset ConsentInformation ke status yang diinisialisasi.

Fungsi publik

canRequestAds

fun canRequestAds(): Boolean

Menunjukkan apakah SDK telah mengumpulkan izin yang selaras dengan pesan yang dikonfigurasi aplikasi.

Metode ini menampilkan false hingga requestConsentInfoUpdate dipanggil.

Setelah requestConsentInfoUpdate dipanggil, metode ini akan menampilkan true saat getConsentStatus menampilkan NOT_REQUIRED atau OBTAINED.

Hasil
Boolean

benar jika SDK telah mengumpulkan izin yang selaras dengan pesan yang dikonfigurasi aplikasi.

getConsentStatus

@ConsentInformation.ConsentStatus
fun getConsentStatus(): Int

Mendapatkan status izin saat ini.

Hasil
Int

UNKNOWN hingga requestConsentInfoUpdate dipanggil, dan ditetapkan secara default ke nilai sesi sebelumnya hingga requestConsentInfoUpdate berhasil selesai dan OnConsentInfoUpdateSuccessListener dipanggil.

getPrivacyOptionsRequirementStatus

fun getPrivacyOptionsRequirementStatus(): ConsentInformation.PrivacyOptionsRequirementStatus!

Mendapatkan status yang menunjukkan apakah tombol opsi privasi diperlukan.

Hasil
ConsentInformation.PrivacyOptionsRequirementStatus!

UNKNOWN hingga requestConsentInfoUpdate dipanggil, dan ditetapkan secara default ke nilai sesi sebelumnya hingga requestConsentInfoUpdate berhasil selesai dan dipanggil.

isConsentFormAvailable

fun isConsentFormAvailable(): Boolean

Menampilkan true jika ConsentForm tersedia, false jika tidak.

requestConsentInfoUpdate

fun requestConsentInfoUpdate(
    activity: Activity!,
    consentRequestParameters: ConsentRequestParameters!,
    successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!,
    failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!
): Unit

Meminta pembaruan informasi izin.

API ini harus dipanggil di setiap sesi aplikasi sebelum memanggil getConsentStatus.

Setelah API ini dipanggil, nilai yang ditampilkan API getConsentStatus akan diperbarui secara sinkron untuk menyimpan status izin dari sesi aplikasi sebelumnya, jika ada.

getConsentStatus dapat diperbarui lagi ke status terbaru setelah dipanggil.

Parameter
activity: Activity!

Aktivitas yang digunakan untuk mengumpulkan potongan layar.
consentRequestParameters: ConsentRequestParameters!

Parameter permintaan.
successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!

Pemroses peristiwa sukses permintaan izin.
failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!

Pemroses kegagalan permintaan izin.

reset

fun reset(): Unit

Mereset ConsentInformation ke status yang diinisialisasi. Ini hanya boleh digunakan untuk proses debug.