Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIAddrBookSession Interface Reference

import "nsIAddrBookSession.idl";

Inheritance diagram for nsIAddrBookSession:
Inheritance graph
[legend]
Collaboration diagram for nsIAddrBookSession:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void addAddressBookListener (in nsIAbListener listener, in abListenerNotifyFlagValue notifyFlags)
 Adds a nsIAbListener to receive notifications of address book updates according to the specified notifyFlags.
void removeAddressBookListener (in nsIAbListener listener)
 Removes a nsIAbListener from receive notifications of address book updates.
void notifyItemPropertyChanged (in nsISupports item, in string property, in wstring oldValue, in wstring newValue)
void notifyDirectoryItemAdded (in nsIAbDirectory directory, in nsISupports item)
void notifyDirectoryItemDeleted (in nsIAbDirectory directory, in nsISupports item)
 when a card is deleted
void notifyDirectoryDeleted (in nsIAbDirectory directory, in nsISupports item)
 when a directory is deleted
wstring generateNameFromCard (in nsIAbCard card, in long generateFormat)
 generate the name from the card, using the firstName and lastName and the displayName
wstring generatePhoneticNameFromCard (in nsIAbCard aCard, in boolean aLastNameFirst)
 generate the phonetic name from the card, using the firstName and lastName

Public Attributes

const abListenerNotifyFlagValue added = 0x1
 These flags specify when to receive notifications of address book updates to be passed to addAddressBookListener.
const abListenerNotifyFlagValue directoryItemRemoved = 0x2
 A mailing list or card is removed from an address book.
const abListenerNotifyFlagValue directoryRemoved = 0x4
 An address book is removed.
const abListenerNotifyFlagValue changed = 0x8
 An address book, mailing list or card is changed.
const abListenerNotifyFlagValue all = 0xFFFFFFFF
 All of the above notifications are to be received.
readonly attribute nsILocalFile userProfileDirectory

Detailed Description

Definition at line 57 of file nsIAddrBookSession.idl.


Member Function Documentation

Adds a nsIAbListener to receive notifications of address book updates according to the specified notifyFlags.

Parameters:
listenerThe listener that is to receive updates.
notifyFlagsA bitwise-or of abListenerNotifyFlagValue items specifying which notifications to receive.
wstring nsIAddrBookSession::generateNameFromCard ( in nsIAbCard  card,
in long  generateFormat 
)

generate the name from the card, using the firstName and lastName and the displayName

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

0 = generated name is displayName 1 = lastFirst, formatted following lastFirstFormat (see addressBook.properties) 2 = firstLast, formatted following firstLastFormat (see addressBook.properties)

we allow the caller to cache the pref value, so we don't have to go to prefs every time.

wstring nsIAddrBookSession::generatePhoneticNameFromCard ( in nsIAbCard  aCard,
in boolean  aLastNameFirst 
)

generate the phonetic name from the card, using the firstName and lastName

void nsIAddrBookSession::notifyDirectoryDeleted ( in nsIAbDirectory  directory,
in nsISupports  item 
)

when a directory is deleted

void nsIAddrBookSession::notifyDirectoryItemAdded ( in nsIAbDirectory  directory,
in nsISupports  item 
)

when a card is deleted

void nsIAddrBookSession::notifyItemPropertyChanged ( in nsISupports  item,
in string  property,
in wstring  oldValue,
in wstring  newValue 
)

Removes a nsIAbListener from receive notifications of address book updates.

Parameters:
listenerThe listener that is to no longer receive updates.

Member Data Documentation

These flags specify when to receive notifications of address book updates to be passed to addAddressBookListener.

An address book, mailing list or card is added.

Definition at line 78 of file nsIAddrBookSession.idl.

All of the above notifications are to be received.

Definition at line 94 of file nsIAddrBookSession.idl.

An address book, mailing list or card is changed.

Definition at line 90 of file nsIAddrBookSession.idl.

A mailing list or card is removed from an address book.

Definition at line 82 of file nsIAddrBookSession.idl.

An address book is removed.

Definition at line 86 of file nsIAddrBookSession.idl.

Definition at line 120 of file nsIAddrBookSession.idl.


The documentation for this interface was generated from the following file: