/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * vim: ft=cpp tw=78 sw=2 et ts=2 sts=2 cin
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

interface nsIPrincipal;

/**
 * Cookie settings for top-level documents.
 */
[builtinclass, uuid(3ec40331-7cf0-4b71-ba2a-2265aab8f6bc)]
interface nsICookieSettings : nsISupports
{
  /**
   * CookieBehavior at the loading of the document. Any other loadInfo
   * inherits it from its document's loadInfo. If there is not a document
   * involved, cookieBehavior is reject.
   */
  [infallible] readonly attribute unsigned long cookieBehavior;

  /**
   * Whether our cookie behavior mandates rejecting third-party trackers.
   */
  [infallible] readonly attribute boolean rejectThirdPartyTrackers;

  /**
   * CookiePermission at the loading of the document for a particular
   * principal. It returns the same cookiePermission also in case it changes
   * during the life-time of the top document.
   */
  unsigned long cookiePermission(in nsIPrincipal aPrincipal);
};