[EFL][WK2] Rename async APIs for better consistency with EFL
[WebKit-https.git] / Source / WebKit2 / UIProcess / API / efl / ewk_application_cache_manager.h
1 /*
2  * Copyright (C) 2014 Samsung Electronics
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 /**
27  * @file    ewk_application_cache_manager.h
28  * @brief   Describes the Ewk Application Cache Manager API.
29  */
30
31 #ifndef ewk_application_cache_manager_h
32 #define ewk_application_cache_manager_h
33
34 #include "ewk_security_origin.h"
35 #include <Eina.h>
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 /** Creates a type name for Ewk_Application_Cache_Manager */
42 typedef struct EwkApplicationCacheManager Ewk_Application_Cache_Manager;
43
44 /**
45  * @typedef Ewk_Application_Cache_Origins_Async_Get_Cb Ewk_Application_Cache_Origins_Async_Get_Cb
46  * @brief Callback for ewk_application_cache_manager_origins_async_get
47  *
48  * @note The @a origins should be freed like below code after use.
49  *
50  * @code
51  *
52  * static void
53  * _origins_get_cb(Eina_List* origins, data)
54  * {
55  *    // ...
56  *
57  *    void *origin;
58  *    EINA_LIST_FREE(origins, origin)
59  *      ewk_object_unref((Ewk_Object*)origin);
60  * }
61  *
62  * @endcode
63  */
64 typedef void (*Ewk_Application_Cache_Origins_Async_Get_Cb)(Eina_List *origins, void *user_data);
65
66 /**
67  * Requests for getting web application cache origins.
68  *
69  * @param context context object
70  * @param result_callback callback to get web application cache origins
71  * @param user_data user_data will be passsed when result_callback is called
72  *
73  * @see Ewk_Application_Cache_Origins_Async_Get_Cb
74  */
75 EAPI void ewk_application_cache_manager_origins_async_get(const Ewk_Application_Cache_Manager *manager, Ewk_Application_Cache_Origins_Async_Get_Cb callback, void *data);
76
77 /**
78  * Requests for deleting all web application caches.
79  *
80  * @param context context object
81  *
82  * @return @c EINA_TRUE on successful request or @c EINA FALSE on failure
83  */
84 EAPI Eina_Bool ewk_application_cache_manager_delete_all(Ewk_Application_Cache_Manager *manager);
85
86 /**
87  * Requests for deleting web application cache for origin.
88  *
89  * @param context context object
90  * @param origin application cache origin
91  *
92  * @return @c EINA_TRUE on successful request or @c EINA_FALSE on failure
93  */
94 EAPI Eina_Bool ewk_application_cache_manager_delete(Ewk_Application_Cache_Manager *manager, Ewk_Security_Origin *origin);
95
96 #ifdef __cplusplus
97 }
98 #endif
99
100 #endif // ewk_application_cache_manager_h