AlarmInstance.Builder

class AlarmInstance.Builder


Builder for AlarmInstance.

Summary

Public constructors

Builder(alarmInstance: AlarmInstance)

Constructor for AlarmInstance.Builder with all the existing values.

Builder(namespace: String, id: String, scheduledTime: String)

Constructor for AlarmInstance.Builder.

Public functions

T
addAlternateName(alternateName: String)

Adds an alias for the item.

T
addPotentialAction(newPotentialAction: PotentialAction)

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

AlarmInstance

Builds the AlarmInstance.

Thing

Builds a Thing object.

T

Clears the aliases, if any, for the item.

T

Clear all the potential actions for this document.

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
setImage(image: String?)

Sets the URL for an image of the item.

T
setName(name: String?)

Sets the name of the item.

T
setSnoozeDurationMillis(snoozeDurationMillis: Long)

Sets the length of time in milliseconds the AlarmInstance will remain snoozed before it fires again.

T
setStatus(status: Int)

Sets the current status.

T
setUrl(url: String?)

Sets the deeplink URL of the item.

Public constructors

Builder

Added in 1.1.0-alpha04
Builder(alarmInstance: AlarmInstance)

Constructor for AlarmInstance.Builder with all the existing values.

Builder

Added in 1.1.0-alpha04
Builder(namespace: String, id: String, scheduledTime: String)

Constructor for AlarmInstance.Builder.

Parameters
namespace: String

Namespace for the Document. See Document.Namespace.

id: String

Unique identifier for the Document. See Document.Id.

scheduledTime: String

The time that this is expected to fire in ISO 8601 format. E.g.: 2022-01-14T00:00:00. Scheduled time should be timezone independent.

Public functions

addAlternateName

Added in 1.1.0-alpha04
fun addAlternateName(alternateName: String): T

Adds an alias for the item.

addPotentialAction

Added in 1.1.0-alpha04
fun addPotentialAction(newPotentialAction: PotentialAction): T

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

build

Added in 1.1.0-alpha04
fun build(): AlarmInstance

Builds the AlarmInstance.

build

Added in 1.1.0-alpha04
fun build(): Thing

Builds a Thing object.

clearAlternateNames

Added in 1.1.0-alpha04
fun clearAlternateNames(): T

Clears the aliases, if any, for the item.

clearPotentialActions

Added in 1.1.0-alpha04
fun clearPotentialActions(): T

Clear all the potential actions for this document.

setCreationTimestampMillis

Added in 1.1.0-alpha04
fun setCreationTimestampMillis(creationTimestampMillis: Long): T

Sets the creation timestamp for the current AppSearch entity, in milliseconds using the currentTimeMillis time base.

This timestamp refers to the creation time of the AppSearch entity, not when the document is written into AppSearch.

If not set, then the current timestamp will be used.

See androidx.appsearch.annotation.Document.CreationTimestampMillis for more information on creation timestamp.

setDescription

Added in 1.1.0-alpha04
fun setDescription(description: String?): T

Sets the description for the item.

setDocumentScore

Added in 1.1.0-alpha04
fun setDocumentScore(documentScore: Int): T

Sets the user-provided opaque document score of the current AppSearch document, which can be used for ranking using RANKING_STRATEGY_DOCUMENT_SCORE.

See androidx.appsearch.annotation.Document.Score for more information on score.

setDocumentTtlMillis

Added in 1.1.0-alpha04
fun setDocumentTtlMillis(documentTtlMillis: Long): T

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

The document will be automatically deleted when the TTL expires.

If not set, then the document will never expire.

See androidx.appsearch.annotation.Document.TtlMillis for more information on TTL.

setImage

Added in 1.1.0-alpha04
fun setImage(image: String?): T

Sets the URL for an image of the item.

setName

Added in 1.1.0-alpha04
fun setName(name: String?): T

Sets the name of the item.

setSnoozeDurationMillis

Added in 1.1.0-alpha04
fun setSnoozeDurationMillis(snoozeDurationMillis: Long): T

Sets the length of time in milliseconds the AlarmInstance will remain snoozed before it fires again.

If not set, or set to -1, then it does not support snoozing.

setStatus

Added in 1.1.0-alpha04
fun setStatus(status: Int): T

Sets the current status.

Status can be either STATUS_UNKNOWN, STATUS_SCHEDULED, STATUS_FIRING, STATUS_DISMISSED, STATUS_SNOOZED, or STATUS_MISSED.

setUrl

Added in 1.1.0-alpha04
fun setUrl(url: String?): T

Sets the deeplink URL of the item.

If this item can be displayed by any system UI surface, or can be read by another Android package, through one of the androidx.appsearch.app.SetSchemaRequest.Builder methods, this url should act as a deeplink into the activity that can open it. Callers should be able to construct an ACTION_VIEW intent with the url as the setData to view the item inside your application.

See Allowing Other Apps to Start Your Activity for more details on how to make activities in your app open for use by other apps by defining intent filters.

Protected properties

mAlternateNames

protected val mAlternateNames: (Mutable)List<String!>!

mCreationTimestampMillis

protected val mCreationTimestampMillisLong

mDescription

protected val mDescriptionString!

mDocumentScore

protected val mDocumentScoreInt

mDocumentTtlMillis

protected val mDocumentTtlMillisLong

mId

protected val mIdString!

mImage

protected val mImageString!

mName

protected val mNameString!

mNamespace

protected val mNamespaceString!

mPotentialActions

protected val mPotentialActions: (Mutable)List<PotentialAction!>!

mScheduledTime

protected val mScheduledTimeString!

mSnoozeDurationMillis

protected val mSnoozeDurationMillisLong

mStatus

protected val mStatusInt

mUrl

protected val mUrlString!