| // Copyright (c) 2020 Marshall A. Greenblatt. All rights reserved. |
| // |
| // Redistribution and use in source and binary forms, with or without |
| // modification, are permitted provided that the following conditions are |
| // met: |
| // |
| // * Redistributions of source code must retain the above copyright |
| // notice, this list of conditions and the following disclaimer. |
| // * Redistributions in binary form must reproduce the above |
| // copyright notice, this list of conditions and the following disclaimer |
| // in the documentation and/or other materials provided with the |
| // distribution. |
| // * Neither the name of Google Inc. nor the name Chromium Embedded |
| // Framework nor the names of its contributors may be used to endorse |
| // or promote products derived from this software without specific prior |
| // written permission. |
| // |
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| // |
| // --------------------------------------------------------------------------- |
| // |
| // This file was generated by the CEF translator tool and should not edited |
| // by hand. See the translator.README.txt file in the tools directory for |
| // more information. |
| // |
| // $hash=2f5721138da26a9d7cce300a635b58dae9f51a4a$ |
| // |
| |
| #ifndef CEF_INCLUDE_CAPI_CEF_COOKIE_CAPI_H_ |
| #define CEF_INCLUDE_CAPI_CEF_COOKIE_CAPI_H_ |
| #pragma once |
| |
| #include "include/capi/cef_base_capi.h" |
| #include "include/capi/cef_callback_capi.h" |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| struct _cef_cookie_visitor_t; |
| struct _cef_delete_cookies_callback_t; |
| struct _cef_set_cookie_callback_t; |
| |
| /// |
| // Structure used for managing cookies. The functions of this structure may be |
| // called on any thread unless otherwise indicated. |
| /// |
| typedef struct _cef_cookie_manager_t { |
| /// |
| // Base structure. |
| /// |
| cef_base_ref_counted_t base; |
| |
| /// |
| // Set the schemes supported by this manager. If |include_defaults| is true |
| // (1) the default schemes ("http", "https", "ws" and "wss") will also be |
| // supported. Calling this function with an NULL |schemes| value and |
| // |include_defaults| set to false (0) will disable all loading and saving of |
| // cookies for this manager. If |callback| is non-NULL it will be executed |
| // asnychronously on the UI thread after the change has been applied. Must be |
| // called before any cookies are accessed. |
| /// |
| void(CEF_CALLBACK* set_supported_schemes)( |
| struct _cef_cookie_manager_t* self, |
| cef_string_list_t schemes, |
| int include_defaults, |
| struct _cef_completion_callback_t* callback); |
| |
| /// |
| // Visit all cookies on the UI thread. The returned cookies are ordered by |
| // longest path, then by earliest creation date. Returns false (0) if cookies |
| // cannot be accessed. |
| /// |
| int(CEF_CALLBACK* visit_all_cookies)(struct _cef_cookie_manager_t* self, |
| struct _cef_cookie_visitor_t* visitor); |
| |
| /// |
| // Visit a subset of cookies on the UI thread. The results are filtered by the |
| // given url scheme, host, domain and path. If |includeHttpOnly| is true (1) |
| // HTTP-only cookies will also be included in the results. The returned |
| // cookies are ordered by longest path, then by earliest creation date. |
| // Returns false (0) if cookies cannot be accessed. |
| /// |
| int(CEF_CALLBACK* visit_url_cookies)(struct _cef_cookie_manager_t* self, |
| const cef_string_t* url, |
| int includeHttpOnly, |
| struct _cef_cookie_visitor_t* visitor); |
| |
| /// |
| // Sets a cookie given a valid URL and explicit user-provided cookie |
| // attributes. This function expects each attribute to be well-formed. It will |
| // check for disallowed characters (e.g. the ';' character is disallowed |
| // within the cookie value attribute) and fail without setting the cookie if |
| // such characters are found. If |callback| is non-NULL it will be executed |
| // asnychronously on the UI thread after the cookie has been set. Returns |
| // false (0) if an invalid URL is specified or if cookies cannot be accessed. |
| /// |
| int(CEF_CALLBACK* set_cookie)(struct _cef_cookie_manager_t* self, |
| const cef_string_t* url, |
| const struct _cef_cookie_t* cookie, |
| struct _cef_set_cookie_callback_t* callback); |
| |
| /// |
| // Delete all cookies that match the specified parameters. If both |url| and |
| // |cookie_name| values are specified all host and domain cookies matching |
| // both will be deleted. If only |url| is specified all host cookies (but not |
| // domain cookies) irrespective of path will be deleted. If |url| is NULL all |
| // cookies for all hosts and domains will be deleted. If |callback| is non- |
| // NULL it will be executed asnychronously on the UI thread after the cookies |
| // have been deleted. Returns false (0) if a non-NULL invalid URL is specified |
| // or if cookies cannot be accessed. Cookies can alternately be deleted using |
| // the Visit*Cookies() functions. |
| /// |
| int(CEF_CALLBACK* delete_cookies)( |
| struct _cef_cookie_manager_t* self, |
| const cef_string_t* url, |
| const cef_string_t* cookie_name, |
| struct _cef_delete_cookies_callback_t* callback); |
| |
| /// |
| // Flush the backing store (if any) to disk. If |callback| is non-NULL it will |
| // be executed asnychronously on the UI thread after the flush is complete. |
| // Returns false (0) if cookies cannot be accessed. |
| /// |
| int(CEF_CALLBACK* flush_store)(struct _cef_cookie_manager_t* self, |
| struct _cef_completion_callback_t* callback); |
| } cef_cookie_manager_t; |
| |
| /// |
| // Returns the global cookie manager. By default data will be stored at |
| // CefSettings.cache_path if specified or in memory otherwise. If |callback| is |
| // non-NULL it will be executed asnychronously on the UI thread after the |
| // manager's storage has been initialized. Using this function is equivalent to |
| // calling cef_request_context_t::cef_request_context_get_global_context()->GetD |
| // efaultCookieManager(). |
| /// |
| CEF_EXPORT cef_cookie_manager_t* cef_cookie_manager_get_global_manager( |
| struct _cef_completion_callback_t* callback); |
| |
| /// |
| // Structure to implement for visiting cookie values. The functions of this |
| // structure will always be called on the UI thread. |
| /// |
| typedef struct _cef_cookie_visitor_t { |
| /// |
| // Base structure. |
| /// |
| cef_base_ref_counted_t base; |
| |
| /// |
| // Method that will be called once for each cookie. |count| is the 0-based |
| // index for the current cookie. |total| is the total number of cookies. Set |
| // |deleteCookie| to true (1) to delete the cookie currently being visited. |
| // Return false (0) to stop visiting cookies. This function may never be |
| // called if no cookies are found. |
| /// |
| int(CEF_CALLBACK* visit)(struct _cef_cookie_visitor_t* self, |
| const struct _cef_cookie_t* cookie, |
| int count, |
| int total, |
| int* deleteCookie); |
| } cef_cookie_visitor_t; |
| |
| /// |
| // Structure to implement to be notified of asynchronous completion via |
| // cef_cookie_manager_t::set_cookie(). |
| /// |
| typedef struct _cef_set_cookie_callback_t { |
| /// |
| // Base structure. |
| /// |
| cef_base_ref_counted_t base; |
| |
| /// |
| // Method that will be called upon completion. |success| will be true (1) if |
| // the cookie was set successfully. |
| /// |
| void(CEF_CALLBACK* on_complete)(struct _cef_set_cookie_callback_t* self, |
| int success); |
| } cef_set_cookie_callback_t; |
| |
| /// |
| // Structure to implement to be notified of asynchronous completion via |
| // cef_cookie_manager_t::delete_cookies(). |
| /// |
| typedef struct _cef_delete_cookies_callback_t { |
| /// |
| // Base structure. |
| /// |
| cef_base_ref_counted_t base; |
| |
| /// |
| // Method that will be called upon completion. |num_deleted| will be the |
| // number of cookies that were deleted. |
| /// |
| void(CEF_CALLBACK* on_complete)(struct _cef_delete_cookies_callback_t* self, |
| int num_deleted); |
| } cef_delete_cookies_callback_t; |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif // CEF_INCLUDE_CAPI_CEF_COOKIE_CAPI_H_ |