1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
<!--
SPDX-FileCopyrightText: The WebKit GTK and WPE teams
SPDX-License-Identifier: BSD, LGPL-2.1
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>WPEWebKit.UserContentFilterStore.save</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta priority="og:title" content="WPEWebKit.UserContentFilterStore.save"/>
<meta priority="og:description" content="Reference for WPEWebKit.UserContentFilterStore.save"/>
<meta name="twitter:title" content="WPEWebKit.UserContentFilterStore.save"/>
<meta name="twitter:description" content="Reference for WPEWebKit.UserContentFilterStore.save"/>
<meta name="twitter:card" content="summary"/>
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="wpe2-urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">WPEWebKit</a></h3>
<p>API Version: 2.0</p>
<p>Library Version: 2.50.5</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a href="class.UserContentFilterStore.html">UserContentFilterStore</a>
</div>
</div>
<div class="section">
<h5>Methods</h5>
<div class="links">
<a class="method" href="method.UserContentFilterStore.fetch_identifiers.html">fetch_identifiers</a>
<a class="method" href="method.UserContentFilterStore.fetch_identifiers_finish.html">fetch_identifiers_finish</a>
<a class="method" href="method.UserContentFilterStore.get_path.html">get_path</a>
<a class="method" href="method.UserContentFilterStore.load.html">load</a>
<a class="method" href="method.UserContentFilterStore.load_finish.html">load_finish</a>
<a class="method" href="method.UserContentFilterStore.remove.html">remove</a>
<a class="method" href="method.UserContentFilterStore.remove_finish.html">remove_finish</a>
<a class="method current" href="method.UserContentFilterStore.save.html">save</a>
<a class="method" href="method.UserContentFilterStore.save_finish.html">save_finish</a>
<a class="method" href="method.UserContentFilterStore.save_from_file.html">save_from_file</a>
<a class="method" href="method.UserContentFilterStore.save_from_file_finish.html">save_from_file_finish</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Method</h3>
<h1><a href="index.html">WPEWebKit</a><span class="sep"></span><a href="class.UserContentFilterStore.html">UserContentFilterStore</a><span class="sep"></span>save</h1>
</header>
<section>
<div class="docblock">
<p><span class="emblem available">since: 2.24</span></p>
</div>
<div class="declaration toggle-wrapper">
<h4 style="display:flex;" id="declaration">
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/WebKit/WebKit/tree/main/WebKitBuild/WPE/Release/DerivedSources/WebKit/wpe/WebKitUserContentFilterStore.h#L51">[src]</a>
</h4>
<div class="docblock c-decl">
<pre><code><div class="highlight"><pre><span></span><span class="kt">void</span>
<span class="n">webkit_user_content_filter_store_save</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">WebKitUserContentFilterStore</span><span class="o">*</span><span class="w"> </span><span class="n">store</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">gchar</span><span class="o">*</span><span class="w"> </span><span class="n">identifier</span><span class="p">,</span>
<span class="w"> </span><span class="n">GBytes</span><span class="o">*</span><span class="w"> </span><span class="n">source</span><span class="p">,</span>
<span class="w"> </span><span class="n">GCancellable</span><span class="o">*</span><span class="w"> </span><span class="n">cancellable</span><span class="p">,</span>
<span class="w"> </span><span class="n">GAsyncReadyCallback</span><span class="w"> </span><span class="n">callback</span><span class="p">,</span>
<span class="w"> </span><span class="n">gpointer</span><span class="w"> </span><span class="n">user_data</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 style="display:flex;" id="description">
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/WebKit/WebKit/tree/main/Source/WebKit/UIProcess/API/glib/WebKitUserContentFilterStore.cpp#L211">[src]</a>
</h4>
<div class="docblock">
<p>Asynchronously save a content filter from a set source rule.</p>
<p>Asynchronously save a content filter from a source rule set in the
<a href="https://webkit.org/blog/3476/content-blockers-first-look/">WebKit content extesions <span class="caps">JSON</span> format</a>.</p>
<p>The <code>identifier</code> can be used afterwards to refer to the filter when using
<code>webkit_user_content_filter_store_remove()</code> and webkit_user_content_filter_store_load().
When the <code>identifier</code> has been used in the past, the new filter source will replace
the one saved beforehand for the same identifier.</p>
<p>When the operation is finished, <code>callback</code> will be invoked, which then can use
<code>webkit_user_content_filter_store_save_finish()</code> to obtain the resulting filter.</p>
</div>
<div class="docblock">
<p>Available since: 2.24</p>
</div>
</div>
<div class="parameters toggle-wrapper">
<h4 id="parameters">
Parameters
<a href="#parameters" class="anchor"></a>
</h4>
<div class="docblock">
<dl class="arguments">
<dt class="arg-name"><code>identifier</code></dt>
<dd class="arg-description">
<p><em>Type:</em> <code>const gchar*</code></p>
<p><p>A string used to identify the saved filter.</p></p>
<table>
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
<tr><td>The value is a NUL terminated UTF-8 string.</td></tr>
</table>
</dd>
<dt class="arg-name"><code>source</code></dt>
<dd class="arg-description">
<p><em>Type:</em> <a href="javascript:void(0)" data-link="struct.Bytes.html" data-namespace="GLib" class="external"><code>GBytes</code></a></p>
<p><p><code>GBytes</code> containing the rule set in <span class="caps">JSON</span> format.</p></p>
<table>
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
</table>
</dd>
<dt class="arg-name"><code>cancellable</code></dt>
<dd class="arg-description">
<p><em>Type:</em> <a href="javascript:void(0)" data-link="class.Cancellable.html" data-namespace="Gio" class="external"><code>GCancellable</code></a></p>
<p><p>A <code>GCancellable</code> or <code>NULL</code> to ignore.</p></p>
<table>
<tr><td>The argument can be <code>NULL</code>.</td></tr>
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
</table>
</dd>
<dt class="arg-name"><code>callback</code></dt>
<dd class="arg-description">
<p><em>Type:</em> <a href="javascript:void(0)" data-link="callback.AsyncReadyCallback.html" data-namespace="Gio" class="external"><code>GAsyncReadyCallback</code></a></p>
<p><p>A <code>GAsyncReadyCallback</code> to call when saving is completed.</p></p>
<table>
<tr><td>The argument can be <code>NULL</code>.</td></tr>
</table>
</dd>
<dt class="arg-name"><code>user_data</code></dt>
<dd class="arg-description">
<p><em>Type:</em> <code>gpointer</code></p>
<p><p>The data to pass to the callback function.</p></p>
<table>
<tr><td>The argument can be <code>NULL</code>.</td></tr>
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>
|
