dali/devel-api/adaptor-framework/web-engine-cookie-manager.h

   1 #ifndef DALI_WEB_ENGINE_COOKIE_MANAGER_H
   2 #define DALI_WEB_ENGINE_COOKIE_MANAGER_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22
  23 namespace Dali
  24 {
  25
  26 /**
  27  * @brief A class WebEngineCookieManager to wrap ewk cookie manager.
  28  */
  29 class WebEngineCookieManager
  30 {
  31
  32 public:
  33
  34   /**
  35    * @brief Enumeration for the cookies accept policies.
  36    */
  37   enum class CookieAcceptPolicy
  38   {
  39     ALWAYS,         ///< Accepts every cookie sent from any page.
  40     NEVER,          ///< Rejects all the cookies.
  41     NO_THIRD_PARTY, ///< Accepts only cookies set by the main document that is loaded.
  42   };
  43
  44   /**
  45    * @brief Enumeration for the cookie persistent storage type.
  46    */
  47   enum class CookiePersistentStorage
  48   {
  49     TEXT,   ///< Cookies are stored in a text file in the Mozilla "cookies.txt" format.
  50     SQLITE, ///< Cookies are stored in a SQLite file in the current Mozilla format.
  51   };
  52
  53   /**
  54    * @brief Constructor.
  55    */
  56   WebEngineCookieManager() = default;
  57
  58   /**
  59    * @brief Destructor.
  60    */
  61   virtual ~WebEngineCookieManager() = default;
  62
  63   /**
  64    * @brief Sets @a policy as the cookie acceptance policy for @a manager.
  65    * @details By default, only cookies set by the main document loaded are
  66    *          accepted.
  67    *
  68    * @param[in] policy A #Dali::WebEngineCookieManager::CookieAcceptPolicy
  69    */
  70   virtual void SetCookieAcceptPolicy( CookieAcceptPolicy policy ) = 0;
  71
  72   /**
  73    * @brief Gets the cookie acceptance policy.
  74    * The default is Toolkit::WebEngineCookieManager::CookieAcceptPolicy::NO_THIRD_PARTY.
  75    * @see Toolkit::WebEngineCookieManager::CookieAcceptPolicy::Type
  76    */
  77   virtual CookieAcceptPolicy GetCookieAcceptPolicy() const = 0;
  78
  79   /**
  80    * @brief Deletes all the cookies of @a manager.
  81    */
  82   virtual void ClearCookies() = 0;
  83
  84   /**
  85    * @brief Sets the @a path where non-session cookies are stored persistently using
  86    *        @a storage as the format to read/write the cookies.
  87    * @details Cookies are initially read from @a path/Cookies to create an initial
  88    *          set of cookies. Then, non-session cookies will be written to @a path/Cookies.
  89    *          By default, @a manager doesn't store the cookies persistently, so you need to
  90    *          call this method to keep cookies saved across sessions.
  91    *          If @a path does not exist it will be created.
  92    * @param[in] path The path where to read/write Cookies
  93    * @param[in] storage The type of storage
  94    */
  95   virtual void SetPersistentStorage( const std::string& path, CookiePersistentStorage storage ) = 0;
  96
  97 };
  98
  99 } // namespace Dali
 100
 101 #endif // DALI_WEB_ENGINE_COOKIE_MANAGER_H