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

# Segment

*** ** * ** ***

```
class Segment
```

|---|---|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||
| ↳ | [android.app.Notification.ProgressStyle.Segment](https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#) |

A segment of the progress bar, which defines its length and color. Segments allow for creating progress bars with multiple colors or sections to represent different stages or categories of progress. For example, Traffic conditions along a navigation journey.

## Summary

| Public constructors ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#Segment(kotlin.Int)(length: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` Create a segment with a non-zero length. |

| Public methods ||
|---|---|
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#equals(kotlin.Any)(other: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?)` Indicates whether some other object is "equal to" this one. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#getColor()()` Returns the color of this Segment. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#getId()()` Gets the id of this Segment. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#getLength()()` The length of this Segment within the progress bar. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#getSemanticStyle()()` Returns the semantics applied to the Segment. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#hashCode()()` Returns a hash code value for the object. |
| [Notification.ProgressStyle.Segment](https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#) | `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#setColor(kotlin.Int)(color: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` Optional color of this Segment |
| [Notification.ProgressStyle.Segment](https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#) | `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#setId(kotlin.Int)(id: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` Optional ID used to uniquely identify the element across updates. |
| [Notification.ProgressStyle.Segment](https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#) | `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#setSemanticStyle(kotlin.Int)(semanticStyle: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` Applies semantics to the Segment. |

## Public constructors

### Segment

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

```
Segment(length: Int)
```

Create a segment with a non-zero length.

| Parameters ||
|---|---|
| `length` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): See `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#getLength()` Value is 1 or greater |

## Public methods

### equals

Added in [API level 36](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. |

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

### getColor

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

```
fun getColor(): Int
```

Returns the color of this Segment.
**See Also**

- `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#setColor(kotlin.Int)`

### getId

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

```
fun getId(): Int
```

Gets the id of this Segment.
**See Also**

- `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#setId(kotlin.Int)`

### getLength

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

```
fun getLength(): Int
```

The length of this Segment within the progress bar. This value has no units, it is just relative to the length of other segments, and the value provided to `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle#setProgress(kotlin.Int)`.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | Value is 1 or greater |

### getSemanticStyle

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

```
fun getSemanticStyle(): Int
```

Returns the semantics applied to the Segment. When the notification `https://developer.android.com/reference/kotlin/android/app/Notification#FLAG_PROMOTED_ONGOING:kotlin.Int` this value is used to style (e.g. color) the segment.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | Value is one of the following: - `https://developer.android.com/reference/kotlin/android/app/Notification#SEMANTIC_STYLE_UNSPECIFIED:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/app/Notification#SEMANTIC_STYLE_INFO:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/app/Notification#SEMANTIC_STYLE_SAFE:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/app/Notification#SEMANTIC_STYLE_CAUTION:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/app/Notification#SEMANTIC_STYLE_DANGER:kotlin.Int` |

### hashCode

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

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

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `https://developer.android.com/reference/kotlin/java/util/HashMap.html#`.

The general contract of `hashCode` is:

- Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the `https://developer.android.com/reference/kotlin/java/lang/Object.html#equals(kotlin.Any)` method, then calling the `hashCode` method on each of the two objects must produce the same integer result.
- It is *not* required that if two objects are unequal according to the `https://developer.android.com/reference/kotlin/java/lang/Object.html#equals(kotlin.Any)` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

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

### setColor

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

```
fun setColor(color: Int): Notification.ProgressStyle.Segment
```

Optional color of this Segment

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#` | This value cannot be `null`. |

### setId

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

```
fun setId(id: Int): Notification.ProgressStyle.Segment
```

Optional ID used to uniquely identify the element across updates. The default is 0.

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#` | This value cannot be `null`. |

### setSemanticStyle

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

```
fun setSemanticStyle(semanticStyle: Int): Notification.ProgressStyle.Segment
```

Applies semantics to the Segment. When the notification `https://developer.android.com/reference/kotlin/android/app/Notification#FLAG_PROMOTED_ONGOING:kotlin.Int` this value is used to style (e.g. color) the segment.

If an app specifies *both* color and semantic style, the color overrides the style.

| Parameters ||
|---|---|
| `semanticStyle` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): Value is one of the following: - `https://developer.android.com/reference/kotlin/android/app/Notification#SEMANTIC_STYLE_UNSPECIFIED:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/app/Notification#SEMANTIC_STYLE_INFO:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/app/Notification#SEMANTIC_STYLE_SAFE:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/app/Notification#SEMANTIC_STYLE_CAUTION:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/app/Notification#SEMANTIC_STYLE_DANGER:kotlin.Int` |

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/app/Notification.ProgressStyle.Segment#` | This value cannot be `null`. |