ReportSystemUsageRequest

Kotlin |Java

class ReportSystemUsageRequest

kotlin.Any
↳	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 android.app.appsearch.AppSearchSession#reportUsage.

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

Summary

Nested classes
	`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).

Public methods

getDatabaseName

Added in API level 31

fun getDatabaseName(): String

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

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

getDocumentId

Added in API level 31

fun getDocumentId(): String

Returns the ID of document that was used.

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

getNamespace

Added in API level 31

fun getNamespace(): String

Returns the namespace of the document that was used.

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

getPackageName

Added in API level 31

fun getPackageName(): String

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

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

getUsageTimestampMillis

Added in API level 31

fun getUsageTimestampMillis(): Long

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.

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