ReportSystemUsageRequest.Builder

  • ReportSystemUsageRequest.Builder is used to build ReportSystemUsageRequest objects.

  • A ReportSystemUsageRequest.Builder instance is created with package name, database name, namespace, and document ID.

  • The build() method creates a new ReportSystemUsageRequest.

  • The setUsageTimestampMillis() method sets the timestamp of the usage report, defaulting to the current timestamp if not set.
public static final class ReportSystemUsageRequest.Builder extends Object

Builder for ReportSystemUsageRequest objects.

Public Constructor Summary

Builder(String packageName, String databaseName, String namespace, String documentId)
Creates a ReportSystemUsageRequest.Builder instance.

Public Method Summary

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 Method Summary

Public Constructors

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

Creates a ReportSystemUsageRequest.Builder instance.

Parameters
packageName The package name of the app which owns the document that was used (such as from SearchResult.getPackageName()).
databaseName The database in which the document that was used resides (such as from SearchResult.getDatabaseName()).
namespace The namespace of the document that was used (such as from GenericDocument.getNamespace().
documentId The ID of document that was used (such as from GenericDocument.getId().

Public Methods

public ReportSystemUsageRequest build ()

Builds a new ReportSystemUsageRequest.

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.