AppInteractionAttribution


public final class AppInteractionAttribution
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.AppInteractionAttribution


Represents attribution information for an app interaction, detailing the context and nature of the interaction that triggered it.

This information can be used by the privacy setting to provide transparency to the user about why an interaction was invoked.

Summary

Nested classes

class AppInteractionAttribution.Builder

Builder for AppInteractionAttribution

Constants

int INTERACTION_TYPE_OTHER

Indicates an interaction type not covered by other predefined constants.

int INTERACTION_TYPE_USER_QUERY

Indicates that the app interaction was triggered as a direct result of a user query.

int INTERACTION_TYPE_USER_SCHEDULED

Indicates that the app interaction was triggered by a user-scheduled task.

Inherited constants

Fields

public static final Creator<AppInteractionAttribution> CREATOR

Public methods

int describeContents()

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

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

String getCustomInteractionType()

Returns the custom string describing the interaction, if getInteractionType() is AppInteractionAttribution.INTERACTION_TYPE_OTHER.

int getInteractionType()

Returns the type of interaction.

Uri getInteractionUri()

Returns the Uri linking to the original interaction.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

INTERACTION_TYPE_OTHER

Added in API level 37
public static final int INTERACTION_TYPE_OTHER

Indicates an interaction type not covered by other predefined constants.

When this type is used, a custom interaction type string must be provided via Builder.setCustomInteractionType.

Constant Value: 0 (0x00000000)

INTERACTION_TYPE_USER_QUERY

Added in API level 37
public static final int INTERACTION_TYPE_USER_QUERY

Indicates that the app interaction was triggered as a direct result of a user query.

Constant Value: 1 (0x00000001)

INTERACTION_TYPE_USER_SCHEDULED

Added in API level 37
public static final int INTERACTION_TYPE_USER_SCHEDULED

Indicates that the app interaction was triggered by a user-scheduled task.

Constant Value: 2 (0x00000002)

Fields

CREATOR

Added in API level 37
public static final Creator<AppInteractionAttribution> CREATOR

Public methods

describeContents

Added in API level 37
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(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

equals

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

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getCustomInteractionType

Added in API level 37
public String getCustomInteractionType ()

Returns the custom string describing the interaction, if getInteractionType() is AppInteractionAttribution.INTERACTION_TYPE_OTHER.

Returns
String This value may be null.

getInteractionType

Added in API level 37
public int getInteractionType ()

Returns the type of interaction.

Returns
int Value is one of the following:

getInteractionUri

Added in API level 37
public Uri getInteractionUri ()

Returns the Uri linking to the original interaction.

Returns
Uri This value may be null.

hashCode

Added in API level 37
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

toString

Added in API level 37
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 37
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 the following: