sbIWatchFolder.idl

Go to the documentation of this file.

/*
//
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://songbirdnest.com
//
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
//
// Software distributed under the License is distributed
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
// express or implied. See the GPL for the specific language
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// END SONGBIRD GPL
//
*/

#include "nsISupports.idl"


interface sbIDirectoryImportService;
interface sbIFileMetadataService;
interface sbIMediacoreTypeSniffer;
interface sbIMediaList;


[scriptable, uuid(d5f4dec1-6c33-4401-b3b1-bf4d56b7b459)]
interface sbIWatchFolder : nsISupports
{
  attribute sbIMediaList mediaList;

  readonly attribute AString path;

  attribute sbIDirectoryImportService importer;

  attribute sbIMediacoreTypeSniffer typeSniffer;

  attribute sbIFileMetadataService metadataScanner;

  attribute boolean canInteract;

  //
  // \brief Find out if the watch folder services are supported on 
  //        the current OS.
  // \return True if watch folder is supported, false if not.
  //
  readonly attribute boolean isSupported;

  //
  // \brief Find out if the watch folder services are currently running and
  //        actively updating the users library.
  // \return True if the watch folder is running, false if not.
  //
  readonly attribute boolean isRunning;

  void addIgnorePath(in AString aFilePath);

  void removeIgnorePath(in AString aFilePath);
  
  void addIgnoreCount(in AString aFilePath, in long aCount);

  void start(in ACString aSessionGuid);

  ACString stop();

  void setFolder(in AString aPath, in boolean aSynchronizeMediaList);
};

%{C++
#define SB_WATCHFOLDER_CONTRACTID     \
  "@songbirdnest.com/watch-folder;1"
%};