ReportSystemUsageRequest.Builder

public static final class ReportSystemUsageRequest.Builder
extends Object

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

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 (e.g. from SearchResult.getPackageName()).

databaseName String: The database in which the document that was used resides (e.g. from SearchResult.getDatabaseName()).

namespace String: The namespace of the document that was used (e.g. from GenericDocument.getNamespace().

documentId String: The ID of document that was used (e.g. from GenericDocument.getId().

Public methods

build

public ReportSystemUsageRequest build ()

Builds a new ReportSystemUsageRequest.

Returns
ReportSystemUsageRequest

setUsageTimestampMillis

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

Returns
ReportSystemUsageRequest.Builder