dom/base/nsIConsoleAPIStorage.idl@b8a032363ba2 (annotated)
dom/base/nsIConsoleAPIStorage.idl
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsISupports.idl" |
| michael@0 | 7 | |
| michael@0 | 8 | [scriptable, uuid(6701600a-17ca-417e-98f9-4ceb175dd15d)] |
| michael@0 | 9 | interface nsIConsoleAPIStorage : nsISupports |
| michael@0 | 10 | { |
| michael@0 | 11 | /** |
| michael@0 | 12 | * Get the events array by inner window ID or all events from all windows. |
| michael@0 | 13 | * |
| michael@0 | 14 | * @param string [aId] |
| michael@0 | 15 | * Optional, the inner window ID for which you want to get the array of |
| michael@0 | 16 | * cached events. |
| michael@0 | 17 | * @returns array |
| michael@0 | 18 | * The array of cached events for the given window. If no |aId| is |
| michael@0 | 19 | * given this function returns all of the cached events, from any |
| michael@0 | 20 | * window. |
| michael@0 | 21 | */ |
| michael@0 | 22 | jsval getEvents([optional] in DOMString aId); |
| michael@0 | 23 | |
| michael@0 | 24 | /** |
| michael@0 | 25 | * Record an event associated with the given window ID. |
| michael@0 | 26 | * |
| michael@0 | 27 | * @param string aId |
| michael@0 | 28 | * The ID of the inner window for which the event occurred or "jsm" for |
| michael@0 | 29 | * messages logged from JavaScript modules.. |
| michael@0 | 30 | * @param object aEvent |
| michael@0 | 31 | * A JavaScript object you want to store. |
| michael@0 | 32 | */ |
| michael@0 | 33 | void recordEvent(in DOMString aId, in jsval aEvent); |
| michael@0 | 34 | |
| michael@0 | 35 | /** |
| michael@0 | 36 | * Clear storage data for the given window. |
| michael@0 | 37 | * |
| michael@0 | 38 | * @param string [aId] |
| michael@0 | 39 | * Optional, the inner window ID for which you want to clear the |
| michael@0 | 40 | * messages. If this is not specified all of the cached messages are |
| michael@0 | 41 | * cleared, from all window objects. |
| michael@0 | 42 | */ |
| michael@0 | 43 | void clearEvents([optional] in DOMString aId); |
| michael@0 | 44 | }; |
