Added in API level 31

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

ReportUsageRequest

Kotlin |Java

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.

See also:

AppSearchSession.reportUsage(ReportUsageRequest, Executor, Consumer)

Summary

Nested classes
`class`	`ReportUsageRequest.Builder` Builder for `ReportUsageRequest` objects.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

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

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in Android VanillaIceCream

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 Android VanillaIceCream

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

ReportUsageRequest

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

getDocumentId

getNamespace

getUsageTimestampMillis

writeToParcel