ContactPoint.BuilderBase

@ExperimentalAppSearchApi
class ContactPoint.BuilderBase<T : ContactPoint.BuilderBase<T!>?> : Thing.BuilderBase

kotlin.Any
   ↳ androidx.appsearch.builtintypes.Thing.BuilderBase
     ↳ androidx.appsearch.builtintypes.ContactPoint.BuilderBase
Known direct subclasses

Summary

Public constructors
BuilderBase(contactPoint: ContactPoint)

Constructor for ContactPoint.BuilderBase with all the existing values of a ContactPoint.
BuilderBase(namespace: String, id: String, label: String)

Constructor for ContactPoint.BuilderBase.

Public functions
ContactPoint

Builds the ContactPoint.
T

Sets the flattened postal addresses.
T

Sets the email addresses.
T
setTelephones(telephones: (Mutable)List<String!>)

Sets the telephone numbers.

Inherited functions
From androidx.appsearch.builtintypes.Thing.BuilderBase
T
addAlternateName(alternateName: String)

Adds an alias for the item.
T

Add a new action to the list of potential actions for this document.
T

Clears the aliases, if any, for the item.
T

Clear all the potential actions for this document.
Unit

If built, make a copy of previous data for every field so that the builder can be reused.
T
setAlternateNames(alternateNames: (Mutable)List<String!>?)

Sets a list of aliases for the item.
T
setCreationTimestampMillis(creationTimestampMillis: Long)

Sets the creation timestamp for the current AppSearch entity, in milliseconds using the currentTimeMillis time base.
T
setDescription(description: String?)

Sets the description for the item.
T
setDocumentScore(documentScore: Int)

Sets the user-provided opaque document score of the current AppSearch document, which can be used for ranking using RANKING_STRATEGY_DOCUMENT_SCORE.
T
setDocumentTtlMillis(documentTtlMillis: Long)

Sets the time-to-live (TTL) for the current AppSearch document as a duration in milliseconds.
T

Sets the URL for an image of the item.
T
setName(name: String?)

Sets the name of the item.
T

Sets a list of potential actions for this document.
T
setUrl(url: String?)

Sets the deeplink URL of the item.

Public constructors

BuilderBase

Added in 1.2.0-alpha02
BuilderBase(contactPoint: ContactPoint)

Constructor for ContactPoint.BuilderBase with all the existing values of a ContactPoint.

Parameters
contactPoint: ContactPoint

The existing ContactPoint to copy values from.

BuilderBase

Added in 1.2.0-alpha02
BuilderBase(namespace: String, id: String, label: String)

Constructor for ContactPoint.BuilderBase.

Parameters
namespace: String

Namespace for the ContactPoint Document. See Document.Namespace.
id: String

Unique identifier for the ContactPoint Document. See Document.Id.
label: String

Label of this ContactPoint document. It could be "Home", "Work" or anything user defined.

Public functions

build

fun build(): ContactPoint

Builds the ContactPoint.

setAddresses

Added in 1.2.0-alpha02
fun setAddresses(addresses: (Mutable)List<String!>): T

Sets the flattened postal addresses.

setEmails

Added in 1.2.0-alpha02
fun setEmails(emails: (Mutable)List<String!>): T

Sets the email addresses.

setTelephones

Added in 1.2.0-alpha02
fun setTelephones(telephones: (Mutable)List<String!>): T

Sets the telephone numbers.