Stay organized with collections
Save and categorize content based on your preferences.
TotalCaloriesBurnedRecord
class TotalCaloriesBurnedRecord : IntervalRecord
Total energy burned by the user in Energy, including active & basal energy burned (BMR). Each record represents the total kilocalories burned over a time interval.
Summary
| Public methods |
| Boolean |
Indicates whether some other object is "equal to" this one.
|
| Energy |
|
| Int |
Returns a hash code value for the object.
|
Public methods
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
| Parameters |
obj |
the reference object with which to compare. |
object |
the reference object with which to compare. This value may be null. |
| Return |
Boolean |
true if this object is the same as the object argument; false otherwise. |
getEnergy
fun getEnergy(): Energy
| Return |
Energy |
energy burned during this activity in Energy unit. This value cannot be null. |
hashCode
fun hashCode(): Int
Returns a hash code value for the object.
| Return |
Int |
a hash code value for this object. |
Properties
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# TotalCaloriesBurnedRecord\n\nAdded in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nTotalCaloriesBurnedRecord\n=========================\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/health/connect/datatypes/TotalCaloriesBurnedRecord \"View this page in Java\") \n\n```\nclass TotalCaloriesBurnedRecord : IntervalRecord\n```\n\n|---|---|---|-----------------------------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||||\n| ↳ | [android.health.connect.datatypes.Record](/reference/kotlin/android/health/connect/datatypes/Record) |||\n| | ↳ | [android.health.connect.datatypes.IntervalRecord](/reference/kotlin/android/health/connect/datatypes/IntervalRecord) ||\n| | | ↳ | [android.health.connect.datatypes.TotalCaloriesBurnedRecord](#) |\n\nTotal energy burned by the user in [Energy](/reference/kotlin/android/health/connect/datatypes/units/Energy), including active \\& basal energy burned (BMR). Each record represents the total kilocalories burned over a time interval.\n\nSummary\n-------\n\n| Nested classes ||\n|---|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| | [Builder](/reference/kotlin/android/health/connect/datatypes/TotalCaloriesBurnedRecord.Builder) Builder class for [TotalCaloriesBurnedRecord](#) |\n\n| Public methods ||\n|------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [equals](#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Indicates whether some other object is \"equal to\" this one. |\n| [Energy](/reference/kotlin/android/health/connect/datatypes/units/Energy) | [getEnergy](#getEnergy())`()` \u003cbr /\u003e |\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [hashCode](#hashCode())`()` Returns a hash code value for the object. |\n\n| Inherited functions ||\n|---|---|\n| From class [IntervalRecord](/reference/kotlin/android/health/connect/datatypes/IntervalRecord) |------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| | [Instant](../../../../java/time/Instant.html#) | [getEndTime](/reference/kotlin/android/health/connect/datatypes/IntervalRecord#getEndTime())`()` \u003cbr /\u003e | | [ZoneOffset](../../../../java/time/ZoneOffset.html#) | [getEndZoneOffset](/reference/kotlin/android/health/connect/datatypes/IntervalRecord#getEndZoneOffset())`()` \u003cbr /\u003e | | [Instant](../../../../java/time/Instant.html#) | [getStartTime](/reference/kotlin/android/health/connect/datatypes/IntervalRecord#getStartTime())`()` \u003cbr /\u003e | | [ZoneOffset](../../../../java/time/ZoneOffset.html#) | [getStartZoneOffset](/reference/kotlin/android/health/connect/datatypes/IntervalRecord#getStartZoneOffset())`()` \u003cbr /\u003e | ||\n| From class [Record](/reference/kotlin/android/health/connect/datatypes/Record) |-------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| | [Metadata](/reference/kotlin/android/health/connect/datatypes/Metadata) | [getMetadata](/reference/kotlin/android/health/connect/datatypes/Record#getMetadata())`()` \u003cbr /\u003e | ||\n\n| Properties ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| static [AggregationType](/reference/kotlin/android/health/connect/datatypes/AggregationType)\\\u003c[Energy](/reference/kotlin/android/health/connect/datatypes/units/Energy)!\\\u003e | [ENERGY_TOTAL](#ENERGY_TOTAL:android.health.connect.datatypes.AggregationType) Metric identifier to get total energy from total calories burned using aggregate APIs in [HealthConnectManager](../HealthConnectManager.html#) |\n\nPublic methods\n--------------\n\n### equals\n\nAdded in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun equals(other: Any?): Boolean\n```\n\nIndicates whether some other object is \"equal to\" this one.\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------|\n| `obj` | the reference object with which to compare. |\n| `object` | the reference object with which to compare. This value may be `null`. |\n\n| Return ||\n|------------------------------------------------------------------------------------|------------------------------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true` if this object is the same as the object argument; `false` otherwise. |\n\n### getEnergy\n\nAdded in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun getEnergy(): Energy\n```\n\n| Return ||\n|---------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Energy](/reference/kotlin/android/health/connect/datatypes/units/Energy) | energy burned during this activity in [Energy](/reference/kotlin/android/health/connect/datatypes/units/Energy) unit. This value cannot be `null`. |\n\n### hashCode\n\nAdded in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun hashCode(): Int\n```\n\nReturns a hash code value for the object.\n\n| Return ||\n|----------------------------------------------------------------------------|------------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. |\n\nProperties\n----------\n\n### ENERGY_TOTAL\n\nAdded in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val ENERGY_TOTAL: AggregationType\u003cEnergy!\u003e\n```\n\nMetric identifier to get total energy from total calories burned using aggregate APIs in [HealthConnectManager](../HealthConnectManager.html#)"]]
