ReportUsageRequest.Builder

public static final class ReportUsageRequest.Builder
extends Object

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


Builder for ReportUsageRequest objects.

Summary

Public constructors

Builder(String namespace, String documentId)

Creates a new ReportUsageRequest.Builder instance.

Public methods

ReportUsageRequest build()

Builds a new ReportUsageRequest.

ReportUsageRequest.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 namespace, 
                String documentId)

Creates a new ReportUsageRequest.Builder instance.

Parameters
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 ReportUsageRequest build ()

Builds a new ReportUsageRequest.

Returns
ReportUsageRequest This value cannot be null.

setUsageTimestampMillis

Added in API level 31
public ReportUsageRequest.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 ReportUsageRequest is constructed.

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

Returns
ReportUsageRequest.Builder This value cannot be null.