# CarMessage.Builder

# CarMessage.Builder

Artifact:[androidx.car.app:app](https://developer.android.com/jetpack/androidx/releases/car-app)  
[View Source](https://cs.android.com/search?q=file:androidx/car/app/messaging/model/CarMessage.java+class:androidx.car.app.messaging.model.CarMessage.Builder)  
Added in[1.3.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.3.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/car/app/messaging/model/CarMessage.Builder "View this page in Java")

<br />

```
class CarMessage.Builder
```

<br />

*** ** * ** ***

A builder for[CarMessage](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage)

## Summary

|                                                   ### Public constructors                                                   |
|-----------------------------------------------------------------------------------------------------------------------------|
| [Builder](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder#Builder())`()` |

|                                                   ### Public functions                                                   |
|--------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [CarMessage](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage)                 | [build](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder#build())`()` Returns a new[CarMessage](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage)instance defined by this builder                                                                                                                                   |
| [CarMessage.Builder](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder) | [setBody](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder#setBody(androidx.car.app.model.CarText))`(body: `[CarText](https://developer.android.com/reference/kotlin/androidx/car/app/model/CarText)`?)` Sets a[CarText](https://developer.android.com/reference/kotlin/androidx/car/app/model/CarText)representing the message body                          |
| [CarMessage.Builder](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder) | [setMultimediaMimeType](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder#setMultimediaMimeType(java.lang.String))`(multimediaMimeType: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`?)` Sets a[String](https://developer.android.com/reference/java/lang/String.html)representing the MIME type of a multimedia message |
| [CarMessage.Builder](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder) | [setMultimediaUri](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder#setMultimediaUri(android.net.Uri))`(multimediaUri: `[Uri](https://developer.android.com/reference/android/net/Uri.html)`?)` Sets a[Uri](https://developer.android.com/reference/android/net/Uri.html)pointing to the contents of a multimedia message.                                    |
| [CarMessage.Builder](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder) | [setRead](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder#setRead(boolean))`(isRead: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`)` Sets a`boolean`, indicating whether the message has been read                                                                                                                   |
| [CarMessage.Builder](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder) | [setReceivedTimeEpochMillis](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder#setReceivedTimeEpochMillis(long))`(receivedTimeEpochMillis: `[Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)`)` Sets a`long`representing the message timestamp (in epoch millis)                                                                  |
| [CarMessage.Builder](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder) | [setSender](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder#setSender(androidx.core.app.Person))`(sender: `[Person](https://developer.android.com/reference/kotlin/androidx/core/app/Person)`?)` Sets a[Person](https://developer.android.com/reference/kotlin/androidx/core/app/Person)representing the message sender                                      |

## Public constructors

### Builder

Added in 1.3.0  

```
Builder()
```  

## Public functions

### build

Added in[1.3.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.3.0)  

```
fun build(): CarMessage
```

Returns a new[CarMessage](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage)instance defined by this builder  

### setBody

Added in[1.3.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.3.0)  

```
fun setBody(body: CarText?): CarMessage.Builder
```

Sets a[CarText](https://developer.android.com/reference/kotlin/androidx/car/app/model/CarText)representing the message body

Messages must have one or both of the following:

- A message body (text)
- A MIME type + URI (image, audio, etc.)

|                                                                              See also                                                                               |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [setMultimediaMimeType](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder#setMultimediaMimeType(java.lang.String)) |   |
| [setMultimediaUri](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder#setMultimediaUri(android.net.Uri))            |   |

### setMultimediaMimeType

Added in[1.4.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.4.0)  

```
fun setMultimediaMimeType(multimediaMimeType: String?): CarMessage.Builder
```

Sets a[String](https://developer.android.com/reference/java/lang/String.html)representing the MIME type of a multimedia message

Messages must have one or both of the following:

- A message body (text)
- A MIME type + URI (image, audio, etc.)

|                                                                         See also                                                                         |
|----------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [setBody](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder#setBody(androidx.car.app.model.CarText))    |   |
| [setMultimediaUri](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder#setMultimediaUri(android.net.Uri)) |   |

### setMultimediaUri

Added in[1.4.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.4.0)  

```
fun setMultimediaUri(multimediaUri: Uri?): CarMessage.Builder
```

Sets a[Uri](https://developer.android.com/reference/android/net/Uri.html)pointing to the contents of a multimedia message.

Messages must have one or both of the following:

- A message body (text)
- A MIME type + URI (image, audio, etc.)

|                                                                              See also                                                                               |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [setBody](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder#setBody(androidx.car.app.model.CarText))               |   |
| [setMultimediaMimeType](https://developer.android.com/reference/kotlin/androidx/car/app/messaging/model/CarMessage.Builder#setMultimediaMimeType(java.lang.String)) |   |

### setRead

Added in[1.3.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.3.0)  

```
fun setRead(isRead: Boolean): CarMessage.Builder
```

Sets a`boolean`, indicating whether the message has been read  

### setReceivedTimeEpochMillis

Added in[1.3.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.3.0)  

```
fun setReceivedTimeEpochMillis(receivedTimeEpochMillis: Long): CarMessage.Builder
```

Sets a`long`representing the message timestamp (in epoch millis)  

### setSender

Added in[1.3.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.3.0)  

```
fun setSender(sender: Person?): CarMessage.Builder
```

Sets a[Person](https://developer.android.com/reference/kotlin/androidx/core/app/Person)representing the message sender

The[Person](https://developer.android.com/reference/kotlin/androidx/core/app/Person)must specify a non-null[setName](https://developer.android.com/reference/kotlin/androidx/core/app/Person.Builder#setName(java.lang.CharSequence))and[setKey](https://developer.android.com/reference/kotlin/androidx/core/app/Person.Builder#setKey(java.lang.String)).