Component name: VLOCATION
Purpose: This component provides rich information about the location
of an event using the structured data property or optionally a
plain text typed value.
Conformance: This component can be specified multiple times in a
"VEVENT", "VTODO", "VJOURNAL", "VFREEBUSY" or "PARTICIPANT"
calendar component.
Description: There may be a number of locations associated with an
event. This component provides detailed information about a
location.
When used in a component the value of this property provides
information about the event venue or of related services such as
parking, dining, stations etc..
STRUCTURED-DATA properties if present may refer to representations
of the location - such as a vCard.
Format Definition:
This component is defined by the following notation:
locationc = "BEGIN" ":" "VLOCATION" CRLF
locprop
"END" ":" "VLOCATION" CRLF
locprop = ; the elements herein may appear in any order,
; and the order is not significant.
uid
(name)
(description)
(geo)
(loctype)
sdataprop
iana-prop
The NAME property is defined in [RFC7986]
| Modifier and Type | Class and Description |
|---|---|
| public static class | VLocation.
Default factory. |
| Modifier and Type | Field and Description |
|---|---|
| private static final long |
| Access | Constructor and Description |
|---|---|
| public | |
| public | |
| public | VLocation(final PropertyList
a list of properties properties, final ComponentList<Component> components)Constructor. |
| Modifier and Type | Method and Description |
|---|---|
| public final Optional | Returns: the DESCRIPTION property or null if not specifiedReturns the optional description property. |
| public final Optional | |
| public Optional | Returns: the LocationType property or null if not specifiedReturns the optional LocationType property. |
| public final Optional | |
| public final List | |
| protected ComponentFactory | newFactory()
Implements abstract net. Returns a new component factory used to create deep copies. |
| public ValidationResult | validate(final boolean
indicates whether to validate the component's properties recurse)Implements abstract net. Perform validation on a component. |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| VLocation | back to summary |
|---|---|
| public VLocation() Default constructor. | |
| VLocation | back to summary |
|---|---|
| public VLocation(final PropertyList properties) Constructor.
| |
| VLocation | back to summary |
|---|---|
| public VLocation(final PropertyList properties, final ComponentList<Component> components) Constructor.
| |
| getDescription | back to summary |
|---|---|
| public final Optional Returns the optional description property.
| |
| getGeo | back to summary |
|---|---|
| public final Optional | |
| getLocationType | back to summary |
|---|---|
| public Optional Returns the optional LocationType property.
| |
| getNameProp | back to summary |
|---|---|
| public final Optional | |
| getStructuredData | back to summary |
|---|---|
| public final List | |
| newFactory | back to summary |
|---|---|
| protected ComponentFactory Implements abstract net. Doc from net. Returns a new component factory used to create deep copies.
| |
| validate | back to summary |
|---|---|
| public ValidationResult validate(final boolean recurse) throws ValidationException Implements abstract net. Doc from net. Perform validation on a component.
| |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public VLocation | |
| public VLocation | createComponent(final PropertyList properties)
Implements net.
|
| Factory | back to summary |
|---|---|
| public Factory() | |
| createComponent | back to summary |
|---|---|
| public VLocation createComponent() Implements net.
| |
| createComponent | back to summary |
|---|---|
| public VLocation createComponent(final PropertyList properties) Implements net.
| |