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.

nsIAddrDatabase

IID:e93e3483-4586-4c2d-8e4e-ae573c5d7a41
Inherits From:nsIAddrDBAnnouncer

This interface is implemented by the following components:


Properties

nsIFile dbPath

Path to the address book database that this instance represents.

readonly PRUint32 deletedCardCount

Returns the count of the deleted card currently stored in the mork file.

readonly nsIArray deletedCardList

Returns an array of the deleted cards currently stored in the mork file.

readonly nsIMdbRow newListRow

readonly nsIMdbRow newRow


Methods

[noscript] void add2ndEmail ( nsIMdbRow row , char* value ) [noscript] void addAimScreenName ( nsIMdbRow row , char* value ) [noscript] void addAllowRemoteContent ( nsIMdbRow row , PRBool value ) [noscript] void addAnniversaryDay ( nsIMdbRow row , char* value ) [noscript] void addAnniversaryMonth ( nsIMdbRow row , char* value ) [noscript] void addAnniversaryYear ( nsIMdbRow row , char* value ) [noscript] void addBirthDay ( nsIMdbRow row , char* value ) [noscript] void addBirthMonth ( nsIMdbRow row , char* value ) [noscript] void addBirthYear ( nsIMdbRow row , char* value ) [noscript] void addCardRowToDB ( nsIMdbRow newRow ) [noscript] void addCategory ( nsIMdbRow row , char* value ) [noscript] void addCellularNumber ( nsIMdbRow row , char* value ) [noscript] void addCellularNumberType ( nsIMdbRow row , char* value ) [noscript] void addCompany ( nsIMdbRow row , char* value ) [noscript] void addCustom1 ( nsIMdbRow row , char* value ) [noscript] void addCustom2 ( nsIMdbRow row , char* value ) [noscript] void addCustom3 ( nsIMdbRow row , char* value ) [noscript] void addCustom4 ( nsIMdbRow row , char* value ) [noscript] void addDefaultAddress ( nsIMdbRow row , char* value ) [noscript] void addDepartment ( nsIMdbRow row , char* value ) [noscript] void addDisplayName ( nsIMdbRow row , char* value ) [noscript] void addFamilyName ( nsIMdbRow row , char* value ) [noscript] void addFaxNumber ( nsIMdbRow row , char* value ) [noscript] void addFaxNumberType ( nsIMdbRow row , char* value ) [noscript] void addFirstName ( nsIMdbRow row , char* value ) [noscript] void addHomeAddress ( nsIMdbRow row , char* value ) [noscript] void addHomeAddress2 ( nsIMdbRow row , char* value ) [noscript] void addHomeCity ( nsIMdbRow row , char* value ) [noscript] void addHomeCountry ( nsIMdbRow row , char* value ) [noscript] void addHomePhone ( nsIMdbRow row , char* value ) [noscript] void addHomePhoneType ( nsIMdbRow row , char* value ) [noscript] void addHomeState ( nsIMdbRow row , char* value ) [noscript] void addHomeZipCode ( nsIMdbRow row , char* value ) [noscript] void addJobTitle ( nsIMdbRow row , char* value ) [noscript] void addLastName ( nsIMdbRow row , char* value ) [noscript] void addLdifListMember ( nsIMdbRow row , char* value ) void AddListCardColumnsToRow ( nsIAbCard PCard , nsIMdbRow PListRow , PRUint32 pos , out nsIAbCard PNewCard , PRBool inMailingList ) [noscript] void addListDescription ( nsIMdbRow row , char* value ) [noscript] void addListDirNode ( nsIMdbRow listRow ) [noscript] void addListName ( nsIMdbRow row , char* value ) [noscript] void addListNickName ( nsIMdbRow row , char* value ) [noscript] void addNickName ( nsIMdbRow row , char* value ) [noscript] void addNotes ( nsIMdbRow row , char* value ) [noscript] void addPagerNumber ( nsIMdbRow row , char* value ) [noscript] void addPagerNumberType ( nsIMdbRow row , char* value ) [noscript] void addPhoneticFirstName ( nsIMdbRow row , char* value ) [noscript] void addPhoneticLastName ( nsIMdbRow row , char* value ) [noscript] void addPopularityIndex ( nsIMdbRow row , PRUint32 value ) [noscript] void addPreferMailFormat ( nsIMdbRow row , PRUint32 value ) [noscript] void addPrimaryEmail ( nsIMdbRow row , char* value ) [noscript] void addSpouseName ( nsIMdbRow row , char* value ) [noscript] void addWebPage1 ( nsIMdbRow row , char* value ) [noscript] void addWebPage2 ( nsIMdbRow row , char* value ) [noscript] void addWorkAddress ( nsIMdbRow row , char* value ) [noscript] void addWorkAddress2 ( nsIMdbRow row , char* value ) [noscript] void addWorkCity ( nsIMdbRow row , char* value ) [noscript] void addWorkCountry ( nsIMdbRow row , char* value ) [noscript] void addWorkPhone ( nsIMdbRow row , char* value ) [noscript] void addWorkPhoneType ( nsIMdbRow row , char* value ) [noscript] void addWorkState ( nsIMdbRow row , char* value ) [noscript] void addWorkZipCode ( nsIMdbRow row , char* value ) void close ( PRBool forceCommit ) void closeMDB ( PRBool commit ) void commit ( PRUint32 commitType ) PRBool containsCard ( nsIAbCard card ) PRBool containsMailList ( nsIAbDirectory mailList ) void createMailListAndAddToDB ( nsIAbDirectory newList , PRBool notify ) void createNewCardAndAddToDB ( nsIAbCard newCard , PRBool notify ) void createNewListCardAndAddToDB ( nsIAbDirectory list , PRUint32 listRowID , nsIAbCard newCard , PRBool notify ) void deleteCard ( nsIAbCard card , PRBool notify ) void deleteCardFromMailList ( nsIAbDirectory mailList , nsIAbCard card , PRBool notify ) void deleteMailList ( nsIAbDirectory mailList , PRBool notify ) void editCard ( nsIAbCard card , PRBool notify ) void editMailList ( nsIAbDirectory mailList , nsIAbCard listCard , PRBool notify ) nsISimpleEnumerator enumerateCards ( nsIAbDirectory directory ) nsISimpleEnumerator enumerateListAddresses ( nsIAbDirectory directory ) PRBool findMailListbyUnicodeName ( PRUnichar* listName ) nsIMdbRow FindRowByCard ( nsIAbCard card ) void forceClosed ( ) void getCardCount ( out PRUint32 count ) nsIAbCard getCardFromAttribute ( nsIAbDirectory directory , char* name , AUTF8String UTF8Value , PRBool caseInsensitive ) PRUnichar* getCardValue ( nsIAbCard card , char* name ) void getMailingListsFromDB ( nsIAbDirectory parentDir ) void InitCardFromRow ( nsIAbCard newCard , nsIMdbRow cardRow ) nsIAddrDatabase open ( nsIFile dbFile , PRBool create , PRBool upgrading ) void openMDB ( nsIFile dbName , PRBool create ) void setCardValue ( nsIAbCard card , char* name , PRUnichar* value , PRBool notify ) void SetListAddressTotal ( nsIMdbRow listRow , PRUint32 total )

