Public Member Functions | Public Attributes

nsIAutoSyncMgrListener Interface Reference

import "nsIAutoSyncManager.idl";

List of all members.

Public Member Functions

void onFolderAddedIntoQ (in long aQType, in nsIMsgFolder aFolder)
 It is called on the listener when a new folder is added into the queue.
void onFolderRemovedFromQ (in long aQType, in nsIMsgFolder aFolder)
 It is called on the listener when a folder is removed from the queue.
void onDownloadStarted (in nsIMsgFolder aFolder, in unsigned long aNumberOfMessages, in unsigned long aTotalPending)
 It is called on the listener when a message download is successfully started.
void onDownloadCompleted (in nsIMsgFolder aFolder)
 It is called on the listener when a message download on the given folder is completed.
void onDownloadError (in nsIMsgFolder aFolder)
 It is called on the listener when an error occurs during the message download.
void onStateChanged (in boolean aRunning)
void onDiscoveryQProcessed (in nsIMsgFolder aFolder, in unsigned long aNumberOfHdrsProcessed, in unsigned long aLeftToProcess)
 It is called on the listener after the auto-sync manager starts to process existing headers of the given folder to find missing message bodies (mostly for debugging purposes).
void onAutoSyncInitiated (in nsIMsgFolder aFolder)
 It is called on the listener after the auto-sync manager updates the given folder (mostly for debugging purposes).

Public Attributes

const long PriorityQueue = 1
 Queue types.
const long UpdateQueue = 2
const long DiscoveryQueue = 3

Member Function Documentation

void nsIAutoSyncMgrListener::onAutoSyncInitiated ( in nsIMsgFolder  aFolder  ) 

It is called on the listener after the auto-sync manager updates the given folder (mostly for debugging purposes).

void nsIAutoSyncMgrListener::onDiscoveryQProcessed ( in nsIMsgFolder  aFolder,
in unsigned long  aNumberOfHdrsProcessed,
in unsigned long  aLeftToProcess 
)

It is called on the listener after the auto-sync manager starts to process existing headers of the given folder to find missing message bodies (mostly for debugging purposes).

void nsIAutoSyncMgrListener::onDownloadCompleted ( in nsIMsgFolder  aFolder  ) 

It is called on the listener when a message download on the given folder is completed.

void nsIAutoSyncMgrListener::onDownloadError ( in nsIMsgFolder  aFolder  ) 

It is called on the listener when an error occurs during the message download.

void nsIAutoSyncMgrListener::onDownloadStarted ( in nsIMsgFolder  aFolder,
in unsigned long  aNumberOfMessages,
in unsigned long  aTotalPending 
)

It is called on the listener when a message download is successfully started.

Parameters:
aFolder folder in which the download is started
aNumberOfMessages number of the messages that will be downloaded
aTotalPending total number of messages waiting to be downloaded
void nsIAutoSyncMgrListener::onFolderAddedIntoQ ( in long  aQType,
in nsIMsgFolder  aFolder 
)

It is called on the listener when a new folder is added into the queue.

Parameters:
aQType type of the queue
aFolder folder that is added into the queue
void nsIAutoSyncMgrListener::onFolderRemovedFromQ ( in long  aQType,
in nsIMsgFolder  aFolder 
)

It is called on the listener when a folder is removed from the queue.

Parameters:
aQType type of the queue
aFolder folder that is removed from the queue
void nsIAutoSyncMgrListener::onStateChanged ( in boolean  aRunning  ) 

Member Data Documentation

Queue types.


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