sbIBundle.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 sbIBundleDataListener;
interface sbIBundleInstallListener;
interface nsIDOMDocument;
interface nsIDOMWindow;
[scriptable, uuid(656eda3e-aeff-11db-96e1-005056c00008)]
interface sbIBundle : nsISupports
{
  attribute AString bundleId;

  attribute AString bundleURL;

  void retrieveBundleData(in long aTimeout);

  void retrieveLocalBundleData();

  void addBundleDataListener(in sbIBundleDataListener aListener);

  void removeBundleDataListener(in sbIBundleDataListener aListener);

  readonly attribute long bundleDataStatus;
  const long BUNDLE_DATA_STATUS_ERROR       = -1;
  const long BUNDLE_DATA_STATUS_DOWNLOADING = 0;
  const long BUNDLE_DATA_STATUS_SUCCESS     = 1;

  readonly attribute nsIDOMDocument bundleDataDocument;

  readonly attribute AString bundleDataText;

  readonly attribute AString bundleDataVersion;
  
  readonly attribute long bundleExtensionCount; 

  void removeExtension(in long aIndex);

  AString getExtensionAttribute(in long aIndex, in AString aAttributeName);

  boolean getExtensionInstallFlag(in long aIndex);
  
  void setExtensionInstallFlag(in long aIndex, in boolean aInstallFlag);
  
  void addBundleInstallListener(in sbIBundleInstallListener aListener);

  void removeBundleInstallListener(in sbIBundleInstallListener aListener);

  long installFlaggedExtensions(in nsIDOMWindow aWindow);
  const long BUNDLE_INSTALL_ERROR = 0;
  const long BUNDLE_INSTALL_SUCCESS = 1;

  readonly attribute boolean restartRequired;
};