AdSelectionSignals

public final class AdSelectionSignals
extends Object implements Parcelable

java.lang.Object
   ↳ android.adservices.common.AdSelectionSignals


This class holds JSON that will be passed into a JavaScript function during ad selection. Its contents are not used by FLEDGE platform code, but are merely validated and then passed to the appropriate JavaScript ad selection function.

Summary

Inherited constants

Fields

public static final Creator<AdSelectionSignals> CREATOR

public static final AdSelectionSignals EMPTY

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

Compares this AdSelectionSignals to the specified object.

static AdSelectionSignals fromString(String source)

Creates an AdSelectionSignals from a given JSON in String form.

int hashCode()

Returns a hash code corresponding to the string representation of this class obtained by calling toString().

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

public static final Creator<AdSelectionSignals> CREATOR

EMPTY

public static final AdSelectionSignals EMPTY

Public methods

describeContents

Added in API level 34
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 34
public boolean equals (Object o)

Compares this AdSelectionSignals to the specified object. The result is true if and only if the argument is not null and is a AdSelectionSignals object with the same string form (obtained by calling toString()). Note that this method will not perform any JSON normalization so two AdSelectionSignals objects with the same JSON could be not equal if the String representations of the objects was not equal.

Parameters
o Object: The object to compare this AdSelectionSignals against

Returns
boolean true if the given object represents an AdSelectionSignals equivalent to this AdSelectionSignals, false otherwise

fromString

public static AdSelectionSignals fromString (String source)

Creates an AdSelectionSignals from a given JSON in String form.

Parameters
source String: Any valid JSON string to create the AdSelectionSignals with. This value cannot be null.

Returns
AdSelectionSignals An AdSelectionSignals object wrapping the given String. This value cannot be null.

hashCode

Added in API level 34
public int hashCode ()

Returns a hash code corresponding to the string representation of this class obtained by calling toString(). Note that this method will not perform any JSON normalization so two AdSelectionSignals objects with the same JSON could have different hash codes if the underlying string representation was different.

Returns
int a hash code value for this object.

toString

Added in API level 34
public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String The String form of the JSON wrapped by this class. This value cannot be null.

writeToParcel

Added in API level 34
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES