gecko-dev/modules/plugin/base/public/nsICookieStorage.idl

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * The contents of this file are subject to the Netscape 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/NPL/
 *
 * 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 mozilla.org code.
 *
 * The Initial Developer of the Original Code is Netscape
 * Communications Corporation.  Portions created by Netscape are
 * Copyright (C) 1998 Netscape Communications Corporation. All
 * Rights Reserved.
 *
 * Contributor(s): 
 */

////////////////////////////////////////////////////////////////////////////////
/**
 * <B>INTERFACE TO NETSCAPE COMMUNICATOR PLUGINS (NEW C++ API).</B>
 *
 * <P>This supersedes the old plugin API (npapi.h, npupp.h), and 
 * eliminates the need for glue files: npunix.c, npwin.cpp and npmac.cpp that
 * get linked with the plugin. You will however need to link with the "backward
 * adapter" (badapter.cpp) in order to allow your plugin to run in pre-5.0
 * browsers. 
 *
 * <P>See nsPlugin.idl for an overview of how this interface fits with the 
 * overall plugin architecture.
 */
////////////////////////////////////////////////////////////////////////////////

#include "nsISupports.idl"

/**
 * nsICookieStorage
 *
 * Level of API support: <b>BETA</B>
 * Subject to final review before 6/1/00.
 */
[scriptable, uuid(b0175bf6-2dd8-11d4-8cf4-0060b0fc14a3)]
interface nsICookieStorage : nsISupports
{
    /**
     * Retrieves a cookie from the browser's persistent cookie store.
     * @param cookieURL        URL string to look up cookie with.
     * @param cookieCount      on input, size of the cookie buffer, on output cookie's size.
     * @param cookies          array of cookie strings
     */
    void getCookie(in wstring cookieURL,
                   out unsigned long cookieCount,
                   [size_is(cookieCount)] out string cookies);

    /**
     * Stores a cookie in the browser's persistent cookie store.
     * @param cookieURL        URL string store cookie with.
     * @param cookieCount      specifies  size of cookie data.
     * @param cookieBuffer     array of cookie strings
     */
    void setCookie(in wstring cookieURL,
                   in unsigned long cookieCount,
                   [size_is(cookieCount)] in string cookies);
};