WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsISubscribableServer

IID:14b8597a-755b-4e93-b364-e0903801e6ea
Inherits From:nsISupports

This interface is implemented by the following components:

Properties

char delimiter

nsISubscribeListener subscribeListener

readonly PRBool supportsSubscribeSearch

Methods

void addTo ( AUTF8String name , PRBool addAsSubscribed , PRBool subscribable , PRBool changeIfExists ) void commitSubscribeChanges ( ) nsISimpleEnumerator getChildren ( AUTF8String path ) AUTF8String getFirstChildURI ( AUTF8String path ) AString getLeafName ( AUTF8String path ) PRBool hasChildren ( AUTF8String path ) PRBool isSubscribable ( AUTF8String path ) PRBool isSubscribed ( AUTF8String path ) void setAsSubscribed ( AUTF8String path ) void setIncomingServer ( nsIMsgIncomingServer server ) void setSearchValue ( AString searchValue ) void setShowFullName ( PRBool showFullName ) PRBool setState ( AUTF8String path , PRBool state ) void startPopulating ( nsIMsgWindow msgWindow , PRBool forceToServer , PRBool getOnlyNew ) void startPopulatingWithUri ( nsIMsgWindow msgWindow , PRBool forceToServer , char* uri ) void stopPopulating ( nsIMsgWindow msgWindow ) void subscribe ( PRUnichar* name ) void subscribeCleanup ( ) void unsubscribe ( PRUnichar* name ) void updateSubscribed ( )

void addTo ( AUTF8String name , PRBool addAsSubscribed , PRBool subscribable , PRBool changeIfExists )

Arguments:
name
addAsSubscribed
subscribable
changeIfExists

void commitSubscribeChanges ( )

nsISimpleEnumerator getChildren ( AUTF8String path )

Returns the children underneath the specified uri (path).

Arguments:
path: The server's uri; If this is null or empty, then the root server uri will be used.
Returns:
Enumerator containing the children.

AUTF8String getFirstChildURI ( AUTF8String path )

Arguments:
path

AString getLeafName ( AUTF8String path )

Arguments:
path

PRBool hasChildren ( AUTF8String path )

Arguments:
path

PRBool isSubscribable ( AUTF8String path )

Arguments:
path

PRBool isSubscribed ( AUTF8String path )

Arguments:
path

void setAsSubscribed ( AUTF8String path )

Arguments:
path

void setIncomingServer ( nsIMsgIncomingServer server )

Arguments:
server

void setSearchValue ( AString searchValue )

Arguments:
searchValue

void setShowFullName ( PRBool showFullName )

Arguments:
showFullName

PRBool setState ( AUTF8String path , PRBool state )

Arguments:
path
state

void startPopulating ( nsIMsgWindow msgWindow , PRBool forceToServer , PRBool getOnlyNew )

Arguments:
msgWindow
forceToServer
getOnlyNew

void startPopulatingWithUri ( nsIMsgWindow msgWindow , PRBool forceToServer , char* uri )

Arguments:
msgWindow
forceToServer
uri

void stopPopulating ( nsIMsgWindow msgWindow )

Arguments:
msgWindow

void subscribe ( PRUnichar* name )

Arguments:
name

void subscribeCleanup ( )

void unsubscribe ( PRUnichar* name )

Arguments:
name

void updateSubscribed ( )

Reference documentation is generated from Mozilla's source.