ConsentInformation

Kotlin |Java

public interface ConsentInformation

---

用於向使用者收集同意聲明的實用方法。

摘要

巢狀類型
@Retention(value = SOURCE) @IntDef(value = [ConsentStatus.UNKNOWN, ConsentStatus.NOT_REQUIRED, ConsentStatus.REQUIRED, ConsentStatus.OBTAINED]) public annotation ConsentInformation.ConsentStatus 同意聲明狀態值。
public interface ConsentInformation.OnConsentInfoUpdateFailureListener 在同意聲明資訊更新失敗時，要叫用的回呼介面定義。
public interface ConsentInformation.OnConsentInfoUpdateSuccessListener 在同意資訊成功更新時，要叫用的回呼介面定義。
public enum ConsentInformation.PrivacyOptionsRequirementStatus 隱私權選項規定狀態。

公用方法
abstract boolean	canRequestAds() 指出 SDK 是否已根據應用程式設定的訊息收集同意聲明。
abstract int	@ConsentInformation.ConsentStatus getConsentStatus() 取得目前的同意聲明狀態。
abstract ConsentInformation.PrivacyOptionsRequirementStatus	getPrivacyOptionsRequirementStatus() 取得狀態，指出是否需要隱私設定選項按鈕。
abstract boolean	isConsentFormAvailable() 如果有 ConsentForm，就會傳回 true，否則傳回 false。
abstract void	requestConsentInfoUpdate(     Activity activity,     ConsentRequestParameters consentRequestParameters,     ConsentInformation.OnConsentInfoUpdateSuccessListener successListener,     ConsentInformation.OnConsentInfoUpdateFailureListener failureListener ) 要求更新同意聲明資訊。
abstract void	reset() 將 ConsentInformation 重設為已初始化的狀態。

公用方法

canRequestAds

abstract boolean canRequestAds()

指出 SDK 是否已根據應用程式設定的訊息收集同意聲明。

此方法會傳回 false，直到 requestConsentInfoUpdate 呼叫為止。

呼叫 requestConsentInfoUpdate 後，當 getConsentStatus 傳回 NOT_REQUIRED 或 OBTAINED 時，這個方法會傳回 true。

傳回
boolean	如果 SDK 已收集與應用程式所設定訊息相符的同意聲明，則為 true。

getConsentStatus

@ConsentInformation.ConsentStatus
abstract int getConsentStatus()

取得目前的同意聲明狀態。

傳回
int	UNKNOWN 直到呼叫 requestConsentInfoUpdate 為止，並預設為上一個工作階段的值，直到 requestConsentInfoUpdate 成功完成並呼叫 OnConsentInfoUpdateSuccessListener 為止。

getPrivacyOptionsRequirementStatus

abstract ConsentInformation.PrivacyOptionsRequirementStatus getPrivacyOptionsRequirementStatus()

取得狀態，指出是否需要隱私設定選項按鈕。

傳回
ConsentInformation.PrivacyOptionsRequirementStatus	UNKNOWN 直到 requestConsentInfoUpdate 呼叫為止，並預設為上一個工作階段的值，直到 requestConsentInfoUpdate 成功完成並呼叫為止。

isConsentFormAvailable

abstract boolean isConsentFormAvailable()

如果有 ConsentForm，就會傳回 true，否則傳回 false。

requestConsentInfoUpdate

abstract void requestConsentInfoUpdate(
    Activity activity,
    ConsentRequestParameters consentRequestParameters,
    ConsentInformation.OnConsentInfoUpdateSuccessListener successListener,
    ConsentInformation.OnConsentInfoUpdateFailureListener failureListener
)

要求更新同意聲明資訊。

在呼叫 getConsentStatus 之前，必須在每個應用程式工作階段中呼叫此 API。

呼叫此 API 後，getConsentStatus API 傳回值會同步更新，以便保留先前應用程式工作階段 (如果有) 的同意聲明狀態。

呼叫 後，getConsentStatus 可能會再次更新為最新狀態。

參數
Activity activity	用於收集螢幕剪輯內容的活動。
ConsentRequestParameters consentRequestParameters	要求參數。
ConsentInformation.OnConsentInfoUpdateSuccessListener successListener	同意聲明要求成功事件監聽器。
ConsentInformation.OnConsentInfoUpdateFailureListener failureListener	同意聲明要求失敗事件監聽器。

重設

abstract void reset()

將 ConsentInformation 重設為初始化狀態。這項功能僅供偵錯使用。