ReportSystemUsageRequest

public final class ReportSystemUsageRequest
extends Object

java.lang.Object
   ↳ androidx.appsearch.app.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).

See GlobalSearchSession.reportSystemUsage(ReportSystemUsageRequest) 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

Public methods

getDatabaseName

public String getDatabaseName ()

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

Returns
String

getDocumentId

public String getDocumentId ()

Returns the ID of document that was used.

Returns
String

getNamespace

public String getNamespace ()

Returns the namespace of the document that was used.

Returns
String

getPackageName

public String getPackageName ()

Returns the package name of the app which owns the document that was used.

Returns
String

getUsageTimestampMillis

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.

Returns
long