browser/components/feeds/public/nsIFeedResultService.idl@6474c204b198 (annotated)
browser/components/feeds/public/nsIFeedResultService.idl
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsISupports.idl" |
| michael@0 | 7 | interface nsIURI; |
| michael@0 | 8 | interface nsIRequest; |
| michael@0 | 9 | interface nsIFeedResult; |
| michael@0 | 10 | |
| michael@0 | 11 | /** |
| michael@0 | 12 | * nsIFeedResultService provides a globally-accessible object for retrieving |
| michael@0 | 13 | * the results of feed processing. |
| michael@0 | 14 | */ |
| michael@0 | 15 | [scriptable, uuid(950a829e-c20e-4dc3-b447-f8b753ae54da)] |
| michael@0 | 16 | interface nsIFeedResultService : nsISupports |
| michael@0 | 17 | { |
| michael@0 | 18 | /** |
| michael@0 | 19 | * When set to true, forces the preview page to be displayed, regardless |
| michael@0 | 20 | * of the user's preferences. |
| michael@0 | 21 | */ |
| michael@0 | 22 | attribute boolean forcePreviewPage; |
| michael@0 | 23 | |
| michael@0 | 24 | /** |
| michael@0 | 25 | * Adds a URI to the user's specified external feed handler, or live |
| michael@0 | 26 | * bookmarks. |
| michael@0 | 27 | * @param uri |
| michael@0 | 28 | * The uri of the feed to add. |
| michael@0 | 29 | * @param title |
| michael@0 | 30 | * The title of the feed to add. |
| michael@0 | 31 | * @param subtitle |
| michael@0 | 32 | * The subtitle of the feed to add. |
| michael@0 | 33 | * @param feedType |
| michael@0 | 34 | * The nsIFeed type of the feed. See nsIFeed.idl |
| michael@0 | 35 | */ |
| michael@0 | 36 | void addToClientReader(in AUTF8String uri, |
| michael@0 | 37 | in AString title, |
| michael@0 | 38 | in AString subtitle, |
| michael@0 | 39 | in unsigned long feedType); |
| michael@0 | 40 | |
| michael@0 | 41 | /** |
| michael@0 | 42 | * Registers a Feed Result object with a globally accessible service |
| michael@0 | 43 | * so that it can be accessed by a singleton method outside the usual |
| michael@0 | 44 | * flow of control in document loading. |
| michael@0 | 45 | * |
| michael@0 | 46 | * @param feedResult |
| michael@0 | 47 | * An object implementing nsIFeedResult representing the feed. |
| michael@0 | 48 | */ |
| michael@0 | 49 | void addFeedResult(in nsIFeedResult feedResult); |
| michael@0 | 50 | |
| michael@0 | 51 | /** |
| michael@0 | 52 | * Gets a Feed Handler object registered using addFeedResult. |
| michael@0 | 53 | * |
| michael@0 | 54 | * @param uri |
| michael@0 | 55 | * The URI of the feed a handler is being requested for |
| michael@0 | 56 | */ |
| michael@0 | 57 | nsIFeedResult getFeedResult(in nsIURI uri); |
| michael@0 | 58 | |
| michael@0 | 59 | /** |
| michael@0 | 60 | * Unregisters a Feed Handler object registered using addFeedResult. |
| michael@0 | 61 | * @param uri |
| michael@0 | 62 | * The feed URI the handler was registered under. This must be |
| michael@0 | 63 | * the same *instance* the feed was registered under. |
| michael@0 | 64 | */ |
| michael@0 | 65 | void removeFeedResult(in nsIURI uri); |
| michael@0 | 66 | }; |
