author Richard Marti <>
Fri, 16 Sep 2011 23:02:07 +0200
changeset 9187 8809beb3c8dd3c2f55acdc16f40248f27c6c5920
parent 6724 1b341754e61ea5850cac47bd1c00c3a62f613bec
child 12286 84ac3c71109811da751f0ef2d72108075938f094
permissions -rw-r--r--
Bug 604757 - Attendee status icon is missing r=philipp

/* -*- 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
 * 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 Mailnews Async Prompter.
 * The Initial Developer of the Original Code is
 * the Mozilla Foundation.
 * Portions created by the Initial Developer are Copyright (C) 2009
 * the Initial Developer. All Rights Reserved.
 * Contributor(s):
 *   Mark Banner <>
 *   David Bienvenu <>
 * Alternatively, the contents of this file may be used under the terms of
 * either of 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"

interface nsIMsgAsyncPromptListener;

 * The nsIMsgAsyncPrompter is intended to provide a way to make asynchoronous
 * message prompts into synchronous ones - so that the user is only prompted
 * with one at a time.
[scriptable, uuid(15f67d0f-947a-4a1e-8f72-6ab7162b4b9c)]
interface nsIMsgAsyncPrompter : nsISupports {
   * Queues an async prompt request. If there are none queued then this will be
   * actioned straight away, otherwise the prompt will be queued for action
   * once previous prompt(s) have been cleared.
   * Queued prompts using the same aKey may be amalgamated into one prompt to
   * save repeated prompts to the user.
   * @param aKey    A key to determine whether or not the queued prompts can
   *                be combined.
   * @param aPromptImmediately If the user is retrying a failed password, we
   *                           need to prompt right away, even if there is a
   *                           prompt up, or prompts queued up. Note that
   *                           immediately may not be synchronously, on OS/X.
   * @param aCaller An nsIMsgAsyncPromptListener to call back to when the prompt
   *                is ready to be made.
  void queueAsyncAuthPrompt(in ACString aKey, in boolean aPromptImmediately,
                            in nsIMsgAsyncPromptListener aCaller);

 * This is used in combination with nsIMsgAsyncPrompter.
[scriptable, uuid(fb5307a3-39d0-462e-92c8-c5c288a2612f)]
interface nsIMsgAsyncPromptListener : nsISupports {
   * Called when the listener should do its prompt. The listener
   * should not return until the prompt is complete.
   * @return  True if there is auth information available following the prompt,
   *          false otherwise.
  boolean onPromptStart();

   * Called in the case that the queued prompt was combined with another and
   * there is now authentication information available.
  void onPromptAuthAvailable();

   * Called in the case that the queued prompt was combined with another but
   * the prompt was canceled.
  void onPromptCanceled();