sbIWatchFolderService.idl
Go to the documentation of this file.
1 /*
2 //
3 // BEGIN SONGBIRD GPL
4 //
5 // This file is part of the Songbird web player.
6 //
7 // Copyright(c) 2005-2008 POTI, Inc.
8 // http://songbirdnest.com
9 //
10 // This file may be licensed under the terms of of the
11 // GNU General Public License Version 2 (the "GPL").
12 //
13 // Software distributed under the License is distributed
14 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
15 // express or implied. See the GPL for the specific language
16 // governing rights and limitations.
17 //
18 // You should have received a copy of the GPL along with this
19 // program. If not, go to http://www.gnu.org/licenses/gpl.html
20 // or write to the Free Software Foundation, Inc.,
21 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 //
23 // END SONGBIRD GPL
24 //
25 */
26 
27 #include "nsISupports.idl"
28 
29 [scriptable, uuid(a33307c2-1dd1-11b2-ad85-c03a5b21f0a3)]
31 {
32  //
33  // \brief Find out if the watch folder services are supported on
34  // the current OS.
35  // \return True if watch folder is supported, false if not.
36  //
37  readonly attribute boolean isSupported;
38 
39  //
40  // \brief Find out if the watch folder services are currently running and
41  // actively updating the users library.
42  // \return True if the watch folder is running, false if not.
43  //
44  readonly attribute boolean isRunning;
45 
56  void addIgnorePath(in AString aFilePath);
57 
66  void removeIgnorePath(in AString aFilePath);
67 
85  void addIgnoreCount(in AString aFilePath, in long aCount);
86 };
void addIgnorePath(in AString aFilePath)
Add a absolute file path to be ignored by the watch folder service. This path will be ignored until i...
var uuid
readonly attribute boolean isSupported
void removeIgnorePath(in AString aFilePath)
Remove an absolute file path from the ignored paths list of the watch folder service. All future events at the specified path will be processed by the watch folders service. When used in conjunction with |addIgnoreCount()|, any remaining events specified by the count will still be ignored.
void addIgnoreCount(in AString aFilePath, in long aCount)
Add an absolute file path to be ignore by the watch folder service. This path will be ignored for the...
restoreHistoryPrecursor aCount
readonly attribute boolean isRunning