Top Inners Fields Constructors Methods
net.fortuna.ical4j.model.property

public Class Acknowledged

extends DateProperty<Instant>
implements UtcProperty
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.property.UtcProperty
Imports
net.fortuna.ical4j.model.*, net.fortuna.ical4j.model.parameter.Value, java.time.Instant, .ZoneId
Author
corneliu dobrota Property Name: ACKNOWLEDGED Purpose: This property specifies the UTC date and time at which the corresponding alarm was last sent or acknowledged. Value Type: DATE-TIME Property Parameters: IANA and non-standard property parameters can be specified on this property. Conformance: This property can be specified within "VALARM" calendar components. Description: This property is used to specify when an alarm was last sent or acknowledged. This allows clients to determine when a pending alarm has been acknowledged by a calendar user so that any alerts can be dismissed across multiple devices. It also allows clients to track repeating alarms or alarms on recurring events or to-dos to ensure that the right number of missed alarms can be tracked. Clients SHOULD set this property to the current date-time value in UTC when a calendar user acknowledges a pending alarm. Certain kinds of alarm may not provide feedback as to when the calendar user sees them, for example email based alerts. For those kinds of alarms, the client SHOULD set this property when the alarm is triggered and the action successfully carried out. When an alarm is triggered on a client, clients can check to see if an "ACKNOWLEDGED" property is present. If it is, and the value of that property is greater than or equal to the computed trigger time for the alarm, then the client SHOULD NOT trigger the alarm. Similarly, if an alarm has been triggered and an "alert" presented to a calendar user, clients can monitor the iCalendar data to determine whether an "ACKNOWLEDGED" is added or changed in the alarm component. If the value of any "ACKNOWLEDGED" in the alarm changes and is greater than or equal to the trigger time of the alarm, then clients SHOULD dismiss or cancel any "alert" presented to the calendar user. Example: The following is an example of this property: ACKNOWLEDGED:20090604T084500Z

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
Acknowledged.Factory

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides net.fortuna.ical4j.model.property.DateProperty.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
Acknowledged()

public
Acknowledged(final String
a string representation of a DTSTAMP value
aValue)

public
Acknowledged(final ParameterList
a list of parameters for this component
aList, final String
a value string for this component
aValue)

public
Acknowledged(final Instant
a date representing a date-time
aDate)

public
Acknowledged(final ParameterList
a list of parameters for this component
aList, final Instant
a date representing a date-time
aDate)

Method Summary

Modifier and TypeMethod and Description
protected PropertyFactory<Acknowledged>
newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

public void
setDefaultTimeZone(ZoneId
a timezone identifier
defaultTimeZone)

Overrides net.fortuna.ical4j.model.property.DateProperty.setDefaultTimeZone.

Overrides default net.fortuna.ical4j.model.property.UtcProperty.setDefaultTimeZone.

A default timezone may be specified for interpreting floating DATE-TIME values.

public void
setTimeZoneRegistry(TimeZoneRegistry timeZoneRegistry)

Overrides net.fortuna.ical4j.model.property.DateProperty.setTimeZoneRegistry.

Overrides default net.fortuna.ical4j.model.property.UtcProperty.setTimeZoneRegistry.

Inherited from net.fortuna.ical4j.model.property.DateProperty:
compareTogetDategetValuehashCodeisUtcrefreshParameterssetDatesetValuevalidate

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.property.DateProperty.serialVersionUID.

Constructor Detail

Acknowledgedback to summary
public Acknowledged()
Acknowledgedback to summary
public Acknowledged(final String aValue)
Parameters
aValue:String

a string representation of a DTSTAMP value

Acknowledgedback to summary
public Acknowledged(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

Acknowledgedback to summary
public Acknowledged(final Instant aDate)
Parameters
aDate:Instant

a date representing a date-time

Acknowledgedback to summary
public Acknowledged(final ParameterList aList, final Instant aDate)
Parameters
aList:ParameterList

a list of parameters for this component

aDate:Instant

a date representing a date-time

Method Detail

newFactoryback to summary
protected PropertyFactory<Acknowledged> newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Doc from net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

Returns:PropertyFactory<Acknowledged>

a property factory instance

Annotations
@Override
setDefaultTimeZoneback to summary
public void setDefaultTimeZone(ZoneId defaultTimeZone)

Overrides net.fortuna.ical4j.model.property.DateProperty.setDefaultTimeZone.

Overrides default net.fortuna.ical4j.model.property.UtcProperty.setDefaultTimeZone.

Doc from net.fortuna.ical4j.model.property.DateProperty.setDefaultTimeZone.

A default timezone may be specified for interpreting floating DATE-TIME values. In the absence of a default timezone the system default timezone will be used.

Parameters
defaultTimeZone:ZoneId

a timezone identifier

Annotations
@Override
setTimeZoneRegistryback to summary
public void setTimeZoneRegistry(TimeZoneRegistry timeZoneRegistry)

Overrides net.fortuna.ical4j.model.property.DateProperty.setTimeZoneRegistry.

Overrides default net.fortuna.ical4j.model.property.UtcProperty.setTimeZoneRegistry.

Annotations
@Override
net.fortuna.ical4j.model.property back to summary

public Class Acknowledged.Factory

extends Factory
implements PropertyFactory<Acknowledged>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.PropertyFactory, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
public
Factory()

Method Summary

Modifier and TypeMethod and Description
public Acknowledged
createProperty(final ParameterList
a list of property parameters
parameters, final String
a property value
value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

public Acknowledged
createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createPropertyback to summary
public Acknowledged createProperty(final ParameterList parameters, final String value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Parameters
parameters:ParameterList

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a list of property parameters

value:String

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a property value

Returns:Acknowledged

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public Acknowledged createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Returns:Acknowledged

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override