public class FreeBusyUrl extends UriProperty implements HasAltId
Defines a URL that shows when the person is free/busy on their calendar.
Code sample
VCard vcard = new VCard(); FreeBusyUrl fburl = new FreeBusyUrl("http://www.example.com/freebusy/janedoe"); vcard.addFbUrl(fburl);
Property name: FBURL
Supported versions: 4.0
value
group, parameters
Constructor and Description |
---|
FreeBusyUrl(java.lang.String uri)
Creates a free/busy URL property.
|
Modifier and Type | Method and Description |
---|---|
java.util.Set<VCardVersion> |
_supportedVersions()
Gets the vCard versions that support this property.
|
void |
addPid(int localId,
int clientPidMapRef)
Adds a PID value.
|
java.lang.String |
getAltId()
Gets the property's ALTID parameter.
|
java.lang.String |
getMediaType()
Gets the MEDIATYPE parameter.
|
java.util.List<java.lang.Integer[]> |
getPids()
Gets all PID values.
|
java.lang.Integer |
getPref()
Gets the preference value.
|
java.lang.String |
getType()
Gets the TYPE parameter.
|
void |
removePids()
Removes all PID values.
|
void |
setAltId(java.lang.String altId)
Sets the property's ALTID parameter.
|
void |
setMediaType(java.lang.String mediaType)
Sets the MEDIATYPE parameter.
|
void |
setPref(java.lang.Integer pref)
Sets the preference value.
|
void |
setType(java.lang.String type)
Sets the TYPE parameter.
|
_validate, getValue, setValue
addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, removeParameter, setGroup, setParameter, setParameters, validate
public FreeBusyUrl(java.lang.String uri)
uri
- the URIpublic java.util.Set<VCardVersion> _supportedVersions()
VCardProperty
Gets the vCard versions that support this property.
This method should be overridden by child classes if the property does not support all vCard versions. The default implementation of this method returns all vCard versions.
_supportedVersions
in class VCardProperty
public java.lang.String getMediaType()
Supported versions: 4.0
public void setMediaType(java.lang.String mediaType)
Supported versions: 4.0
mediaType
- the media type or null to removepublic java.util.List<java.lang.Integer[]> getPids()
VCardProperty
Gets all PID values.
Supported versions: 4.0
VCardParameters.getPids()
public void addPid(int localId, int clientPidMapRef)
VCardProperty
Adds a PID value.
Supported versions: 4.0
localId
- the local IDclientPidMapRef
- the ID used to reference the property's globally
unique identifier in the CLIENTPIDMAP property.VCardParameters.addPid(int, int)
public void removePids()
VCardProperty
Removes all PID values.
Supported versions: 4.0
VCardParameters.removePids()
public java.lang.Integer getPref()
VCardProperty
Gets the preference value. The lower the number, the more preferred this property instance is compared with other properties in the same vCard of the same type. If a property doesn't have a preference value, then it is considered the least preferred.
Supported versions: 4.0
VCardParameters.getPref()
public void setPref(java.lang.Integer pref)
VCardProperty
Sets the preference value. The lower the number, the more preferred this property instance is compared with other properties in the same vCard of the same type. If a property doesn't have a preference value, then it is considered the least preferred.
Supported versions: 4.0
pref
- the preference value or null to removeVCardParameters.setPref(java.lang.Integer)
public java.lang.String getAltId()
HasAltId
Supported versions: 4.0
getAltId
in interface HasAltId
VCardParameters.getAltId()
public void setAltId(java.lang.String altId)
HasAltId
Supported versions: 4.0
setAltId
in interface HasAltId
altId
- the ALTID or null to removeVCardParameters.setAltId(java.lang.String)
public java.lang.String getType()
Supported versions: 4.0
public void setType(java.lang.String type)
Supported versions: 4.0
type
- the TYPE value (this should be either "work" or "home") or
null to removeThis software is published under the BSD license. Copyright © 2003-${build.year}, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.