AppointmentReminder

Inheritance: java.lang.Object

public class AppointmentReminder

Provides a grouping of component properties that define an alarm.

Constructors

Constructor Description
AppointmentReminder() Initialize a new instance of AppointmentReminder class.

Methods

Method Description
getAttendees() Contains collection of ReminderAttendee ReminderAttendeeobjects.
getAttachments() Contains collection of ReminderAttachment ReminderAttachmentobjects.
getAction() Defines the action to be invoked when an alarm is triggered.
setAction(int value) Defines the action to be invoked when an alarm is triggered.
getTrigger() Specifies when an alarm will trigger.
setTrigger(ReminderTrigger value) Specifies when an alarm will trigger.
getDescription() Provides a more complete description of the alarm.
setDescription(String value) Provides a more complete description of the alarm.
getSummary() Defines a short summary or subject for the alarm.
setSummary(String value) Defines a short summary or subject for the alarm.
getDuration() Specifies the delay period, after which the alarm will repeat.
setDuration(ReminderDuration value) Specifies the delay period, after which the alarm will repeat.
getRepeat() Defines the number of time the alarm should be repeated, after the initial trigger.
setRepeat(int value) Defines the number of time the alarm should be repeated, after the initial trigger.
getDefault15MinReminder() Gets the default 15 min reminder.

AppointmentReminder()

public AppointmentReminder()

Initialize a new instance of AppointmentReminder class.

getAttendees()

public final ReminderAttendeeCollection getAttendees()

Contains collection of ReminderAttendee ReminderAttendeeobjects.

Returns: ReminderAttendeeCollection

getAttachments()

public final ReminderAttachmentCollection getAttachments()

Contains collection of ReminderAttachment ReminderAttachmentobjects.

Returns: ReminderAttachmentCollection

getAction()

public final int getAction()

Defines the action to be invoked when an alarm is triggered.

Returns: int

setAction(int value)

public final void setAction(int value)

Defines the action to be invoked when an alarm is triggered.

Parameters:

Parameter Type Description
value int

getTrigger()

public final ReminderTrigger getTrigger()

Specifies when an alarm will trigger.

Returns: ReminderTrigger

setTrigger(ReminderTrigger value)

public final void setTrigger(ReminderTrigger value)

Specifies when an alarm will trigger.

Parameters:

Parameter Type Description
value ReminderTrigger

getDescription()

public final String getDescription()

Provides a more complete description of the alarm.

Returns: java.lang.String

setDescription(String value)

public final void setDescription(String value)

Provides a more complete description of the alarm.

Parameters:

Parameter Type Description
value java.lang.String

getSummary()

public final String getSummary()

Defines a short summary or subject for the alarm.

Returns: java.lang.String

setSummary(String value)

public final void setSummary(String value)

Defines a short summary or subject for the alarm.

Parameters:

Parameter Type Description
value java.lang.String

getDuration()

public final ReminderDuration getDuration()

Specifies the delay period, after which the alarm will repeat.

Returns: ReminderDuration

setDuration(ReminderDuration value)

public final void setDuration(ReminderDuration value)

Specifies the delay period, after which the alarm will repeat.

Parameters:

Parameter Type Description
value ReminderDuration

getRepeat()

public final int getRepeat()

Defines the number of time the alarm should be repeated, after the initial trigger.

Returns: int

setRepeat(int value)

public final void setRepeat(int value)

Defines the number of time the alarm should be repeated, after the initial trigger.

Parameters:

Parameter Type Description
value int

getDefault15MinReminder()

public static AppointmentReminder getDefault15MinReminder()

Gets the default 15 min reminder.

Returns: AppointmentReminder