DistanceRecord.Builder

public static final class DistanceRecord.Builder
extends Object

java.lang.Object
   ↳ android.health.connect.datatypes.DistanceRecord.Builder


Builder class for DistanceRecord

Summary

Public constructors

Builder(Metadata metadata, Instant startTime, Instant endTime, Length distance)

Public methods

DistanceRecord build()
DistanceRecord.Builder clearEndZoneOffset()

Sets the start zone offset of this record to system default.

DistanceRecord.Builder clearStartZoneOffset()

Sets the start zone offset of this record to system default.

DistanceRecord.Builder setEndZoneOffset(ZoneOffset endZoneOffset)

Sets the zone offset of the user when the activity ended

DistanceRecord.Builder setStartZoneOffset(ZoneOffset startZoneOffset)

Sets the zone offset of the user when the activity started

Inherited methods

Public constructors

Builder

Added in API level 34
public Builder (Metadata metadata, 
                Instant startTime, 
                Instant endTime, 
                Length distance)

Parameters
metadata Metadata: Metadata to be associated with the record. See Metadata. This value cannot be null.

startTime Instant: Start time of this activity This value cannot be null.

endTime Instant: End time of this activity This value cannot be null.

distance Length: Distance in Length unit. Required field. Valid range: 0-1000000 meters. This value cannot be null.

Public methods

build

Added in API level 34
public DistanceRecord build ()

Returns
DistanceRecord Object of DistanceRecord This value cannot be null.

clearEndZoneOffset

Added in API level 34
public DistanceRecord.Builder clearEndZoneOffset ()

Sets the start zone offset of this record to system default.

Returns
DistanceRecord.Builder This value cannot be null.

clearStartZoneOffset

Added in API level 34
public DistanceRecord.Builder clearStartZoneOffset ()

Sets the start zone offset of this record to system default.

Returns
DistanceRecord.Builder This value cannot be null.

setEndZoneOffset

Added in API level 34
public DistanceRecord.Builder setEndZoneOffset (ZoneOffset endZoneOffset)

Sets the zone offset of the user when the activity ended

Parameters
endZoneOffset ZoneOffset: This value cannot be null.

Returns
DistanceRecord.Builder This value cannot be null.

setStartZoneOffset

Added in API level 34
public DistanceRecord.Builder setStartZoneOffset (ZoneOffset startZoneOffset)

Sets the zone offset of the user when the activity started

Parameters
startZoneOffset ZoneOffset: This value cannot be null.

Returns
DistanceRecord.Builder This value cannot be null.