ConversationItem.Builder

Added in 1.3.0

Kotlin |Java

public final class ConversationItem.Builder

A builder for ConversationItem

Summary

Public constructors
`Builder()` Returns an empty `Builder` instance.
`Builder(@NonNull ConversationItem other)` Returns a builder from the given `ConversationItem`.

Public methods
`@NonNull ConversationItem.Builder`	`addAction(@NonNull Action action)` Adds an additional action for the conversation.
`@NonNull ConversationItem`	`build()` Returns a new `ConversationItem` instance defined by this builder
`@NonNull ConversationItem.Builder`	`setConversationCallback( @NonNull ConversationCallback conversationCallback )` Sets a `ConversationCallback` for the conversation
`@NonNull ConversationItem.Builder`	`setGroupConversation(boolean isGroupConversation)` Specifies whether this conversation involves 3+ participants (a "group" conversation)
`@NonNull ConversationItem.Builder`	`setIcon(@NonNull CarIcon icon)` Sets a `CarIcon` for the conversation
`@NonNull ConversationItem.Builder`	`setId(@NonNull String id)` Specifies a unique identifier for the conversation
`@NonNull ConversationItem.Builder`	`@ExperimentalCarApi setIndexable(boolean indexable)` Sets whether this item can be included in indexed lists.
`@NonNull ConversationItem.Builder`	`setMessages(@NonNull List<CarMessage> messages)` Specifies a list of messages for the conversation
`@NonNull ConversationItem.Builder`	`setSelf(@NonNull Person self)` Sets a `Person` for the conversation
`@NonNull ConversationItem.Builder`	`setTitle(@NonNull CarText title)` Sets the title of the conversation

Public constructors

Builder

Added in 1.3.0

public Builder()

Returns an empty Builder instance.

Builder

Added in 1.4.0

public Builder(@NonNull ConversationItem other)

Returns a builder from the given ConversationItem.

Public methods

addAction

Added in 1.4.0

public @NonNull ConversationItem.Builder addAction(@NonNull Action action)

Adds an additional action for the conversation.

Throws
`java.lang.NullPointerException`	if `action` is `null`
`java.lang.IllegalArgumentException`	if `action` contains unsupported Action types, exceeds the maximum number of allowed actions (1) or does not contain a valid `CarIcon`.

build

Added in 1.3.0

public @NonNull ConversationItem build()

Returns a new ConversationItem instance defined by this builder

setConversationCallback

Added in 1.4.0

public @NonNull ConversationItem.Builder setConversationCallback(
    @NonNull ConversationCallback conversationCallback
)

Sets a ConversationCallback for the conversation

setGroupConversation

Added in 1.3.0

public @NonNull ConversationItem.Builder setGroupConversation(boolean isGroupConversation)

Specifies whether this conversation involves 3+ participants (a "group" conversation)

If unspecified, conversations are assumed to have exactly two participants (a "1:1" conversation)

UX presentation may differ slightly between group and 1:1 conversations. As a historical example, message readout may include sender names for group conversations, but omit them for 1:1 conversations.

setIcon

Added in 1.3.0

public @NonNull ConversationItem.Builder setIcon(@NonNull CarIcon icon)

Sets a CarIcon for the conversation

setId

Added in 1.3.0

public @NonNull ConversationItem.Builder setId(@NonNull String id)

Specifies a unique identifier for the conversation

IDs may be used for a variety of purposes, including...

Distinguishing new ConversationItems from updated ConversationItems in the UI, when data is refreshed
Identifying ConversationItems in "mark as read" / "reply" callbacks

setIndexable

Added in 1.7.0-beta02

@ExperimentalCarApi
public @NonNull ConversationItem.Builder setIndexable(boolean indexable)

Sets whether this item can be included in indexed lists. By default, this is set to true.

The host creates indexed lists to help users navigate through long lists more easily by sorting, filtering, or some other means.

For example, a messaging app may show conversations by last message received. If the app provides these conversations via the SectionedItemTemplate and enables #isAlphabeticalIndexingAllowed, the user will be able to jump to their conversations that start with a given letter they chose. The messaging app can choose to hide, for example, service messages from this filtered list by setting this #setIndexable(false).

Individual items can be set to be included or excluded from filtered lists, but it's also possible to enable/disable the creation of filtered lists as a whole via the template's API (eg. SectionedItemTemplate .Builder#setAlphabeticalIndexingAllowed(Boolean)).

setMessages

Added in 1.3.0

public @NonNull ConversationItem.Builder setMessages(@NonNull List<CarMessage> messages)

Specifies a list of messages for the conversation

The messages should be sorted from oldest to newest.

setSelf

Added in 1.4.0

public @NonNull ConversationItem.Builder setSelf(@NonNull Person self)

Sets a Person for the conversation

The Person must specify a non-null setName and setKey.

setTitle

Added in 1.3.0

public @NonNull ConversationItem.Builder setTitle(@NonNull CarText title)

Sets the title of the conversation