void add2ndEmail ( nsIMdbRow row , char* value )

Arguments:
row
value

void addAimScreenName ( nsIMdbRow row , char* value )

Arguments:
row
value

void addAllowRemoteContent ( nsIMdbRow row , PRBool value )

Arguments:
row
value

void addAnniversaryDay ( nsIMdbRow row , char* value )

Arguments:
row
value

void addAnniversaryMonth ( nsIMdbRow row , char* value )

Arguments:
row
value

void addAnniversaryYear ( nsIMdbRow row , char* value )

Arguments:
row
value

void addBirthDay ( nsIMdbRow row , char* value )

Arguments:
row
value

void addBirthMonth ( nsIMdbRow row , char* value )

Arguments:
row
value

void addBirthYear ( nsIMdbRow row , char* value )

Arguments:
row
value

void addCardRowToDB ( nsIMdbRow newRow )

Arguments:
newRow

void addCategory ( nsIMdbRow row , char* value )

Arguments:
row
value

void addCellularNumber ( nsIMdbRow row , char* value )

Arguments:
row
value

void addCellularNumberType ( nsIMdbRow row , char* value )

Arguments:
row
value

void addCompany ( nsIMdbRow row , char* value )

Arguments:
row
value

void addCustom1 ( nsIMdbRow row , char* value )

