WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIAbCard

IID:193d5026-7d1e-41b4-9fc3-c57d4a4937f3
Inherits From:nsISupports

This interface is implemented by the following components:


Properties

AString aimScreenName

PRBool allowRemoteContent

AllowRemoteContent to be displayed in HTML mail received from this contact

AString anniversaryDay

AString anniversaryMonth

AString anniversaryYear

AString birthDay

AString birthMonth

AString birthYear

AString category

AString cellularNumber

AString cellularNumberType

AString company

AString custom1

AString custom2

AString custom3

AString custom4

AString defaultAddress

AString department

AString displayName

AString familyName

AString faxNumber

AString faxNumberType

AString firstName

AString homeAddress

AString homeAddress2

AString homeCity

AString homeCountry

AString homePhone

AString homePhoneType

AString homeState

AString homeZipCode

PRBool isMailList

AString jobTitle

PRUint32 lastModifiedDate

AString lastName

char* mailListURI

If isMailList is true then mailListURI will contain the URI of the associated mail list

AString nickName

AString notes

AString pagerNumber

AString pagerNumberType

AString phoneticFirstName

AString phoneticLastName

PRUint32 popularityIndex

Popularity Index is bumped every time e-mail is sent to this recipient

PRUint32 preferMailFormat

AString primaryEmail

AString secondEmail

AString spouseName

AString webPage1

WebPage1 is work web page

AString webPage2

WebPage2 is home web page

AString workAddress

AString workAddress2

AString workCity

AString workCountry

AString workPhone

AString workPhoneType

AString workState

AString workZipCode


Methods

char* convertToBase64EncodedXML ( ) char* convertToEscapedVCard ( ) AString convertToXMLPrintData ( ) void copy ( nsIAbCard srcCard ) PRBool equals ( nsIAbCard card ) AString generateName ( PRInt32 generateFormat , nsIStringBundle bundle ) AString generatePhoneticName ( PRBool lastNameFirst ) AString getCardValue ( char* name ) void setCardValue ( char* attrname , AString value )

char* convertToBase64EncodedXML ( )


char* convertToEscapedVCard ( )


AString convertToXMLPrintData ( )


void copy ( nsIAbCard srcCard )

This function will copy all values from one card to another.

Arguments:
srcCard: The source card to copy values from.

PRBool equals ( nsIAbCard card )

Arguments:
card

AString generateName ( PRInt32 generateFormat , nsIStringBundle bundle )

Generate a name from the card for display purposes. Using the firstName, lastName and the displayName. We allow the caller to cache the pref value, so we don't have to go to prefs every time.

The format follows the "mail.addr_book.lastnamefirst" pref values:

0 = generated name is displayName 1 = lastFirst, formatted following lastFirstFormat 2 = firstLast, formatted following firstLastFormat

LastFirstFormat and firstLastFormat are defined in addressBook.properties.

Arguments:
generateFormat: The format to generate as per the above definition.
bundle: An optional parameter that is a pointer to a string bundle that holds: chrome://messenger/locale/addressbook/addressBook.properties If this bundle is not supplied, then the function will obtain the bundle itself. If cached by the caller and supplied to this function, then performance will be improved over many calls.
Returns:
A string containing the generated name.

AString generatePhoneticName ( PRBool lastNameFirst )

Generate a phonetic name from the card, using the firstName and lastName values.

Arguments:
lastNameFirst: Set to True to put the last name before the first.
Returns:
A string containing the generated phonetic name.

AString getCardValue ( char* name )

Arguments:
name

void setCardValue ( char* attrname , AString value )

Arguments:
attrname
value

References

This interface is passed as an argument to the following methods:

nsIAbCard.copy, nsIAbCard.equals, nsIAbDirSearchListener.onSearchFoundCard, nsIAbDirectory.addCard, nsIAbDirectory.dropCard, nsIAbDirectory.editMailListToDatabase, nsIAbDirectory.hasCard, nsIAbDirectory.modifyCard, nsIAbDirectoryQueryResultListener.onQueryFoundCard, nsIAbLDAPAttributeMap.setCardPropertiesFromLDAPMessage, nsIAbMDBDirectory.addAddressToList, nsIAddrDBAnnouncer.notifyCardEntryChange, nsIAddrDBListener.onCardEntryChange, nsIAddrDatabase.AddListCardColumnsToRow, nsIAddrDatabase.FindRowByCard, nsIAddrDatabase.InitCardFromRow, nsIAddrDatabase.containsCard, nsIAddrDatabase.createNewCardAndAddToDB, nsIAddrDatabase.createNewListCardAndAddToDB, nsIAddrDatabase.deleteCard, nsIAddrDatabase.deleteCardFromMailList, nsIAddrDatabase.editCard, nsIAddrDatabase.editMailList, nsIAddrDatabase.getCardValue, nsIAddrDatabase.setCardValue, nsIImportFieldMap.GetFieldValue, nsIImportFieldMap.GetFieldValueByDescription

This interface is returned from the following methods:

nsIAbAddressCollecter.getCardFromAttribute, nsIAbDirectory.addCard, nsIAbMDBDirectory.cardForEmailAddress, nsIAbManager.escapedVCardToAbCard, nsIAbView.getCardFromRow, nsIAddrDatabase.getCardFromAttribute

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com