nsIImportABDescriptor
| IID: | 2d8983b2-cea6-4ae2-9145-eb772481fa18 |
| Inherits From: | nsISupports |
Implementation Note:
The default implementation can be obtained from nsIImportService::CreateNewABDescriptor();
You should only be interested in using this class if you implement the nsIImportAddressBooks interface in which case, just using the service to create new ones should work fine for you. If not, implement your own.
Properties
nsIFile abFile
For address books that want a file descriptor to locate the address book. For formats that do not, use identifier & ref to refer to the address book OR implement your own nsIImportABDescriptor that contains additional data necessary to identify specific address books,
PRUint32 identifier
Use the following 2 attributes however you'd like to refer to a specific address book
PRBool import
Set by the UI to indicate whether or not this address book should be imported.
AString preferredName
The preferred name for this address book. Depending upon how the user selected import, the caller of the nsIImportAddressBooks interface may use this name to create the destination address book or it may ignore it. However, this must be provided in all cases as it is also displayed in the UI to the user.
PRUint32 ref
PRUint32 size
Doesn't have to be accurate, this is merely used to report progress. If you're importing a file, using file size and reporting progress as the number of bytes processed so far makes sense. For other formats returning the number of records may make more sense.
References
This interface is passed as an argument to the following methods:
nsIImportAddressBooks.ImportAddressBook
This interface is returned from the following methods:
nsIImportService.CreateNewABDescriptor
Reference documentation is generated from Mozilla's source.