Arguments:
row
value

void addCustom2 ( nsIMdbRow row , char* value )

Arguments:
row
value

void addCustom3 ( nsIMdbRow row , char* value )

Arguments:
row
value

void addCustom4 ( nsIMdbRow row , char* value )

Arguments:
row
value

void addDefaultAddress ( nsIMdbRow row , char* value )

Arguments:
row
value

void addDepartment ( nsIMdbRow row , char* value )

Arguments:
row
value

void addDisplayName ( nsIMdbRow row , char* value )

Arguments:
row
value

void addFamilyName ( nsIMdbRow row , char* value )

Arguments:
row
value

void addFaxNumber ( nsIMdbRow row , char* value )

Arguments:
row
value

void addFaxNumberType ( nsIMdbRow row , char* value )

Arguments:
row
value

void addFirstName ( nsIMdbRow row , char* value )

Arguments:
row
value

void addHomeAddress ( nsIMdbRow row , char* value )

Arguments:
row
value

void addHomeAddress2 ( nsIMdbRow row , char* value )

Arguments:
row
value

void addHomeCity ( nsIMdbRow row , char* value )

Arguments:
row
value

void addHomeCountry ( nsIMdbRow row , char* value )

Arguments:
row
value

void addHomePhone ( nsIMdbRow row , char* value )

Arguments:
row
value

void addHomePhoneType ( nsIMdbRow row , char* value )

Arguments:
row
value

void addHomeState ( nsIMdbRow row , char* value )

Arguments:
row
value

void addHomeZipCode ( nsIMdbRow row , char* value )

Arguments:
row
value

void addJobTitle ( nsIMdbRow row , char* value )

Arguments:
row
value

void addLastName ( nsIMdbRow row , char* value )

Arguments:
row
value

void addLdifListMember ( nsIMdbRow row , char* value )

Arguments:
row
value

void AddListCardColumnsToRow ( nsIAbCard PCard , nsIMdbRow PListRow , PRUint32 pos , out nsIAbCard PNewCard , PRBool inMailingList )

Arguments:
PCard
PListRow
pos
PNewCard
inMailingList

void addListDescription ( nsIMdbRow row , char* value )

Arguments:
row
value

void addListDirNode ( nsIMdbRow listRow )

Arguments:
listRow

void addListName ( nsIMdbRow row , char* value )

Arguments:
row
value

void addListNickName ( nsIMdbRow row , char* value )

Arguments:
row
value

void addNickName ( nsIMdbRow row , char* value )

Arguments:
row
value

void addNotes ( nsIMdbRow row , char* value )

Arguments:
row
value

void addPagerNumber ( nsIMdbRow row , char* value )

Arguments:
row
value

void addPagerNumberType ( nsIMdbRow row , char* value )

Arguments:
row
value

void addPhoneticFirstName ( nsIMdbRow row , char* value )

Arguments:
row
value

void addPhoneticLastName ( nsIMdbRow row , char* value )

Arguments:
row
value

void addPopularityIndex ( nsIMdbRow row , PRUint32 value )

Arguments:
row
value

void addPreferMailFormat ( nsIMdbRow row , PRUint32 value )

Arguments:
row
value

void addPrimaryEmail ( nsIMdbRow row , char* value )

Arguments:
row
value

void addSpouseName ( nsIMdbRow row , char* value )

Arguments:
row
value

void addWebPage1 ( nsIMdbRow row , char* value )

Arguments:
row
value

void addWebPage2 ( nsIMdbRow row , char* value )

Arguments:
row
value

void addWorkAddress ( nsIMdbRow row , char* value )

Arguments:
row
value

void addWorkAddress2 ( nsIMdbRow row , char* value )

Arguments:
row
value

void addWorkCity ( nsIMdbRow row , char* value )

Arguments:
row
value

void addWorkCountry ( nsIMdbRow row , char* value )

Arguments:
row
value

void addWorkPhone ( nsIMdbRow row , char* value )

Arguments:
row
value

void addWorkPhoneType ( nsIMdbRow row , char* value )

Arguments:
row
value

void addWorkState ( nsIMdbRow row , char* value )

