← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/netwerk/cookie/public/nsICookieConsent.idl

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/netwerk/cookie/public/nsICookieConsent.idl
 
1
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 
2
/* ***** BEGIN LICENSE BLOCK *****
 
3
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Netscape Public License
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/NPL/
 
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) 1998
 
20
 * the Initial Developer. All Rights Reserved.
 
21
 *
 
22
 * Contributor(s):
 
23
 *
 
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 NPL, 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 NPL, the GPL or the LGPL.
 
36
 *
 
37
 * ***** END LICENSE BLOCK ***** */
 
38
 
 
39
#include "nsISupports.idl"
 
40
#include "nsICookie.idl"
 
41
 
 
42
interface nsIURI;
 
43
interface nsIHttpChannel;
 
44
 
 
45
[scriptable,uuid(F5A34F50-1F39-11d6-A627-0010A401EB10)]
 
46
interface nsICookieConsent : nsISupports
 
47
{
 
48
  /**
 
49
   * getConsent
 
50
   *
 
51
   * gives a decision on what should be done with a cookie, based on a site's
 
52
   * p3p policy and the user's preferences. the policy for the given URI and
 
53
   * channel is also returned.
 
54
   *
 
55
   * @param uri
 
56
   *        the URI to find the policy for
 
57
   * @param httpChannel
 
58
   *        the channel to extract the p3p headers from
 
59
   * @param isForeign
 
60
   *        true if the cookie originates from a third-party site. this is used
 
61
   *        to decide the cookie status based on user preferences.
 
62
   * @param policy
 
63
   *        the policy for the given URI, or nsICookie::POLICY_UNKNOWN if one
 
64
   *        cannot be found. valid values are defined in nsICookie.idl.
 
65
   *
 
66
   * @return nsCookieStatus value. valid values are defined in nsICookie.idl.
 
67
   */
 
68
  nsCookieStatus getConsent(in  nsIURI         uri,
 
69
                            in  nsIHttpChannel httpChannel,
 
70
                            in  boolean        isForeign,
 
71
                            out nsCookiePolicy policy);
 
72
};  
 
73
 
 
74
%{C++
 
75
#define NS_COOKIECONSENT_CONTRACTID "@mozilla.org/cookie-consent;1"
 
76
%}