ConsentInformation
interface ConsentInformation
用於向使用者收集同意聲明的實用方法。
摘要
巢狀類型 |
|---|
@Retention(value = SOURCE)同意聲明狀態值。 |
|
在同意聲明資訊更新失敗時，要叫用的回呼介面定義。 |
|
在同意資訊成功更新時，要叫用的回呼介面定義。 |
|
隱私權選項規定狀態。 |
公開函式 |
|
|---|---|
Boolean |
指出 SDK 是否已根據應用程式設定的訊息收集同意聲明。 |
Int |
取得目前的同意聲明狀態。 |
ConsentInformation.PrivacyOptionsRequirementStatus! |
取得狀態，指出是否需要隱私設定選項按鈕。 |
Boolean |
如果有 |
Unit |
requestConsentInfoUpdate(要求更新同意聲明資訊。 |
Unit |
reset()將 |
公開函式
canRequestAds
fun canRequestAds(): Boolean
指出 SDK 是否已根據應用程式設定的訊息收集同意聲明。
此方法會傳回 false，直到 requestConsentInfoUpdate 呼叫為止。
呼叫 requestConsentInfoUpdate 後，當 getConsentStatus 傳回 NOT_REQUIRED 或 OBTAINED 時，這個方法會傳回 true。
| 傳回 | |
|---|---|
Boolean |
如果 SDK 已收集與應用程式所設定訊息相符的同意聲明，則為 true。 |
getConsentStatus
@ConsentInformation.ConsentStatus
fun getConsentStatus(): Int
取得目前的同意聲明狀態。
| 傳回 | |
|---|---|
Int |
|
getPrivacyOptionsRequirementStatus
fun getPrivacyOptionsRequirementStatus(): ConsentInformation.PrivacyOptionsRequirementStatus!
取得狀態，指出是否需要隱私設定選項按鈕。
| 傳回 | |
|---|---|
ConsentInformation.PrivacyOptionsRequirementStatus! |
|
requestConsentInfoUpdate
fun requestConsentInfoUpdate(
activity: Activity!,
consentRequestParameters: ConsentRequestParameters!,
successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!,
failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!
): Unit
要求更新同意聲明資訊。
在呼叫 getConsentStatus 之前，必須在每個應用程式工作階段中呼叫此 API。
呼叫此 API 後，getConsentStatus API 傳回值會同步更新，以便保留先前應用程式工作階段 (如果有) 的同意聲明狀態。
呼叫 後，getConsentStatus 可能會再次更新為最新狀態。
| 參數 | |
|---|---|
activity: Activity! |
用於收集螢幕剪輯內容的活動。 |
consentRequestParameters: ConsentRequestParameters! |
要求參數。 |
successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener! |
同意聲明要求成功事件監聽器。 |
failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener! |
同意聲明要求失敗事件監聽器。 |