diff -r 000000000000 -r 6474c204b198 dom/messages/interfaces/nsISystemMessagesInternal.idl --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dom/messages/interfaces/nsISystemMessagesInternal.idl Wed Dec 31 06:09:35 2014 +0100 @@ -0,0 +1,67 @@ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this file, + * You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#include "domstubs.idl" + +interface nsIURI; +interface nsIDOMWindow; + +// Implemented by the contract id @mozilla.org/system-message-internal;1 + +[scriptable, uuid(6296a314-2abf-4cd0-9097-5e81ee6832e2)] +interface nsISystemMessagesInternal : nsISupports +{ + /* + * Allow any internal user to broadcast a message of a given type. + * @param type The type of the message to be sent. + * @param message The message payload. + * @param pageURI The URI of the page that will be opened. + * @param manifestURI The webapp's manifest URI. + * @param extra Extra opaque information that will be passed around in the observer + * notification to open the page. + */ + void sendMessage(in DOMString type, in jsval message, in nsIURI pageURI, in nsIURI manifestURI, [optional] in jsval extra); + + /* + * Allow any internal user to broadcast a message of a given type. + * The application that registers the message will be launched. + * @param type The type of the message to be sent. + * @param message The message payload. + * @param extra Extra opaque information that will be passed around in the observer + * notification to open the page. + */ + void broadcastMessage(in DOMString type, in jsval message, [optional] in jsval extra); + + /* + * Registration of a page that wants to be notified of a message type. + * @param type The message type. + * @param pageURI The URI of the page that will be opened. + * @param manifestURI The webapp's manifest URI. + */ + void registerPage(in DOMString type, in nsIURI pageURI, in nsIURI manifestURI); +}; + +[scriptable, uuid(002f0e82-91f0-41de-ad43-569a2b9d12df)] +interface nsISystemMessagesWrapper: nsISupports +{ + /* + * Wrap a message and gives back any kind of object. + * @param message The json blob to wrap. + */ + jsval wrapMessage(in jsval message, in nsIDOMWindow window); +}; + +/* + * Implements an interface to allow specific message types to + * configure some behaviors + */ +[scriptable, uuid(a0e970f6-faa9-4605-89d6-fafae8b10a80)] +interface nsISystemMessagesConfigurator: nsISupports +{ + /* + * Will be true if this type of system messages assumes/requires + * that the app will be brought to the front always. + */ + readonly attribute boolean mustShowRunningApp; +};