Packageorg.igniterealtime.xiff.vcard
Classpublic class VCard
InheritanceVCard Inheritance flash.events.EventDispatcher
Implements IVCard

VCard updates in 2010:

New vCard data classes to encompass similar properties:

TODO: The only properties not yet implemented from the spec: agent, categories, key

See also

http://tools.ietf.org/html/rfc2426


Public Properties
 PropertyDefined By
  birthday : Date
Birthday.
VCard
  cacheFlushInterval : Number
[static] The interval on which to flush the vCard cache.
VCard
  description : String
Free-form descriptive text.
VCard
  email : String
Email address.
VCard
  extensions : Dictionary
[read-only] Map of the vCard's private extensions.
VCard
  formattedName : String
Formatted or display name.
VCard
  geographicalPosition : IVCardGeographicalPosition
Geographical position.
VCard
  homeAddress : IVCardAddress
Structured home address.
VCard
  homeAddressLabel : String
Home address label.
VCard
  homeTelephone : IVCardTelephone
Home telephone number.
VCard
  jid : UnescapedJID
Jabber ID.
VCard
  loaded : Boolean
[read-only] Indicates whether the vCard has been loaded.
VCard
  logo : IVCardPhoto
Organization logo.
VCard
  mailer : String
Mailer (e.g., Mail User Agent Type).
VCard
  name : IVCardName
Structured name.
VCard
  nickname : String
Nickname.
VCard
  note : String
Commentary note.
VCard
  organization : IVCardOrganization
Organizational name and unit.
VCard
  photo : IVCardPhoto
Photograph.
VCard
  privacyClass : String
Privacy classification.
VCard
  productID : String
Identifier of product that generated the vCard.
VCard
  revision : Date
Last revised.
VCard
  role : String
Role.
VCard
  sortString : String
Sort string.
VCard
  sound : IVCardSound
Formatted name pronunciation.
VCard
  timezone : Date
Time zone's Standard Time UTC offset.
VCard
  title : String
Title.
VCard
  uid : String
Unique identifier.
VCard
  url : String
Directory URL.
VCard
  version : String
Version of the vCard.
VCard
  workAddress : IVCardAddress
Structured work address.
VCard
  workAddressLabel : String
Work address label.
VCard
  workTelephone : IVCardTelephone
Work telephone number.
VCard
Public Methods
 MethodDefined By
  
Don't call directly, use the static method getVCard() and add a callback.
VCard
  
clearCache():void
[static] Immediately clears the vCard cache.
VCard
  
Create the XML needed to send the VCard within the Extension.
VCard
  
[static] Immediately expires the vCard cache.
VCard
  
[static] The way a vCard is requested and then later referred to.
VCard
  
handleVCard(iq:IIQ):void
Deserializes the incoming IQ to fill the values of this vCard.
VCard
  
saveVCard(connection:IXMPPConnection):void
Saves a vCard.
VCard
  
saveVCard_result(resultIQ:IQ):void
VCard
Events
 Event Summary Defined By
  Dispatched when the vCard has loaded.VCard
  Dispatched when the vCard has been saved.VCard
  Dispatched when saving the vCard fails.VCard
Property Detail
birthdayproperty
birthday:Date

Birthday.


Implementation
    public function get birthday():Date
    public function set birthday(value:Date):void
cacheFlushIntervalproperty 
public static var cacheFlushInterval:Number

The interval on which to flush the vCard cache. The default value is 6 hours.

descriptionproperty 
description:String

Free-form descriptive text.


Implementation
    public function get description():String
    public function set description(value:String):void
emailproperty 
email:String

Email address.


Implementation
    public function get email():String
    public function set email(value:String):void
extensionsproperty 
extensions:Dictionary  [read-only]

Map of the vCard's private extensions.


Implementation
    public function get extensions():Dictionary
formattedNameproperty 
formattedName:String

Formatted or display name.


Implementation
    public function get formattedName():String
    public function set formattedName(value:String):void
geographicalPositionproperty 
geographicalPosition:IVCardGeographicalPosition

Geographical position.


Implementation
    public function get geographicalPosition():IVCardGeographicalPosition
    public function set geographicalPosition(value:IVCardGeographicalPosition):void
homeAddressproperty 
homeAddress:IVCardAddress

Structured home address.


Implementation
    public function get homeAddress():IVCardAddress
    public function set homeAddress(value:IVCardAddress):void
homeAddressLabelproperty 
homeAddressLabel:String

Home address label.


Implementation
    public function get homeAddressLabel():String
    public function set homeAddressLabel(value:String):void
homeTelephoneproperty 
homeTelephone:IVCardTelephone

Home telephone number.


Implementation
    public function get homeTelephone():IVCardTelephone
    public function set homeTelephone(value:IVCardTelephone):void
jidproperty 
jid:UnescapedJID

Jabber ID.


Implementation
    public function get jid():UnescapedJID
    public function set jid(value:UnescapedJID):void
loadedproperty 
loaded:Boolean  [read-only]

Indicates whether the vCard has been loaded.


