ReportSystemUsageRequest

Kotlin |Java

public final class ReportSystemUsageRequest
extends Object

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

A request to report usage of a document owned by another app from a system UI surface.

Usage reported in this way is measured separately from usage reported via AppSearchSession.reportUsage(ReportUsageRequest, Executor, Consumer>).

See GlobalSearchSession#reportSystemUsage for a detailed description of usage reporting.

Summary

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

Public methods
`String`	`getDatabaseName()` Returns the database in which the document that was used resides.
`String`	`getDocumentId()` Returns the ID of document that was used.
`String`	`getNamespace()` Returns the namespace of the document that was used.
`String`	`getPackageName()` Returns the package name of the app which owns the document that was used.
`long`	`getUsageTimestampMillis()` Returns the timestamp in milliseconds of the usage report (the time at which the document was used).

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 timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public methods

getDatabaseName

Added in API level 31

public String getDatabaseName ()

Returns the database in which the document that was used resides.

Returns
`String`	This value cannot be `null`.

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`.

getPackageName

Added in API level 31

public String getPackageName ()

Returns the package name of the app which owns 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.

ReportSystemUsageRequest

Summary

Nested classes

Public methods

Inherited methods

Public methods

getDatabaseName

getDocumentId

getNamespace

getPackageName

getUsageTimestampMillis