gecko/toolkit/components/alerts/nsIAlertsService.idl

118 lines
5.3 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Scott MacGregor <mscott@netscape.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
#include "nsIObserver.idl"
[scriptable, uuid(e177399e-2e31-4019-aed3-cba63ce9fa99)]
interface nsIAlertsService : nsISupports
{
/**
* Displays a sliding notification window.
*
* @param imageUrl A URL identifying the image to put in the alert.
* @param title The title for the alert.
* @param text The contents of the alert.
* @param textClickable If true, causes the alert text to look like a link
* and notifies the listener when user attempts to
* click the alert text.
* @param cookie A blind cookie the alert will pass back to the
* consumer during the alert listener callbacks.
* @param alertListener Used for callbacks. May be null if the caller
* doesn't care about callbacks.
* @param name The name of the notification. This is currently
* only used on OS X with Growl and Android.
* On OS X with Growl, users can disable notifications
* with a given name. On Android the name is hashed
* and used as a notification ID.
*
* @throws NS_ERROR_NOT_AVAILABLE If the notification cannot be displayed.
*
* The following arguments will be passed to the alertListener's observe()
* method:
* subject - null
* topic - "alertfinished" when the alert goes away
* "alertclickcallback" when the text is clicked
* data - the value of the cookie parameter passed to showAlertNotification.
*
* @note Depending on current circumstances (if the user's in a fullscreen
* application, for instance), the alert might not be displayed at all.
* In that case, if an alert listener is passed in it will receive the
* "alertfinished" notification immediately.
*/
void showAlertNotification(in AString imageUrl,
in AString title,
in AString text,
[optional] in boolean textClickable,
[optional] in AString cookie,
[optional] in nsIObserver alertListener,
[optional] in AString name);
};
[scriptable, uuid(df1bd4b0-3a8c-40e6-806a-203f38b0bd9f)]
interface nsIAlertsProgressListener : nsISupports
{
/**
* Called to notify the alert service that progress has occurred for the
* given notification previously displayed with showAlertNotification().
*
* @param name The name of the notification displaying the
* progress. On Android the name is hashed and used
* as a notification ID.
* @param progress Numeric value in the range 0 to progressMax
* indicating the current progress.
* @param progressMax Numeric value indicating the maximum progress.
* @param text The contents of the alert. If not provided,
* the percentage will be displayed.
*/
void onProgress(in AString name,
in long long progress,
in long long progressMax,
[optional] in AString text);
/**
* Called to cancel and hide the given notification previously displayed
* with showAlertNotification().
*
* @param name The name of the notification.
*/
void onCancel(in AString name);
};