# WearApiVersionHelper

Artifact: [androidx.wear:wear-core](https://developer.android.com/jetpack/androidx/releases/wear) [View Source](https://cs.android.com/search?q=file:androidx/wear/utils/WearApiVersionHelper.java+class:androidx.wear.utils.WearApiVersionHelper) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)

*** ** * ** ***


```
public final class WearApiVersionHelper
```

<br />

*** ** * ** ***

Wear API Version helper for use in determining whether or not the API requirements associated with a given API can be met. Given that Wear API is built incrementally on top of the Android Platform/SDK API, API compatibility is determined both by checking the required Android Platform API level and the Wear specific, incremental API level against that which is present on a device. Ensuring runtime API compatibility is critical as the failure to do so can result in crashes should you try to call an API which doesn't exist on a device containing an earlier version. The following is an example of runtime API compatibility/checking with the WearApiVersionHelper:

```
    public void doFoo() {
        // Foo had some new features that were introduced in 33.4 - we need to ensure that users
        // on newer devices get the benefits of these features while still ensuring that our app
        // works for users on older devices - even if they don't get the benefit of the new
        // feature.
        if (WearApiVersionHelper.isApiVersionAtLeast(WEAR_TIRAMISU_4) {
            // use the new foo features that were introduced in Wear 33.4
        } else {
            // gracefully handle legacy foo behaviour
        }
    }
```

## Summary

| ### Constants |
|---|---|
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_BAKLAVA_0() = "WEAR_BAKLAVA_0"` The first major Wear API version released on Android BAKLAVA (API level 36.0). |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_BAKLAVA_1() = "WEAR_BAKLAVA_1"` The first minor Wear API version released on Android BAKLAVA (API level 36.1). |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_CINNAMON_BUN_0() = "WEAR_CINNAMON_BUN_0"` The first major Wear API version released on Android CINNAMON_BUN (API level 37.0). |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_CINNAMON_BUN_1() = "WEAR_CINNAMON_BUN_1"` The first minor Wear API version released on Android CINNAMON_BUN (API level 37.1). |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_CINNAMON_BUN_2() = "WEAR_CINNAMON_BUN_2"` The second minor Wear API version released on Android CINNAMON_BUN (API level 37.2). |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_TIRAMISU_1() = "WEAR_TIRAMISU_1"` The first Wear API version released on the Android T platform version (API level 33). |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_TIRAMISU_2() = "WEAR_TIRAMISU_2"` The second Wear API version released on the Android T platform version (API level 33). |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_TIRAMISU_3() = "WEAR_TIRAMISU_3"` The third Wear API version released on the Android T platform version (API level 33). |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_TIRAMISU_4() = "WEAR_TIRAMISU_4"` The fourth Wear API version released on the Android T platform version (API level 33). |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_UDC_1() = "WEAR_UDC_1"` The first Wear API version released on the Android U platform version (API level 34). |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_VIC_1() = "WEAR_VIC_1"` The first Wear API version released on the Android VIC platform version (API level 35). |

| ### Public methods |
|---|---|
| `static boolean` | `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#isApiVersionAtLeast(java.lang.String)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html requiredVersion)` Check if the current API version meets the specified requirements. |

## Constants

### WEAR_BAKLAVA_0

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)

```
public static final String WEAR_BAKLAVA_0 = "WEAR_BAKLAVA_0"
```

The first major Wear API version released on Android BAKLAVA (API level 36.0).

### WEAR_BAKLAVA_1

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/wear#1.1.0)

```
public static final String WEAR_BAKLAVA_1 = "WEAR_BAKLAVA_1"
```

The first minor Wear API version released on Android BAKLAVA (API level 36.1).

### WEAR_CINNAMON_BUN_0

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/wear#1.1.0)

```
public static final String WEAR_CINNAMON_BUN_0 = "WEAR_CINNAMON_BUN_0"
```

The first major Wear API version released on Android CINNAMON_BUN (API level 37.0).

### WEAR_CINNAMON_BUN_1

Added in [1.2.0-beta01](https://developer.android.com/jetpack/androidx/releases/wear#1.2.0-beta01)

```
public static final String WEAR_CINNAMON_BUN_1 = "WEAR_CINNAMON_BUN_1"
```

The first minor Wear API version released on Android CINNAMON_BUN (API level 37.1).

### WEAR_CINNAMON_BUN_2

Added in [1.2.0-beta01](https://developer.android.com/jetpack/androidx/releases/wear#1.2.0-beta01)

```
public static final String WEAR_CINNAMON_BUN_2 = "WEAR_CINNAMON_BUN_2"
```

The second minor Wear API version released on Android CINNAMON_BUN (API level 37.2).

### WEAR_TIRAMISU_1

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)

```
public static final String WEAR_TIRAMISU_1 = "WEAR_TIRAMISU_1"
```

The first Wear API version released on the Android T platform version (API level 33).

### WEAR_TIRAMISU_2

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)

```
public static final String WEAR_TIRAMISU_2 = "WEAR_TIRAMISU_2"
```

The second Wear API version released on the Android T platform version (API level 33).

### WEAR_TIRAMISU_3

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)

```
public static final String WEAR_TIRAMISU_3 = "WEAR_TIRAMISU_3"
```

The third Wear API version released on the Android T platform version (API level 33).

### WEAR_TIRAMISU_4

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)

```
public static final String WEAR_TIRAMISU_4 = "WEAR_TIRAMISU_4"
```

The fourth Wear API version released on the Android T platform version (API level 33).

### WEAR_UDC_1

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)

```
public static final String WEAR_UDC_1 = "WEAR_UDC_1"
```

The first Wear API version released on the Android U platform version (API level 34).

### WEAR_VIC_1

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)

```
public static final String WEAR_VIC_1 = "WEAR_VIC_1"
```

The first Wear API version released on the Android VIC platform version (API level 35).

## Public methods

### isApiVersionAtLeast

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)

```
public static boolean isApiVersionAtLeast(@NonNull String requiredVersion)
```

Check if the current API version meets the specified requirements.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html requiredVersion` | the required version corresponding to Wear OS release versions, as defined within the WearApiVersionHelper - for example one of: - `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_TIRAMISU_1()` - `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_TIRAMISU_2()` - `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_TIRAMISU_3()` - `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_TIRAMISU_4()` - `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_UDC_1()` - `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_VIC_1()` - `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_BAKLAVA_0()` - `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_BAKLAVA_1()` - `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_CINNAMON_BUN_0()` - `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_CINNAMON_BUN_1()` - `https://developer.android.com/reference/androidx/wear/utils/WearApiVersionHelper#WEAR_CINNAMON_BUN_2()` - etc . `IllegalArgumentException` will result for any other value. |

| Returns |
|---|---|
| `boolean` | true if the current API version is equal to or greater than the required version. |