# ExerciseCompletionGoal.TotalCaloriesBurnedGoal

Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  
Also in[U Extensions 13](https://developer.android.com/sdkExtensions)

# TotalCaloriesBurnedGoal

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/health/connect/datatypes/ExerciseCompletionGoal.TotalCaloriesBurnedGoal "View this page in Java")  

```
class TotalCaloriesBurnedGoal : ExerciseCompletionGoal
```

|---|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                                                                                        |||
| ↳ | [android.health.connect.datatypes.ExerciseCompletionGoal](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/ExerciseCompletionGoal)                                                     ||
|   | ↳ | [android.health.connect.datatypes.ExerciseCompletionGoal.TotalCaloriesBurnedGoal](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/ExerciseCompletionGoal.TotalCaloriesBurnedGoal#) |

An[ExerciseCompletionGoal](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/ExerciseCompletionGoal)that requires a specified number of total calories to be burned.

## Summary

|                                                                                                                                                                           Public constructors                                                                                                                                                                           ||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [TotalCaloriesBurnedGoal](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/ExerciseCompletionGoal.TotalCaloriesBurnedGoal#TotalCaloriesBurnedGoal(android.health.connect.datatypes.units.Energy))`(`totalCalories:` `[Energy](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/units/Energy)`)` <br /> |

|                                                                                                                                                                                                      Public methods                                                                                                                                                                                                       ||
|--------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)                     | [equals](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/ExerciseCompletionGoal.TotalCaloriesBurnedGoal#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. |
| [Energy](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/units/Energy) | [getTotalCalories](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/ExerciseCompletionGoal.TotalCaloriesBurnedGoal#getTotalCalories())`()` Returns the total calories that must be burned to complete this goal.                                                                   |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                             | [hashCode](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/ExerciseCompletionGoal.TotalCaloriesBurnedGoal#hashCode())`()` <br />                                                                                                                                                  |

## Public constructors

### TotalCaloriesBurnedGoal

Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  
Also in[U Extensions 13](https://developer.android.com/sdkExtensions)  

```
TotalCaloriesBurnedGoal(totalCalories: Energy)
```

|                                                                                                   Parameters                                                                                                    ||
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `totalCalories` | [Energy](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/units/Energy):The total calories that must be burnt to complete the goal. This value cannot be`null`. |

## Public methods

### equals

Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun equals(other: Any?): Boolean
```

Indicates whether some other object is "equal to" this one.

The`equals`method implements an equivalence relation on non-null object references:

- It is*reflexive* : for any non-null reference value`x`,`x.equals(x)`should return`true`.
- It is*symmetric* : for any non-null reference values`x`and`y`,`x.equals(y)`should return`true`if and only if`y.equals(x)`returns`true`.
- It is*transitive* : for any non-null reference values`x`,`y`, and`z`, if`x.equals(y)`returns`true`and`y.equals(z)`returns`true`, then`x.equals(z)`should return`true`.
- It is*consistent* : for any non-null reference values`x`and`y`, multiple invocations of`x.equals(y)`consistently return`true`or consistently return`false`, provided no information used in`equals`comparisons on the objects is modified.
- For any non-null reference value`x`,`x.equals(null)`should return`false`.

An equivalence relation partitions the elements it operates on into*equivalence classes*; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

|                     Parameters                     ||
|-------|---------------------------------------------|
| `obj` | the reference object with which to compare. |
| `o`   | This value may be`null`.                    |

|                                                                           Return                                                                           ||
|------------------------------------------------------------------------------------|------------------------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true`if this object is the same as the obj argument;`false`otherwise. |

### getTotalCalories

Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  
Also in[U Extensions 13](https://developer.android.com/sdkExtensions)  

```
fun getTotalCalories(): Energy
```

Returns the total calories that must be burned to complete this goal.

|                                                               Return                                                                ||
|--------------------------------------------------------------------------------------------------------|-----------------------------|
| [Energy](https://developer.android.com/reference/kotlin/android/health/connect/datatypes/units/Energy) | This value cannot be`null`. |

### hashCode

Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun hashCode(): Int
```

|                                                     Return                                                     ||
|----------------------------------------------------------------------------|------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. |