Back to index

lightning-sunbird  0.9+nobinonly
nsIMetricsService.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* vim:set ts=2 sw=2 sts=2 et cindent: */
00003 /* ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is the Metrics extension.
00017  *
00018  * The Initial Developer of the Original Code is Google Inc.
00019  * Portions created by the Initial Developer are Copyright (C) 2006
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *  Darin Fisher <darin@meer.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 #include "nsISupports.idl"
00040 
00041 interface nsIPropertyBag;
00042 interface nsIDOMWindow;
00043 
00063 [scriptable, uuid(880b8655-15a4-4b72-b6d4-6e3325bca4b6)]
00064 interface nsIMetricsEventItem : nsISupports
00065 {
00069   readonly attribute DOMString itemNamespace;
00070 
00074   readonly attribute DOMString itemName;
00075 
00081   attribute nsIPropertyBag properties;
00082 
00086   nsIMetricsEventItem childAt(in long index);
00087 
00092   long indexOf(in nsIMetricsEventItem item);
00093 
00097   void appendChild(in nsIMetricsEventItem item);
00098 
00107   void insertChildAt(in nsIMetricsEventItem item, in long index);
00108 
00113   void removeChildAt(in long index);
00114 
00120   void replaceChildAt(in nsIMetricsEventItem newItem, in long index);
00121 
00125   void clearChildren();
00126 
00130   readonly attribute long childCount;
00131 };
00132 
00133 [scriptable, uuid(289cd0d3-00b4-4554-9e6d-71eded08d1d8)]
00134 interface nsIMetricsService : nsISupports
00135 {
00144   nsIMetricsEventItem createEventItem(in DOMString itemNamespace,
00145                                       in DOMString itemName);
00146 
00157   void logEvent(in nsIMetricsEventItem item);
00158 
00166   void logSimpleEvent(in DOMString eventNS, in DOMString event,
00167                       in nsIPropertyBag eventValues);
00168 
00172   void flush();
00173 
00178   void upload();
00179 
00185   void suspend();
00186 
00191   void resume();
00192 
00197   unsigned long getWindowID(in nsIDOMWindow window);
00198 };
00199 
00200 %{C++
00211 #define NS_METRICS_WEBNAVIGATION_DESTROY "metrics-webnavigation-destroy"
00212 #define NS_METRICS_CHROME_WEBNAVIGATION_DESTROY \
00213   "metrics-chrome-webnavigation-destroy"
00214 %}