ReportUsageRequest


public final class ReportUsageRequest
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.appsearch.ReportUsageRequest


A request to report usage of a document.

See AppSearchSession#reportUsage for a detailed description of usage reporting.

Summary

Nested classes

class ReportUsageRequest.Builder

Builder for ReportUsageRequest objects. 

Inherited constants

Fields

public static final Creator<ReportUsageRequest> CREATOR

Public methods

String getDocumentId()

Returns the ID of document that was used.

String getNamespace()

Returns the namespace of the document that was used.

long getUsageTimestampMillis()

Returns the timestamp in milliseconds of the usage report (the time at which the document was used).

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 35
public static final Creator<ReportUsageRequest> CREATOR

Public methods

getDocumentId

Added in API level 31
public String getDocumentId ()

Returns the ID of document that was used.

Returns
String This value cannot be null.

getNamespace

Added in API level 31
public String getNamespace ()

Returns the namespace of the document that was used.

Returns
String This value cannot be null.

getUsageTimestampMillis

Added in API level 31
public long getUsageTimestampMillis ()

Returns the timestamp in milliseconds of the usage report (the time at which the document was used).

The value is in the System#currentTimeMillis time base.
Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

Returns
long Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

writeToParcel

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