Arguments:
row
value

void addWorkZipCode ( nsIMdbRow row , char* value )

Arguments:
row
value

void close ( PRBool forceCommit )

Arguments:
forceCommit

void closeMDB ( PRBool commit )

Arguments:
commit

void commit ( PRUint32 commitType )

Arguments:
commitType

PRBool containsCard ( nsIAbCard card )

Arguments:
card

PRBool containsMailList ( nsIAbDirectory mailList )

Arguments:
mailList

void createMailListAndAddToDB ( nsIAbDirectory newList , PRBool notify )

Arguments:
newList
notify

void createNewCardAndAddToDB ( nsIAbCard newCard , PRBool notify )

Arguments:
newCard
notify

void createNewListCardAndAddToDB ( nsIAbDirectory list , PRUint32 listRowID , nsIAbCard newCard , PRBool notify )

Arguments:
list
listRowID
newCard
notify

void deleteCard ( nsIAbCard card , PRBool notify )

Arguments:
card
notify

void deleteCardFromMailList ( nsIAbDirectory mailList , nsIAbCard card , PRBool notify )

Arguments:
mailList
card
notify

void deleteMailList ( nsIAbDirectory mailList , PRBool notify )

Arguments:
mailList
notify

void editCard ( nsIAbCard card , PRBool notify )

Arguments:
card
notify

void editMailList ( nsIAbDirectory mailList , nsIAbCard listCard , PRBool notify )

Arguments:
mailList
listCard
notify

nsISimpleEnumerator enumerateCards ( nsIAbDirectory directory )

Enumerate the cards in the directory. The enumerator will return the cards associated with mailing lists too.

Arguments:
directory: the directory of which to enumerate the cards.
Returns:
an enumerator.

nsISimpleEnumerator enumerateListAddresses ( nsIAbDirectory directory )

Enumerate the cards associated with the mailing lists in the directory.

Arguments:
directory: the directory of which to enumerate the cards.
Returns:
an enumerator.

PRBool findMailListbyUnicodeName ( PRUnichar* listName )

Arguments:
listName

nsIMdbRow FindRowByCard ( nsIAbCard card )

Arguments:
card

void forceClosed ( )


void getCardCount ( out PRUint32 count )

Arguments:
count

nsIAbCard getCardFromAttribute ( nsIAbDirectory directory , char* name , AUTF8String UTF8Value , PRBool caseInsensitive )

Gets the first card which matches the attribute/value pair supplied.

Arguments:
directory: The current nsIAbDirectory associated with this instance of the database.
name: The attribute to look up the value in.
UTF8Value: The value to look up in UTF8 format.
caseInsensitive: Set to true for case-insenstive matching.

PRUnichar* getCardValue ( nsIAbCard card , char* name )

Arguments:
card
name

void getMailingListsFromDB ( nsIAbDirectory parentDir )

Arguments:
parentDir

void InitCardFromRow ( nsIAbCard newCard , nsIMdbRow cardRow )

Arguments:
newCard
cardRow

nsIAddrDatabase open ( nsIFile dbFile , PRBool create , PRBool upgrading )

Arguments:
dbFile
create
upgrading

void openMDB ( nsIFile dbName , PRBool create )

Open the MDB database synchronously creating it if required. If successful, this routine will set up the m_mdbStore and m_mdbEnv of the database object so other database calls can work.

Arguments:
dbName: The location of the database file to open.
create: If set to true, will create the database file if it does not already exist.

void setCardValue ( nsIAbCard card , char* name , PRUnichar* value , PRBool notify )

Use for getting and setting generic string attributes like _AimScreenName

Arguments:
card
name
value
notify

void SetListAddressTotal ( nsIMdbRow listRow , PRUint32 total )

Arguments:
listRow
total

References

This interface is the type of the following properties:

nsIAbLDAPDirectory.replicationDatabase, nsIAbMDBDirectory.database

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

nsIAbLDIFService.importLDIFFile, nsIAbMDBCard.setAbDatabase, nsIImportAddressBooks.ImportAddressBook, nsIImportFieldMap.SetFieldValue, nsIImportFieldMap.SetFieldValueByDescription

This interface is returned from the following methods:

nsIAddrDatabase.open

Reference documentation is generated from Mozilla's source.