Package | org.igniterealtime.xiff.vcard |
Class | public class VCard |
Inheritance | VCard ![]() |
Implements | IVCard |
See also
Property | Defined 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 |
Method | Defined by | ||
---|---|---|---|
VCard()
Don't call directly, use the static method getVCard() and add a callback.
| VCard | ||
clearCache():void
[static]
Immediately clears the vCard cache.
| VCard | ||
expireCache():void
[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 |
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 |
birthday | property |
birthday:Date
[read-write]Birthday.
Implementation public function get birthday():Date
public function set birthday(value:Date):void
cacheFlushInterval | property |
public static var cacheFlushInterval:Number
The interval on which to flush the vCard cache. The default value is 6 hours.
description | property |
description:String
[read-write]Free-form descriptive text.
Implementation public function get description():String
public function set description(value:String):void
property |
email:String
[read-write]Email address.
Implementation public function get email():String
public function set email(value:String):void
extensions | property |
extensions:Dictionary
[read-only]Map of the vCard's private extensions.
Implementation public function get extensions():Dictionary
formattedName | property |
formattedName:String
[read-write]Formatted or display name.
Implementation public function get formattedName():String
public function set formattedName(value:String):void
geographicalPosition | property |
geographicalPosition:IVCardGeographicalPosition
[read-write]Geographical position.
Implementation public function get geographicalPosition():IVCardGeographicalPosition
public function set geographicalPosition(value:IVCardGeographicalPosition):void
homeAddress | property |
homeAddress:IVCardAddress
[read-write]Structured home address.
Implementation public function get homeAddress():IVCardAddress
public function set homeAddress(value:IVCardAddress):void
homeAddressLabel | property |
homeAddressLabel:String
[read-write]Home address label.
Implementation public function get homeAddressLabel():String
public function set homeAddressLabel(value:String):void
homeTelephone | property |
homeTelephone:IVCardTelephone
[read-write]Home telephone number.
Implementation public function get homeTelephone():IVCardTelephone
public function set homeTelephone(value:IVCardTelephone):void
jid | property |
jid:UnescapedJID
[read-write]Jabber ID.
Implementation public function get jid():UnescapedJID
public function set jid(value:UnescapedJID):void
loaded | property |
loaded:Boolean
[read-only]Indicates whether the vCard has been loaded.
Implementation public function get loaded():Boolean
logo | property |
logo:IVCardPhoto
[read-write]Organization logo.
Implementation public function get logo():IVCardPhoto
public function set logo(value:IVCardPhoto):void
mailer | property |
mailer:String
[read-write]Mailer (e.g., Mail User Agent Type).
Implementation public function get mailer():String
public function set mailer(value:String):void
name | property |
name:IVCardName
[read-write]Structured name.
Implementation public function get name():IVCardName
public function set name(value:IVCardName):void
nickname | property |
nickname:String
[read-write]Nickname.
Implementation public function get nickname():String
public function set nickname(value:String):void
note | property |
note:String
[read-write]Commentary note.
Implementation public function get note():String
public function set note(value:String):void
organization | property |
organization:IVCardOrganization
[read-write]Organizational name and unit.
Implementation public function get organization():IVCardOrganization
public function set organization(value:IVCardOrganization):void
photo | property |
photo:IVCardPhoto
[read-write]Photograph.
Implementation public function get photo():IVCardPhoto
public function set photo(value:IVCardPhoto):void
privacyClass | property |
privacyClass:String
[read-write]Privacy classification.
Implementation public function get privacyClass():String
public function set privacyClass(value:String):void
productID | property |
productID:String
[read-write]Identifier of product that generated the vCard.
Implementation public function get productID():String
public function set productID(value:String):void
revision | property |
revision:Date
[read-write]Last revised.
Implementation public function get revision():Date
public function set revision(value:Date):void
role | property |
role:String
[read-write]Role.
Implementation public function get role():String
public function set role(value:String):void
sortString | property |
sortString:String
[read-write]Sort string.
Implementation public function get sortString():String
public function set sortString(value:String):void
sound | property |
sound:IVCardSound
[read-write]Formatted name pronunciation.
Implementation public function get sound():IVCardSound
public function set sound(value:IVCardSound):void
timezone | property |
timezone:Date
[read-write]Time zone's Standard Time UTC offset.
Implementation public function get timezone():Date
public function set timezone(value:Date):void
title | property |
title:String
[read-write]Title.
Implementation public function get title():String
public function set title(value:String):void
uid | property |
uid:String
[read-write]Unique identifier.
Implementation public function get uid():String
public function set uid(value:String):void
url | property |
url:String
[read-write]Directory URL.
Implementation public function get url():String
public function set url(value:String):void
version | property |
version:String
[read-write]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
workAddress | property |
workAddress:IVCardAddress
[read-write]Structured work address.
Implementation public function get workAddress():IVCardAddress
public function set workAddress(value:IVCardAddress):void
workAddressLabel | property |
workAddressLabel:String
[read-write]Work address label.
Implementation public function get workAddressLabel():String
public function set workAddressLabel(value:String):void
workTelephone | property |
workTelephone:IVCardTelephone
[read-write]Work telephone number.
Implementation public function get workTelephone():IVCardTelephone
public function set workTelephone(value:IVCardTelephone):void
VCard | () | constructor |
public function VCard()
Don't call directly, use the static method getVCard() and add a callback.
clearCache | () | method |
public static function clearCache():void
Immediately clears the vCard cache.
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 );
connection:IXMPPConnection |
|
jid:UnescapedJID |
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.
Parametersiq:IIQ |
saveVCard | () | method |
public function saveVCard(connection:IXMPPConnection):void
Saves a vCard.
Parametersconnection:IXMPPConnection |
saveVCard_result | () | method |
loaded | event |
saved | event |
org.igniterealtime.xiff.events.VCardEvent
Dispatched when the vCard has been saved.
saveError | event |
org.igniterealtime.xiff.events.VCardEvent
Dispatched when saving the vCard fails.