netwerk/base/public/nsIAuthPromptCallback.idl@b8a032363ba2 (annotated)
netwerk/base/public/nsIAuthPromptCallback.idl
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 2 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 3 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 4 | |
| michael@0 | 5 | #include "nsISupports.idl" |
| michael@0 | 6 | |
| michael@0 | 7 | interface nsIAuthInformation; |
| michael@0 | 8 | |
| michael@0 | 9 | /** |
| michael@0 | 10 | * Interface for callback methods for the asynchronous nsIAuthPrompt2 method. |
| michael@0 | 11 | * Callers MUST call exactly one method if nsIAuthPrompt2::promptPasswordAsync |
| michael@0 | 12 | * returns successfully. They MUST NOT call any method on this interface before |
| michael@0 | 13 | * promptPasswordAsync returns. |
| michael@0 | 14 | */ |
| michael@0 | 15 | [scriptable, uuid(bdc387d7-2d29-4cac-92f1-dd75d786631d)] |
| michael@0 | 16 | interface nsIAuthPromptCallback : nsISupports |
| michael@0 | 17 | { |
| michael@0 | 18 | /** |
| michael@0 | 19 | * Authentication information is available. |
| michael@0 | 20 | * |
| michael@0 | 21 | * @param aContext |
| michael@0 | 22 | * The context as passed to promptPasswordAsync |
| michael@0 | 23 | * @param aAuthInfo |
| michael@0 | 24 | * Authentication information. Must be the same object that was passed |
| michael@0 | 25 | * to promptPasswordAsync. |
| michael@0 | 26 | * |
| michael@0 | 27 | * @note Any exceptions thrown from this method should be ignored. |
| michael@0 | 28 | */ |
| michael@0 | 29 | void onAuthAvailable(in nsISupports aContext, |
| michael@0 | 30 | in nsIAuthInformation aAuthInfo); |
| michael@0 | 31 | |
| michael@0 | 32 | /** |
| michael@0 | 33 | * Notification that the prompt was cancelled. |
| michael@0 | 34 | * |
| michael@0 | 35 | * @param aContext |
| michael@0 | 36 | * The context that was passed to promptPasswordAsync. |
| michael@0 | 37 | * @param userCancel |
| michael@0 | 38 | * If false, this prompt was cancelled by calling the |
| michael@0 | 39 | * the cancel method on the nsICancelable; otherwise, |
| michael@0 | 40 | * it was cancelled by the user. |
| michael@0 | 41 | */ |
| michael@0 | 42 | void onAuthCancelled(in nsISupports aContext, in boolean userCancel); |
| michael@0 | 43 | }; |
| michael@0 | 44 |
