/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the Instantbird messenging client, released
 * 2007.
 *
 * The Initial Developer of the Original Code is
 * Florian QUEZE <florian@instantbird.org>.
 * Portions created by the Initial Developer are Copyright (C) 2007
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"
#include "nsISimpleEnumerator.idl"
#include "purpleIAccount.idl"

[scriptable, uuid(ab29ebe0-004d-4390-adcc-d54445f279c5)]
interface purpleIAccountsService: nsISupports {
  void InitAccounts();
  void unInitAccounts();

  purpleIAccount getAccountById(in AUTF8String aAccountId);

  /* will throw NS_ERROR_FAILURE if not found */
  purpleIAccount getAccountByNumericId(in PRUint32 aAccountId);

  nsISimpleEnumerator getAccounts();

  /* will fire the event account-added */
  purpleIAccount createAccount(in AUTF8String aName, in AUTF8String aPrpl);

  /* will fire the event account-removed */
  void deleteAccount(in AUTF8String aAccountId);

  /* account related event fired:
      - account-added: a new account has been created
      - account-removed: the account has been deleted
      - account-signin-on: a connection is being created for the account
         This is fired when a connection is created for connecting an account,
         but is also fired when a connection is created for registering an account.
      - account-connecting: the account is being connected
         This is not fired when registering an account
         This event is fired *after* account-signing-on
      - account-connected: the account is now connected
      - account-disconnecting: the account is being disconnected
      - account-disconnected: the account is now disconnected

      These events can be watched using an nsIObserver.
      The associated purpleIAccount will be given as a parameter.
  */
};
