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	在调用 requestConsentInfoUpdate 之前为 UNKNOWN，在 requestConsentInfoUpdate 成功完成并调用 OnConsentInfoUpdateSuccessListener 之前默认为上一个会话的值。

getPrivacyOptionsRequirementStatus

abstract ConsentInformation.PrivacyOptionsRequirementStatus getPrivacyOptionsRequirementStatus()

获取状态，指示是否需要显示隐私设置选项按钮。

返回
ConsentInformation.PrivacyOptionsRequirementStatus	在调用 requestConsentInfoUpdate 之前为 UNKNOWN，在 requestConsentInfoUpdate 成功完成并被调用之前，默认为上一个会话的值。

isConsentFormAvailable

abstract boolean isConsentFormAvailable()

如果有 ConsentForm，则返回 true；否则返回 false。

requestConsentInfoUpdate

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

请求更新意见征求信息。

必须在每个应用会话中调用此 API，然后才能调用 getConsentStatus。

调用此 API 后，getConsentStatus API 返回值将同步更新，以保存上一个应用会话中的意见征求状态（如果存在）。

调用 后，getConsentStatus 可能会再次更新为最新状态。

参数
Activity activity	用于收集屏幕剪裁内容的 activity。
ConsentRequestParameters consentRequestParameters	请求参数。
ConsentInformation.OnConsentInfoUpdateSuccessListener successListener	意见征求请求成功监听器。
ConsentInformation.OnConsentInfoUpdateFailureListener failureListener	意见征求请求失败监听器。

重置

abstract void reset()

将 ConsentInformation 重置为初始化状态。此方法应仅用于调试。