ReportSystemUsageRequest.Builder

public static final class ReportSystemUsageRequest.Builder
extends Object

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


Builder for ReportSystemUsageRequest objects.

Summary

Public constructors

Builder(String packageName, String databaseName, String namespace, String documentId)

Creates a ReportSystemUsageRequest.Builder instance.

Public methods

ReportSystemUsageRequest build()

Builds a new ReportSystemUsageRequest.

ReportSystemUsageRequest.Builder setUsageTimestampMillis(long usageTimestampMillis)

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

Inherited methods

Public constructors

Builder

Added in API level 31
public Builder (String packageName, 
                String databaseName, 
                String namespace, 
                String documentId)

Creates a ReportSystemUsageRequest.Builder instance.

Parameters
packageName String: The package name of the app which owns the document that was used (such as from SearchResult#getPackageName). This value cannot be null.

databaseName String: The database in which the document that was used resides (such as from SearchResult#getDatabaseName). This value cannot be null.

namespace String: The namespace of the document that was used (such as from GenericDocument.getNamespace(). This value cannot be null.

documentId String: The ID of document that was used (such as from GenericDocument.getId(). This value cannot be null.

Public methods

build

Added in API level 31
public ReportSystemUsageRequest build ()

Builds a new ReportSystemUsageRequest.

Returns
ReportSystemUsageRequest This value cannot be null.

setUsageTimestampMillis

Added in API level 31
public ReportSystemUsageRequest.Builder setUsageTimestampMillis (long usageTimestampMillis)

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

If unset, this defaults to the current timestamp at the time that the ReportSystemUsageRequest is constructed.

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

Returns
ReportSystemUsageRequest.Builder This value cannot be null.