/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Netscape 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/NPL/
 *
 * 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 Mozilla Communicator client code.
 *
 * The Initial Developer of the Original Code is 
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2002
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 * John Keiser <jkeiser@netscape.com>
 *
 * 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 NPL, 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 NPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsIRoamingProtocol.idl"

interface nsIFile;

/**
 * File-based protocol for profile information.
 * Queries files for the nsIAsyncStreamedResource or nsIStreamedResource
 * interface (in that order) to get a filename to put the serialized resource
 * into the file.  (If the nsIFile in question is a file instead of a directory,
 * that is the file that is used to store any resource.)
 *
 * @see nsIStreamedResource
 */
[scriptable, uuid(4b437b85-494c-4484-bf6e-e0de6d33fbd7)]
interface nsIFileRoamingProtocol : nsIRoamingProtocol
{
  /** The file */
  attribute nsIFile file;
};

%{C++
#define NS_FILEROAMINGPROTOCOL_CONTRACTID "@mozilla.org/roaming/protocol/file;1"
#define NS_FILEROAMINGPROTOCOL_CID \
{ 0x4c689a17, 0x106f, 0x4f4f, \
  { 0x91, 0x8b, 0xc5, 0x82, 0x77, 0x4d, 0x1a, 0xa6 } }
#define NS_FILEROAMINGPROTOCOL_CLASSNAME "File Roaming Protocol"
%}

#endif