Implementation
    public function get loaded():Boolean
logoproperty 
logo:IVCardPhoto

Organization logo.


Implementation
    public function get logo():IVCardPhoto
    public function set logo(value:IVCardPhoto):void
mailerproperty 
mailer:String

Mailer (e.g., Mail User Agent Type).


Implementation
    public function get mailer():String
    public function set mailer(value:String):void
nameproperty 
name:IVCardName

Structured name.


Implementation
    public function get name():IVCardName
    public function set name(value:IVCardName):void
nicknameproperty 
nickname:String

Nickname.


Implementation
    public function get nickname():String
    public function set nickname(value:String):void
noteproperty 
note:String

Commentary note.


Implementation
    public function get note():String
    public function set note(value:String):void
organizationproperty 
organization:IVCardOrganization

Organizational name and unit.


Implementation
    public function get organization():IVCardOrganization
    public function set organization(value:IVCardOrganization):void
photoproperty 
photo:IVCardPhoto

Photograph.


Implementation
    public function get photo():IVCardPhoto
    public function set photo(value:IVCardPhoto):void
privacyClassproperty 
privacyClass:String

Privacy classification.


Implementation
    public function get privacyClass():String
    public function set privacyClass(value:String):void
productIDproperty 
productID:String

Identifier of product that generated the vCard.


Implementation
    public function get productID():String
    public function set productID(value:String):void
revisionproperty 
revision:Date

Last revised.


Implementation
    public function get revision():Date
    public function set revision(value:Date):void
roleproperty 
role:String

Role.


Implementation
    public function get role():String
    public function set role(value:String):void
sortStringproperty 
sortString:String

Sort string.


Implementation
    public function get sortString():String
    public function set sortString(value:String):void
soundproperty 
sound:IVCardSound

Formatted name pronunciation.


Implementation
    public function get sound():IVCardSound
    public function set sound(value:IVCardSound):void
timezoneproperty 
timezone:Date

Time zone's Standard Time UTC offset.


Implementation
    public function get timezone():Date
    public function set timezone(value:Date):void
titleproperty 
title:String

Title.


Implementation
    public function get title():String
    public function set title(value:String):void
uidproperty 
uid:String

Unique identifier.


Implementation
    public function get uid():String
    public function set uid(value:String):void
urlproperty 
url:String

Directory URL.


Implementation
    public function get url():String
    public function set url(value:String):void
versionproperty 
version:String

Version of the vCard. Usually 2.0 or 3.0.


Implementation
    public function get version():String
    public function set version(value:String):void

See also

workAddressproperty 
workAddress:IVCardAddress

Structured work address.


Implementation
    public function get workAddress():IVCardAddress
    public function set workAddress(value:IVCardAddress):void
workAddressLabelproperty 
workAddressLabel:String

Work address label.


Implementation
    public function get workAddressLabel():String
    public function set workAddressLabel(value:String):void
workTelephoneproperty 
workTelephone:IVCardTelephone

Work telephone number.


Implementation
    public function get workTelephone():IVCardTelephone
    public function set workTelephone(value:IVCardTelephone):void
Constructor Detail
VCard()Constructor
public function VCard()

Don't call directly, use the static method getVCard() and add a callback.

Method Detail
clearCache()method
public static function clearCache():void

Immediately clears the vCard cache.

createExtension()method 
public function createExtension():VCardExtension

Create the XML needed to send the VCard within the Extension.

Returns
VCardExtension
expireCache()method 
public static function expireCache():void

Immediately expires the vCard cache.

getVCard()method 
public static function getVCard(connection:IXMPPConnection, jid:UnescapedJID):VCard

The way a vCard is requested and then later referred to. var vCard:VCard = VCard.getVCard( connection, jid ); vCard.addEventListener( VCardEvent.LOADED, onVCardLoaded );

Parameters

connection:IXMPPConnection
 
jid:UnescapedJID

Returns
VCard — Reference to the vCard which will be filled once the loaded event occurs.
handleVCard()method 
public function handleVCard(iq:IIQ):void

Deserializes the incoming IQ to fill the values of this vCard.

Parameters

iq:IIQ

saveVCard()method 
public function saveVCard(connection:IXMPPConnection):void

Saves a vCard.

Parameters

connection:IXMPPConnection

saveVCard_result()method 
public function saveVCard_result(resultIQ:IQ):void

Parameters

resultIQ:IQ

Event Detail
loaded Event
Event Object Type: org.igniterealtime.xiff.events.VCardEvent
VCardEvent.type property = org.igniterealtime.xiff.events.VCardEvent.LOADED

Dispatched when the vCard has loaded.

saved Event  
Event Object Type: org.igniterealtime.xiff.events.VCardEvent
VCardEvent.type property = org.igniterealtime.xiff.events.VCardEvent.SAVED

Dispatched when the vCard has been saved.

saveError Event  
Event Object Type: org.igniterealtime.xiff.events.VCardEvent
VCardEvent.type property = org.igniterealtime.xiff.events.VCardEvent.SAVE_ERROR

Dispatched when saving the vCard fails.