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.

nsIMsgNewsFolder

IID:B6333473-54DC-47C4-B179-3D4744946C95
Inherits From:nsISupports

This interface is implemented by the following components:

Properties

ACString groupPassword

ACString groupUsername

readonly ACString newsrcLine

readonly nsINntpIncomingServer nntpServer

readonly ACString optionLines

readonly ACString rawName

RawName is an 8-bit string to represent the name of a newsgroup used by a news server. It's offered for the convenience of callers so that they don't have to convert unicodeName to the server-side name when communicating with a news server. It's US-ASCII except for some 'stand-alone' Chinese news servers that use GB2312 for newsgroup names violating RFC 1036. For those servers, it's GB2312. However, it can be any other single and multibyte encoding in principle. The encoding of this string is stored in nsINntpIncomingServer because that's a server-wide property.

PRBool saveArticleOffline

readonly AString unicodeName

readonly ACString unsubscribedNewsgroupLines

Methods

nsIMsgFolder addNewsgroup ( AUTF8String newsgroupName , ACString setStr ) void cancelComplete ( ) void cancelFailed ( ) void forgetGroupPassword ( ) void forgetGroupUsername ( ) ACString getGroupPasswordWithUI ( AString promptString , AString promptTitle , nsIMsgWindow msgWindow ) ACString getGroupUsernameWithUI ( AString promptString , AString promptTitle , nsIMsgWindow msgWindow ) ACString getMessageIdForKey ( nsMsgKey key ) void getNextNMessages ( nsIMsgWindow msgWindow ) void moveFolder ( nsIMsgFolder newsgroupToMove , nsIMsgFolder refNewsgroup , PRInt32 orientation ) void notifyDownloadedLine ( char* line , nsMsgKey key ) void notifyFinishedDownloadinghdrs ( ) void removeMessage ( nsMsgKey key ) void SetNewsrcHasChanged ( PRBool newsrcHasChanged ) void setReadSetFromStr ( ACString setStr ) void updateSummaryFromNNTPInfo ( PRInt32 oldest , PRInt32 youngest , PRInt32 total )

nsIMsgFolder addNewsgroup ( AUTF8String newsgroupName , ACString setStr )

Arguments:
newsgroupName
setStr

void cancelComplete ( )

void cancelFailed ( )

void forgetGroupPassword ( )

void forgetGroupUsername ( )

ACString getGroupPasswordWithUI ( AString promptString , AString promptTitle , nsIMsgWindow msgWindow )

Arguments:
promptString
promptTitle
msgWindow

ACString getGroupUsernameWithUI ( AString promptString , AString promptTitle , nsIMsgWindow msgWindow )

Arguments:
promptString
promptTitle
msgWindow

ACString getMessageIdForKey ( nsMsgKey key )

Arguments:
key

void getNextNMessages ( nsIMsgWindow msgWindow )

Arguments:
msgWindow

void moveFolder ( nsIMsgFolder newsgroupToMove , nsIMsgFolder refNewsgroup , PRInt32 orientation )

Arguments:
newsgroupToMove
refNewsgroup
orientation

void notifyDownloadedLine ( char* line , nsMsgKey key )

Arguments:
line
key

void notifyFinishedDownloadinghdrs ( )

void removeMessage ( nsMsgKey key )

Arguments:
key

void SetNewsrcHasChanged ( PRBool newsrcHasChanged )

Arguments:
newsrcHasChanged

void setReadSetFromStr ( ACString setStr )

Arguments:
setStr

void updateSummaryFromNNTPInfo ( PRInt32 oldest , PRInt32 youngest , PRInt32 total )

Arguments:
oldest
youngest
total

References

This interface is passed as an argument to the following methods:

nsINNTPArticleList.initialize, nsINNTPNewsgroupList.initialize, nsINntpIncomingServer.displaySubscribedGroup

This interface is returned from the following methods:

nsINntpIncomingServer.findGroup

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com