ConsentInformation

public interface ConsentInformation

Utility methods for collecting consent from users.

Nested Class Summary

@interface	ConsentInformation.ConsentStatus		Consent status values.
interface	ConsentInformation.OnConsentInfoUpdateFailureListener		Interface definition for a callback to be invoked when consent info failed to update.
interface	ConsentInformation.OnConsentInfoUpdateSuccessListener		Interface definition for a callback to be invoked when consent info is successfully updated.

Public Method Summary

abstract int	getConsentStatus() Gets the current consent status.
abstract boolean	isConsentFormAvailable() Returns true if a ConsentForm is available, false otherwise.
abstract void	requestConsentInfoUpdate(Activity activity, ConsentRequestParameters consentRequestParameters, ConsentInformation.OnConsentInfoUpdateSuccessListener successListener, ConsentInformation.OnConsentInfoUpdateFailureListener failureListener) Requests a consent information update.
abstract void	reset() Resets the ConsentInformation to initialized status.

Public Methods

public abstract int getConsentStatus ()

Gets the current consent status.

This value is cached between app sessions and can be read before calling requestConsentInfoUpdate(Activity, ConsentRequestParameters, ConsentInformation.OnConsentInfoUpdateSuccessListener, ConsentInformation.OnConsentInfoUpdateFailureListener).

public abstract boolean isConsentFormAvailable ()

Returns true if a ConsentForm is available, false otherwise.

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

Requests a consent information update.

Parameters

activity	The activity used to collect screen cut-outs.
consentRequestParameters	The request params.
successListener	The consent request success listener.
failureListener	The consent request failure listener.

public abstract void reset ()

Resets the ConsentInformation to initialized status. This should only used for debugging.