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  * @brief A class WebEngineCookieManager to wrap ewk cookie manager.
  27  */
  28 class WebEngineCookieManager
  29 {
  30 public:
  31   /**
  32    * @brief Enumeration for the cookies accept policies.
  33    */
  34   enum class CookieAcceptPolicy
  35   {
  36     ALWAYS,         ///< Accepts every cookie sent from any page.
  37     NEVER,          ///< Rejects all the cookies.
  38     NO_THIRD_PARTY, ///< Accepts only cookies set by the main document that is loaded.
  39   };
  40
  41   /**
  42    * @brief Enumeration for the cookie persistent storage type.
  43    */
  44   enum class CookiePersistentStorage
  45   {
  46     TEXT,   ///< Cookies are stored in a text file in the Mozilla "cookies.txt" format.
  47     SQLITE, ///< Cookies are stored in a SQLite file in the current Mozilla format.
  48   };
  49
  50   /**
  51    * @brief Constructor.
  52    */
  53   WebEngineCookieManager() = default;
  54
  55   /**
  56    * @brief Destructor.
  57    */
  58   virtual ~WebEngineCookieManager() = default;
  59
  60   /**
  61    * @brief Sets @a policy as the cookie acceptance policy for @a manager.
  62    * @details By default, only cookies set by the main document loaded are
  63    *          accepted.
  64    *
  65    * @param[in] policy A #Dali::WebEngineCookieManager::CookieAcceptPolicy
  66    */
  67   virtual void SetCookieAcceptPolicy(CookieAcceptPolicy policy) = 0;
  68
  69   /**
  70    * @brief Gets the cookie acceptance policy.
  71    * The default is Toolkit::WebEngineCookieManager::CookieAcceptPolicy::NO_THIRD_PARTY.
  72    * @see Toolkit::WebEngineCookieManager::CookieAcceptPolicy::Type
  73    */
  74   virtual CookieAcceptPolicy GetCookieAcceptPolicy() const = 0;
  75
  76   /**
  77    * @brief Deletes all the cookies of @a manager.
  78    */
  79   virtual void ClearCookies() = 0;
  80
  81   /**
  82    * @brief Sets the @a path where non-session cookies are stored persistently using
  83    *        @a storage as the format to read/write the cookies.
  84    * @details Cookies are initially read from @a path/Cookies to create an initial
  85    *          set of cookies. Then, non-session cookies will be written to @a path/Cookies.
  86    *          By default, @a manager doesn't store the cookies persistently, so you need to
  87    *          call this method to keep cookies saved across sessions.
  88    *          If @a path does not exist it will be created.
  89    * @param[in] path The path where to read/write Cookies
  90    * @param[in] storage The type of storage
  91    */
  92   virtual void SetPersistentStorage(const std::string& path, CookiePersistentStorage storage) = 0;
  93 };
  94
  95 } // namespace Dali
  96
  97 #endif // DALI_WEB_ENGINE_COOKIE_MANAGER_H