toolkit/components/alerts/public/nsIAlertsService.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2002
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Scott MacGregor <mscott@netscape.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39
  40 #include "nsISupports.idl"
  41 #include "nsIObserver.idl"
  42
  43 [scriptable, uuid(e177399e-2e31-4019-aed3-cba63ce9fa99)]
  44 interface nsIAlertsService : nsISupports
  45 {
  46    /**
  47     * Displays a sliding notification window.
  48     *
  49     * @param imageUrl       A URL identifying the image to put in the alert.
  50     * @param title          The title for the alert.
  51     * @param text           The contents of the alert.
  52     * @param textClickable  If true, causes the alert text to look like a link
  53     *                       and notifies the listener when user attempts to
  54     *                       click the alert text.
  55     * @param cookie         A blind cookie the alert will pass back to the
  56     *                       consumer during the alert listener callbacks.
  57     * @param alertListener  Used for callbacks. May be null if the caller
  58     *                       doesn't care about callbacks.
  59     * @param name           The name of the notification.  This is currently
  60     *                       only used on OS X with Growl.  On OS X with Growl,
  61     *                       users can disable notifications with a given name.
  62     *
  63     * @throws NS_ERROR_NOT_AVAILABLE If the notification cannot be displayed.
  64     *
  65     * The following arguments will be passed to the alertListener's observe()
  66     * method:
  67     *   subject - null
  68     *   topic   - "alertfinished" when the alert goes away
  69     *             "alertclickcallback" when the text is clicked
  70     *   data    - the value of the cookie parameter passed to showAlertNotification.
  71     */
  72    void showAlertNotification(in AString  imageUrl,
  73                               in AString  title,
  74                               in AString  text,
  75                               [optional] in boolean textClickable,
  76                               [optional] in AString cookie,
  77                               [optional] in nsIObserver alertListener,
  78                               [optional] in AString name);
  79 };