AlarmInstance

Artifact: androidx.appsearch:appsearch-builtin-types

Kotlin |Java

@Document(name = "builtin:AlarmInstance")
class AlarmInstance : Thing

kotlin.Any
↳	androidx.appsearch.builtintypes.Thing
	↳	androidx.appsearch.builtintypes.AlarmInstance

AppSearch document representing an AlarmInstance entity.

An AlarmInstance must be associated with an Alarm. It represents a particular point in time for that Alarm. For example, if an Alarm is set to repeat every Monday, then each AlarmInstance for it will be the exact Mondays that the Alarm did trigger.

The scheduled time should be timezone independent so that it remains unchanged across timezones. E.g.: An AlarmInstance set to fire at 7am GMT should also fire at 7am when the timezone is changed to PST.

Summary

Nested types
`@Document.BuilderProducer class AlarmInstance.Builder` Builder for `AlarmInstance`.

Constants
`const Int`	`STATUS_DISMISSED = 3` The `AlarmInstance` has been dismissed.
`const Int`	`STATUS_FIRING = 2` The `AlarmInstance` is firing.
`const Int`	`STATUS_MISSED = 5` The `AlarmInstance` has been missed.
`const Int`	`STATUS_SCHEDULED = 1` The `AlarmInstance` is scheduled to fire at some point in the future.
`const Int`	`STATUS_SNOOZED = 4` The `AlarmInstance` has been snoozed.
`const Int`	`STATUS_UNKNOWN = 0` The `AlarmInstance` is in an unknown error state.

Public functions
`String`	`getScheduledTime()` Returns the time that this is expected to fire in ISO 8601 format.
`Long`	`getSnoozeDurationMillis()` Returns the length of time in milliseconds the `AlarmInstance` will remain snoozed before it fires again, or -1 if it does not support snoozing.
`Int`	`getStatus()` Returns the current status.

Inherited functions

From androidx.appsearch.builtintypes.Thing

`(Mutable)List<String!>`	`getAlternateNames()` Returns an unmodifiable list of aliases, if any, for this item.
`Long`	`getCreationTimestampMillis()` Returns the creation timestamp, in milliseconds since Unix epoch, of this item.
`String?`	`getDescription()` Returns a description of this item.
`Int`	`getDocumentScore()` Returns the intrinsic score (or importance) of this item.
`Long`	`getDocumentTtlMillis()` Returns the time-to-live timestamp, in milliseconds since `getCreationTimestampMillis`, for this item.
`String`	`getId()` Returns the unique identifier for this item.
`String?`	`@ExperimentalAppSearchApi getImage()` Returns the URL for an image of this item.
`String?`	`getName()` Returns the name of this item.
`String`	`getNamespace()` Returns the namespace (or logical grouping) for this item.
`(Mutable)List<PotentialAction!>`	`@ExperimentalAppSearchApi getPotentialActions()` Returns the actions that can be taken on this object.
`String?`	`getUrl()` Returns the deeplink URL of this item.