dali-toolkit/devel-api/controls/web-view/web-cookie-manager.h

   1 #ifndef DALI_TOOLKIT_WEB_COOKIE_MANAGER_H
   2 #define DALI_TOOLKIT_WEB_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 #include <dali/devel-api/adaptor-framework/web-engine-cookie-manager.h>
  23 #include <string>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  27
  28 namespace Dali
  29 {
  30 class WebEngineCookieManager;
  31
  32 namespace Toolkit
  33 {
  34 /**
  35  * @addtogroup dali_toolkit_controls_web_view
  36  * @{
  37  */
  38
  39 /**
  40  * @brief WebCookieManager is a control for settings of WebView.
  41  *
  42  *
  43  * For working WebCookieManager, a WebView should be provided.
  44  *
  45  */
  46 class DALI_TOOLKIT_API WebCookieManager
  47 {
  48 public:
  49   /**
  50    * @brief Creates a WebCookieManager.
  51    * @param[in] manager A #Dali::WebEngineCookieManager
  52    */
  53   WebCookieManager(Dali::WebEngineCookieManager& manager);
  54
  55   /**
  56    * @brief Destructor.
  57    */
  58   virtual ~WebCookieManager() final;
  59
  60   /**
  61    * @brief Sets @a policy as the cookie acceptance policy for @a manager.
  62    *
  63    * @details By default, only cookies set by the main document loaded are
  64    *          accepted.
  65    *
  66    * @param[in] policy A #Dali::WebEngineCookieManager::CookieAcceptPolicy
  67    */
  68   void SetCookieAcceptPolicy(Dali::WebEngineCookieManager::CookieAcceptPolicy policy);
  69
  70   /**
  71    * @brief Gets the cookie acceptance policy. The default is Toolkit::WebCookieManager::CookieAcceptPolicy::NO_THIRD_PARTY.
  72    * @see Dali::WebEngineCookieManager::CookieAcceptPolicy
  73    */
  74   Dali::WebEngineCookieManager::CookieAcceptPolicy GetCookieAcceptPolicy() const;
  75
  76   /**
  77    * @brief Deletes all the cookies of @a manager.
  78    */
  79   void ClearCookies();
  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    *
  85    * @details Cookies are initially read from @a path/Cookies to create an initial
  86    *          set of cookies. Then, non-session cookies will be written to @a path/Cookies.
  87    *          By default, @a manager doesn't store the cookies persistently, so you need to
  88    *          call this method to keep cookies saved across sessions.
  89    *          If @a path does not exist it will be created.
  90    *
  91    * @param[in] path The path where to read/write Cookies
  92    * @param[in] storage The type of storage
  93    */
  94   void SetPersistentStorage(const std::string& path, Dali::WebEngineCookieManager::CookiePersistentStorage storage);
  95
  96 private:
  97   Dali::WebEngineCookieManager& mWebEngineCookieManager;
  98 };
  99
 100 /**
 101  * @}
 102  */
 103
 104 } // namespace Toolkit
 105
 106 } // namespace Dali
 107
 108 #endif // DALI_TOOLKIT_WEB_COOKIE_MANAGER_H