Back to index

lightning-sunbird  0.9+nobinonly
nsIXmlRpcClient.idl
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is Mozilla XML-RPC Client component.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Digital Creations 2, Inc.
00018  * Portions created by the Initial Developer are Copyright (C) 2000
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   Martijn Pieters <mj@digicool.com> (original author)
00023  *   Samuel Sieb <samuel@sieb.net>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 /*
00040  *  XPCOM XML-RPC Client, interface definition.
00041  *  Version: $Revision: 1.6.28.1 $
00042  *
00043  *  $Id: nsIXmlRpcClient.idl,v 1.6.28.1 2006/08/06 22:30:02 samuel%sieb.net Exp $
00044  */
00045 
00046 #include "nsISupports.idl"
00047 #include "nsIURL.idl"
00048 #include "nsIXmlRpcClientListener.idl"
00049 
00050 // forward decl.
00051 interface nsIXmlRpcFault;
00052 
00056 [scriptable, uuid(4d7d15c0-3747-4f7f-b6b3-792a5ea1a9aa)]
00057 interface nsIXmlRpcClient: nsISupports {
00064     void init(in string serverURL);
00065 
00073     void setAuthentication(in string username, in string password);
00074 
00078     void clearAuthentication(in string username, in string password);
00079 
00086     void setEncoding(in string encoding);
00087 
00091     readonly attribute nsIURL serverURL;
00092 
00132     void asyncCall(in nsIXmlRpcClientListener listener, in nsISupports ctxt,
00133         in string methodName,
00134         [array, size_is(count)] in nsISupports arguments, in PRUint32 count);
00135 
00139     readonly attribute boolean inProgress;
00140     
00145     readonly attribute nsIXmlRpcFault fault;
00146 
00151     readonly attribute nsISupports result;
00152 
00157     readonly attribute unsigned long responseStatus;
00158     readonly attribute unsigned long responseString;
00159 
00171     void createType(in unsigned long type, out nsIIDRef uuid, 
00172         [iid_is(uuid),retval] out nsQIResult result);
00173     const unsigned long INT      = 1; // nsISupportsPRInt32
00174     const unsigned long BOOLEAN  = 2; // nsISupportsPRBool
00175     const unsigned long STRING   = 3; // nsISupportsCString
00176     const unsigned long DOUBLE   = 4; // nsISupportsDouble
00177     const unsigned long DATETIME = 5; // nsISupportsPRTime
00178     const unsigned long ARRAY    = 6; // nsISupportsArray
00179     const unsigned long STRUCT   = 7; // nsIDictionary
00180 };
00181 
00187 [scriptable, uuid(691cb864-0a7e-448c-98ee-4a7f359cf145)]
00188 interface nsIXmlRpcFault: nsISupports {
00189     readonly attribute PRInt32 faultCode;
00190     readonly attribute string faultString;
00191     
00192     void init(in PRInt32 faultCode, in string faultString);
00193 
00194     string toString();
00195 };
00196 
00197 // vim:sw=4:sr:sta:et:sts: