mirror of
https://github.com/classilla/tenfourfox.git
synced 2024-11-19 18:38:36 +00:00
91 lines
3.3 KiB
Plaintext
91 lines
3.3 KiB
Plaintext
/* 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;
|
|
interface nsIMessageSender;
|
|
|
|
// Implemented by the contract id @mozilla.org/system-message-internal;1
|
|
|
|
[scriptable, uuid(59b6beda-f911-4d47-a296-8c81e6abcfb9)]
|
|
interface nsISystemMessagesInternal : nsISupports
|
|
{
|
|
/*
|
|
* Allow any internal user to send a message of a given type to a given page
|
|
* of an app. The message will be sent to all the registered pages of the app
|
|
* when |pageURI| is not specified.
|
|
* @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. Nullable.
|
|
* @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.
|
|
* returns a Promise
|
|
*/
|
|
nsISupports 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.
|
|
* returns a Promise
|
|
*/
|
|
nsISupports 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);
|
|
|
|
/*
|
|
* Refresh the system message cache in a content process.
|
|
* @param manifestURI The webapp's manifest URI.
|
|
*/
|
|
void refreshCache(in nsIMessageSender childMM, 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(31b78730-21c6-11e4-8c21-0800200c9a66)]
|
|
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;
|
|
|
|
/*
|
|
* A broadcast filter for a specific message type.
|
|
*
|
|
* @return Promise which resolves with |true| or |false| to indicate if
|
|
* we want to dispatch this message.
|
|
*/
|
|
jsval shouldDispatch(in DOMString manifestURL, in DOMString pageURL,
|
|
in DOMString type, in jsval message, [optional] in jsval extra);
|
|
};
|