MobileApplication.BuilderBase


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

Known direct subclasses

Summary

Public constructors

BuilderBase(mobileApplication: MobileApplication)

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

BuilderBase(
    namespace: String,
    id: String,
    packageName: String,
    sha256Certificate: ByteArray<Byte>
)

Constructor for MobileApplication.BuilderBase.

Public functions

MobileApplication

Builds the MobileApplication.

T
setClassName(className: String)

Sets the class name.

T
setDisplayName(displayName: String)

Sets the display name.

T
setIconUri(iconUri: Uri)

Sets the icon uri.

T
setUpdatedTimestampMillis(updatedTimestampMillis: Long)

Sets the last time the app was installed or updated on the device.

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(mobileApplication: MobileApplication)

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

Parameters
mobileApplication: MobileApplication

The existing MobileApplication to copy values from.

BuilderBase

Added in 1.2.0-alpha02
BuilderBase(
    namespace: String,
    id: String,
    packageName: String,
    sha256Certificate: ByteArray<Byte>
)

Constructor for MobileApplication.BuilderBase.

Parameters
namespace: String

The namespace of the document.

id: String

The id of the document.

packageName: String

The package name of the application.

sha256Certificate: ByteArray<Byte>

The SHA-256 certificate of the application.

Public functions

build

fun build(): MobileApplication

Builds the MobileApplication.

setClassName

Added in 1.2.0-alpha02
fun setClassName(className: String): T

Sets the class name.

setDisplayName

Added in 1.2.0-alpha02
fun setDisplayName(displayName: String): T

Sets the display name.

setIconUri

Added in 1.2.0-alpha02
fun setIconUri(iconUri: Uri): T

Sets the icon uri.

setUpdatedTimestampMillis

Added in 1.2.0-alpha02
fun setUpdatedTimestampMillis(updatedTimestampMillis: Long): T

Sets the last time the app was installed or updated on the device.