ConversationItem.Builder

Builder()

Builder(other: ConversationItem)

Returns a builder from the given ConversationItem.

Builder(
    id: String,
    title: CarText,
    self: Person,
    messages: (Mutable)List<CarMessage!>,
    conversationCallback: ConversationCallback
)

Creates a Builder instance with the provided required params.

fun addAction(action: Action): ConversationItem.Builder

Adds an additional action for the conversation.

fun build(): ConversationItem

Returns a new ConversationItem instance defined by this builder

fun setConversationCallback(conversationCallback: ConversationCallback): ConversationItem.Builder

Sets a ConversationCallback for the conversation

fun setGroupConversation(isGroupConversation: Boolean): ConversationItem.Builder

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.

fun setIcon(icon: CarIcon): ConversationItem.Builder

Sets a CarIcon for the conversation

fun setId(id: String): ConversationItem.Builder

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

@ExperimentalCarApi
fun setIndexable(indexable: Boolean): ConversationItem.Builder

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)).

fun setMessages(messages: (Mutable)List<CarMessage!>): ConversationItem.Builder

Specifies a list of messages for the conversation

The messages should be sorted from oldest to newest and should not contain any null values.

fun setSelf(self: Person): ConversationItem.Builder

Sets a Person for the conversation

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

fun setTitle(title: CarText): ConversationItem.Builder

Sets the title of the conversation