AlarmManager.AlarmClockInfo

public static final class AlarmManager.AlarmClockInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.AlarmManager.AlarmClockInfo


An immutable description of a scheduled "alarm clock" event.

Summary

Inherited constants

Fields

public static final Creator<AlarmManager.AlarmClockInfo> CREATOR

Public constructors

AlarmManager.AlarmClockInfo(long triggerTime, PendingIntent showIntent)

Creates a new alarm clock description.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

PendingIntent getShowIntent()

Returns an intent that can be used to show or edit details of the alarm clock in the application that scheduled it.

long getTriggerTime()

Returns the time at which the alarm is going to trigger.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

added in API level 21
public static final Creator<AlarmManager.AlarmClockInfo> CREATOR

Public constructors

AlarmManager.AlarmClockInfo

added in API level 21
public AlarmManager.AlarmClockInfo (long triggerTime, 
                PendingIntent showIntent)

Creates a new alarm clock description.

Parameters
triggerTime long: time at which the underlying alarm is triggered in wall time milliseconds since the epoch

showIntent PendingIntent: an intent that can be used to show or edit details of the alarm clock.

Public methods

describeContents

added in API level 21
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

getShowIntent

added in API level 21
public PendingIntent getShowIntent ()

Returns an intent that can be used to show or edit details of the alarm clock in the application that scheduled it.

Beware that any application can retrieve and send this intent, potentially with additional fields filled in. See PendingIntent.send() and Intent.fillIn() for details.

Returns
PendingIntent

getTriggerTime

added in API level 21
public long getTriggerTime ()

Returns the time at which the alarm is going to trigger. This value is UTC wall clock time in milliseconds, as returned by System.currentTimeMillis() for example.

Returns
long

writeToParcel

added in API level 21
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.