Public Member Functions | Public Attributes

nsIAutoSyncManager Interface Reference

import "nsIAutoSyncManager.idl";

Collaboration diagram for nsIAutoSyncManager:

List of all members.

Public Member Functions

void addListener (in nsIAutoSyncMgrListener aListener)
 Adds a listener to notify about auto-sync events.
void removeListener (in nsIAutoSyncMgrListener aListener)
 Removes the listener from notification list.
boolean doesMsgFitDownloadCriteria (in nsIMsgDBHdr aMsgHdr)
 Tests the given message to make sure that whether it fits the download criteria or not.
void onDownloadQChanged (in nsIAutoSyncState aAutoSyncStateObj)
 Called by the nsAutoSyncState object when the download queue is changed.
void onDownloadStarted (in nsIAutoSyncState aAutoSyncStateObj, in nsresult aStartCode)
 Called by the nsAutoSyncState object when the download is started.
void onDownloadCompleted (in nsIAutoSyncState aAutoSyncStateObj, in nsresult aExitCode)
 Called by the nsAutoSyncState object when the download completed.
void pause ()
 Pause autosync (e.g., we're downloading for offline).
void resume ()
 Resume normal autosync activities (e.g., we've come back online).

Public Attributes

const long dmParallel = 0
 Download models.
const long dmChained = 1
attribute unsigned long groupSize
 Suggested minimum grouping size in bytes for message downloads.
attribute nsIAutoSyncMsgStrategy msgStrategy
 Active strategy function to prioritize messages in the download queue.
attribute nsIAutoSyncFolderStrategy folderStrategy
 Active strategy function to prioritize folders in the download queue.
readonly attribute unsigned long discoveryQLength
 Number of elements in the discovery queue.
readonly attribute unsigned long updateQLength
 Number of elements in the update queue.
readonly attribute unsigned long downloadQLength
 Number of elements in the download queue (a.k.a priority queue).
attribute long downloadModel
 Active download model; Chained (serial), or Parallel.

Member Function Documentation

void nsIAutoSyncManager::addListener ( in nsIAutoSyncMgrListener  aListener  ) 

Adds a listener to notify about auto-sync events.

boolean nsIAutoSyncManager::doesMsgFitDownloadCriteria ( in nsIMsgDBHdr  aMsgHdr  ) 

Tests the given message to make sure that whether it fits the download criteria or not.

void nsIAutoSyncManager::onDownloadCompleted ( in nsIAutoSyncState  aAutoSyncStateObj,
in nsresult  aExitCode 
)

Called by the nsAutoSyncState object when the download completed.

Given interface is already addref'd.

void nsIAutoSyncManager::onDownloadQChanged ( in nsIAutoSyncState  aAutoSyncStateObj  ) 

Called by the nsAutoSyncState object when the download queue is changed.

Given interface is already addref'd.

void nsIAutoSyncManager::onDownloadStarted ( in nsIAutoSyncState  aAutoSyncStateObj,
in nsresult  aStartCode 
)

Called by the nsAutoSyncState object when the download is started.

Given interface is already addref'd.

void nsIAutoSyncManager::pause (  ) 

Pause autosync (e.g., we're downloading for offline).

void nsIAutoSyncManager::removeListener ( in nsIAutoSyncMgrListener  aListener  ) 

Removes the listener from notification list.

void nsIAutoSyncManager::resume (  ) 

Resume normal autosync activities (e.g., we've come back online).


Member Data Documentation

readonly attribute unsigned long nsIAutoSyncManager::discoveryQLength

Number of elements in the discovery queue.

See also:
nsAutoSyncManager.h for details

Download models.

Active download model; Chained (serial), or Parallel.

readonly attribute unsigned long nsIAutoSyncManager::downloadQLength

Number of elements in the download queue (a.k.a priority queue).

See also:
nsAutoSyncManager.h for details

Active strategy function to prioritize folders in the download queue.

attribute unsigned long nsIAutoSyncManager::groupSize

Suggested minimum grouping size in bytes for message downloads.

Setting this attribute to 0 resets its value to the hardcoded default.

Active strategy function to prioritize messages in the download queue.

readonly attribute unsigned long nsIAutoSyncManager::updateQLength

Number of elements in the update queue.

See also:
nsAutoSyncManager.h for details

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