/usr/share/idl/thunderbird-11.0.1/nsIMsgAsyncPrompter.idl is in thunderbird-dev 11.0.1+build1-0ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 | /* -*- 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 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 <bugzilla@standard8.plus.com>
* David Bienvenu <bienvenu@mozillamessaging.com>
*
* 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();
};
|