nsIAbDirectory

IID:AA920C90-1DD1-11B2-96D3-AA81268ADAFC
Inherits From:nsISupports

This interface is implemented by the following components:


Constants

PRInt32 opRead = 1
PRInt32 opWrite = 2
PRInt32 opSearch = 4

Properties

nsISupportsArray addressLists

readonly nsIEnumerator childCards

readonly nsISimpleEnumerator childNodes

PRUnichar* description

readonly nsIAbDirectoryProperties directoryProperties

PRUnichar* dirName

ACString dirPrefId

PRBool isMailList

readonly PRBool isRemote

Directory is local (example, mork based) or remote (example, LDAP)

readonly PRBool isSecure

Directory is secure (as in LDAP over SSL)

PRUint32 lastModifiedDate

PRUnichar* listNickName

readonly PRInt32 operations

readonly PRBool searchDuringLocalAutocomplete

Directory should be searched when doing local autocomplete

readonly PRBool supportsMailingLists


Methods

nsIAbCard addCard ( nsIAbCard card ) void addMailList ( nsIAbDirectory list ) void addMailListWithKey ( nsIAbDirectory list , out PRUint32 key ) void copyMailList ( nsIAbDirectory srcList ) void createDirectoryByURI ( PRUnichar* displayName , char* uri , PRBool migrating ) void createNewDirectory ( nsIAbDirectoryProperties properties ) void deleteCards ( nsISupportsArray cards ) void deleteDirectory ( nsIAbDirectory dierctory ) void dropCard ( nsIAbCard card , PRBool needToCopyCard ) void editMailListToDatabase ( char* uri , nsIAbCard listCard ) PRUnichar* getValueForCard ( nsIAbCard card , char* name ) PRBool hasCard ( nsIAbCard cards ) PRBool hasDirectory ( nsIAbDirectory dir ) void modifyDirectory ( nsIAbDirectory directory , nsIAbDirectoryProperties properties ) void setValueForCard ( nsIAbCard card , char* name , PRUnichar* value )

nsIAbCard addCard ( nsIAbCard card )

Return value is the card that got added we need to do this, as the card we pass in might be an abstract nsIAbCard, and the caller might need the "real" card (the mdbcard) to get / set non-standard card values

Arguments:
card

void addMailList ( nsIAbDirectory list )

Arguments:
list

void addMailListWithKey ( nsIAbDirectory list , out PRUint32 key )

Arguments:
list
key

void copyMailList ( nsIAbDirectory srcList )

Arguments:
srcList

void createDirectoryByURI ( PRUnichar* displayName , char* uri , PRBool migrating )

Arguments:
displayName
uri
migrating

void createNewDirectory ( nsIAbDirectoryProperties properties )

Arguments:
properties

void deleteCards ( nsISupportsArray cards )

Arguments:
cards

void deleteDirectory ( nsIAbDirectory dierctory )

Arguments:
dierctory

void dropCard ( nsIAbCard card , PRBool needToCopyCard )

Arguments:
card
needToCopyCard

void editMailListToDatabase ( char* uri , nsIAbCard listCard )

Edits an existing mailing list (specified as listCard) into the directory specified by the uri XXX javadoc me

Arguments:
uri
listCard

PRUnichar* getValueForCard ( nsIAbCard card , char* name )

Arguments:
card
name

PRBool hasCard ( nsIAbCard cards )

Arguments:
cards

PRBool hasDirectory ( nsIAbDirectory dir )

Arguments:
dir

void modifyDirectory ( nsIAbDirectory directory , nsIAbDirectoryProperties properties )

Arguments:
directory
properties

void setValueForCard ( nsIAbCard card , char* name , PRUnichar* value )

Arguments:
card
name
value

References

This interface is the type of the following properties:

nsIAbView.directory

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

nsIAbDirFactory.deleteDirectory, nsIAbDirectory.addMailList, nsIAbDirectory.addMailListWithKey, nsIAbDirectory.copyMailList, nsIAbDirectory.deleteDirectory, nsIAbDirectory.hasDirectory, nsIAbDirectory.modifyDirectory, nsIAbDirectoryQueryProxy.initiate, nsIAbMDBDirectory.addMailListToDirectory, nsIAddrBookSession.notifyDirectoryDeleted, nsIAddrBookSession.notifyDirectoryItemAdded, nsIAddrBookSession.notifyDirectoryItemDeleted, nsIAddrDBListener.onListEntryChange, nsIAddrDatabase.containsMailList, nsIAddrDatabase.createMailListAndAddToDB, nsIAddrDatabase.createMailListAndAddToDBWithKey, nsIAddrDatabase.createNewListCardAndAddToDB, nsIAddrDatabase.deleteCardFromMailList, nsIAddrDatabase.deleteMailList, nsIAddrDatabase.editMailList, nsIAddrDatabase.enumerateCards, nsIAddrDatabase.enumerateListAddresses, nsIAddrDatabase.getCardFromAttribute, nsIAddrDatabase.getMailingListsFromDB, nsIAddressBook.exportAddressBook, nsIAddressBook.modifyAddressBook

This interface is returned from the following methods:

nsIAbMDBDirectory.addDirectory

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com