Release 4.0.0-preview1-00194
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.WebView.xml
1 <?xml version="1.0"?>
2 <doc>
3     <assembly>
4         <name>Tizen.WebView</name>
5     </assembly>
6     <members>
7         <member name="T:Tizen.WebView.Chromium">
8             <summary>
9             This class provides methods to initialize and shutdown Chromium-efl.
10             </summary>
11         </member>
12         <member name="M:Tizen.WebView.Chromium.Initialize">
13             <summary>
14             Initializes Chromium's instance.
15             </summary>
16             <returns>A reference count of Chromium's instance</returns>
17         </member>
18         <member name="M:Tizen.WebView.Chromium.Shutdown">
19             <summary>
20             Decreases a reference count of WebKit's instance, possibly destroying it.
21             </summary>
22             <returns>A reference count of Chromium's instance</returns>
23         </member>
24         <member name="T:Tizen.WebView.CacheModel">
25             <summary>
26             Enumeration that contains option for cache model.
27             </summary>
28         </member>
29         <member name="F:Tizen.WebView.CacheModel.DocumentViewer">
30             <summary>
31             Use the smallest cache capacity.
32             </summary>
33         </member>
34         <member name="F:Tizen.WebView.CacheModel.DocumentBrowser">
35             <summary>
36             Use bigger cache capacity than DocumentBrowser.
37             </summary>
38         </member>
39         <member name="F:Tizen.WebView.CacheModel.PrimaryWebBrowser">
40             <summary>
41             Use the biggest cache capacity.
42             </summary>
43         </member>
44         <member name="T:Tizen.WebView.Context">
45             <summary>
46             This class encapsulates all pages related to the specific use of Chromium-efl.
47             </summary>
48             <remarks>
49             Applications have the option of creating a context different from the default one and using it for a group of pages.
50             All pages in the same context share the same preferences, visited link set, local storage, and so on.
51             </remarks>
52         </member>
53         <member name="P:Tizen.WebView.Context.CacheModel">
54             <summary>
55             The cache model.
56             </summary>
57             <remarks>
58             The default cache model is DocumentViewer.
59             </remarks>
60         </member>
61         <member name="M:Tizen.WebView.Context.GetCookieManager">
62             <summary>
63             Gets the CookieManager object for this context.
64             </summary>
65             <returns>The CookieManager object</returns>
66         </member>
67         <member name="T:Tizen.WebView.CookieAcceptPolicy">
68             <summary>
69             Enumeration that contains accept policies for the cookies.
70             </summary>
71         </member>
72         <member name="F:Tizen.WebView.CookieAcceptPolicy.Always">
73             <summary>
74             Accepts every cookie sent from any page.
75             </summary>
76         </member>
77         <member name="F:Tizen.WebView.CookieAcceptPolicy.Never">
78             <summary>
79             Rejects all cookies.
80             </summary>
81         </member>
82         <member name="F:Tizen.WebView.CookieAcceptPolicy.NoThirdParty">
83             <summary>
84             Accepts only cookies set by the main document loaded.
85             </summary>
86         </member>
87         <member name="T:Tizen.WebView.CookiePersistentStorage">
88             <summary>
89             Enumeration that creates a type name for the storage of persistent cookies.
90             </summary>
91         </member>
92         <member name="F:Tizen.WebView.CookiePersistentStorage.Text">
93             <summary>
94             Cookies are stored in a text file in the Mozilla "cookies.txt" format.
95             </summary>
96         </member>
97         <member name="F:Tizen.WebView.CookiePersistentStorage.SqlLite">
98             <summary>
99             Cookies are stored in a SQLite file in the current Mozilla format.
100             </summary>
101         </member>
102         <member name="T:Tizen.WebView.CookieManager">
103             <summary>
104             This class provides methods for the cookie manager.
105             </summary>
106         </member>
107         <member name="M:Tizen.WebView.CookieManager.SetCookieAcceptPolicy(Tizen.WebView.CookieAcceptPolicy)">
108             <summary>
109             Sets the cookie acceptance policy.
110             </summary>
111             <remarks>
112             By default, only cookies set by the main document loaded are accepted.
113             </remarks>
114             <param name="policy">The cookie acceptance policy</param>
115         </member>
116         <member name="M:Tizen.WebView.CookieManager.ClearCookies">
117             <summary>
118             Deletes all the cookies.
119             </summary>
120         </member>
121         <member name="M:Tizen.WebView.CookieManager.SetPersistentStorage(System.String,Tizen.WebView.CookiePersistentStorage)">
122             <summary>
123             Sets the storage where non-session cookies are stored persistently to read/write the cookies.
124             </summary>
125             <privilege>http://tizen.org/privilege/mediastorage</privilege>
126             <privilege>http://tizen.org/privilege/externalstorage</privilege>
127             <param name="path">The path where to read/write Cookies</param>
128             <param name="storage">The type of storage</param>
129         </member>
130         <member name="T:Tizen.WebView.JavaScriptMessage">
131             <summary>
132             A Script message contains information that sent from JavaScript runtime.
133             </summary>
134         </member>
135         <member name="P:Tizen.WebView.JavaScriptMessage.Name">
136             <summary>
137             Obect name in JavaScript.
138             </summary>
139         </member>
140         <member name="M:Tizen.WebView.JavaScriptMessage.GetBodyAsInteger">
141             <summary>
142             Gets the value of body as integer type.
143             </summary>
144             <returns>The value of body as integer type</returns>
145         </member>
146         <member name="M:Tizen.WebView.JavaScriptMessage.GetBodyAsDouble">
147             <summary>
148             Gets the value of body as double type.
149             </summary>
150             <returns>The value of body as double type</returns>
151         </member>
152         <member name="M:Tizen.WebView.JavaScriptMessage.GetBodyAsBoolean">
153             <summary>
154             Gets the value of body as boolean type.
155             </summary>
156             <returns>The value of body as boolean type</returns>
157         </member>
158         <member name="M:Tizen.WebView.JavaScriptMessage.GetBodyAsString">
159             <summary>
160             Gets the value of body as string type.
161             </summary>
162             <returns>The value of body as string type</returns>
163         </member>
164         <member name="T:Tizen.WebView.Settings">
165             <summary>
166             This class provides properties for setting the preference of a specific WebView.
167             </summary>
168         </member>
169         <member name="P:Tizen.WebView.Settings.JavaScriptEnabled">
170             <summary>
171             Whether JavaScript can be executable.
172             </summary>
173         </member>
174         <member name="P:Tizen.WebView.Settings.LoadImageAutomatically">
175             <summary>
176             Whether images can be loaded automatically.
177             </summary>
178         </member>
179         <member name="P:Tizen.WebView.Settings.DefaultTextEncodingName">
180             <summary>
181             The default text encoding name.
182             </summary>
183         </member>
184         <member name="P:Tizen.WebView.Settings.DefaultFontSize">
185             <summary>
186             The default font size of a pixel.
187             </summary>
188         </member>
189         <member name="T:Tizen.WebView.SmartCallbackArgs">
190             <summary>
191             Argument from the SmartCallback.
192             </summary>
193         </member>
194         <member name="M:Tizen.WebView.SmartCallbackArgs.GetAsInteger">
195             <summary>
196             Gets argument as integer type.
197             </summary>
198             <returns>Argument as integer type</returns>
199         </member>
200         <member name="M:Tizen.WebView.SmartCallbackArgs.GetAsDouble">
201             <summary>
202             Gets argument as double type.
203             </summary>
204             <returns>Argument as double type</returns>
205         </member>
206         <member name="M:Tizen.WebView.SmartCallbackArgs.GetAsBoolean">
207             <summary>
208             Gets argument as boolean type.
209             </summary>
210             <returns>Argument as boolean type</returns>
211         </member>
212         <member name="M:Tizen.WebView.SmartCallbackArgs.GetAsString">
213             <summary>
214             Gets argument as string type.
215             </summary>
216             <returns>Argument as string type</returns>
217         </member>
218         <member name="T:Tizen.WebView.LoadErrorCode">
219             <summary>
220             Enumeration that provides an option to error codes.
221             </summary>
222         </member>
223         <member name="F:Tizen.WebView.LoadErrorCode.Unknown">
224             <summary>
225             Unknown
226             </summary>
227         </member>
228         <member name="F:Tizen.WebView.LoadErrorCode.Canceled">
229             <summary>
230             User canceled
231             </summary>
232         </member>
233         <member name="F:Tizen.WebView.LoadErrorCode.CantSupportMimetype">
234             <summary>
235             Can't show page for this MIME Type.
236             </summary>
237         </member>
238         <member name="F:Tizen.WebView.LoadErrorCode.FailedFileIo">
239             <summary>
240             File IO error
241             </summary>
242         </member>
243         <member name="F:Tizen.WebView.LoadErrorCode.CantConnect">
244             <summary>
245             Cannot connect to network.
246             </summary>
247         </member>
248         <member name="F:Tizen.WebView.LoadErrorCode.CantLookupHost">
249             <summary>
250             Fail to look up host from DNS.
251             </summary>
252         </member>
253         <member name="F:Tizen.WebView.LoadErrorCode.FailedTlsHandshake">
254             <summary>
255             Fail to SSL/TLS handshake.
256             </summary>
257         </member>
258         <member name="F:Tizen.WebView.LoadErrorCode.InvalidCertificate">
259             <summary>
260             Received certificate is invalid.
261             </summary>
262         </member>
263         <member name="F:Tizen.WebView.LoadErrorCode.RequestTimeout">
264             <summary>
265             Connection timeout
266             </summary>
267         </member>
268         <member name="F:Tizen.WebView.LoadErrorCode.TooManyRedirects">
269             <summary>
270             Too many redirects
271             </summary>
272         </member>
273         <member name="F:Tizen.WebView.LoadErrorCode.TooManyRequests">
274             <summary>
275             Too many requests during this load
276             </summary>
277         </member>
278         <member name="F:Tizen.WebView.LoadErrorCode.BadUrl">
279             <summary>
280             Malformed url
281             </summary>
282         </member>
283         <member name="F:Tizen.WebView.LoadErrorCode.UnsupportedScheme">
284             <summary>
285             Unsupported scheme
286             </summary>
287         </member>
288         <member name="F:Tizen.WebView.LoadErrorCode.Authentication">
289             <summary>
290             User authentication failed on server
291             </summary>
292         </member>
293         <member name="F:Tizen.WebView.LoadErrorCode.InternalServer">
294             <summary>
295             Web server has internal server error.
296             </summary>
297         </member>
298         <member name="T:Tizen.WebView.SmartCallbackLoadErrorArgs">
299             <summary>
300             Argument from the LoadError SmartCallback.
301             </summary>
302         </member>
303         <member name="P:Tizen.WebView.SmartCallbackLoadErrorArgs.Url">
304             <summary>
305             Failing URL for the error.
306             </summary>
307         </member>
308         <member name="P:Tizen.WebView.SmartCallbackLoadErrorArgs.Code">
309             <summary>
310             The error code.
311             </summary>
312         </member>
313         <member name="P:Tizen.WebView.SmartCallbackLoadErrorArgs.Description">
314             <summary>
315             The description for the error.
316             </summary>
317         </member>
318         <member name="P:Tizen.WebView.SmartCallbackLoadErrorArgs.Cancellation">
319             <summary>
320             Whether the error should be treated as a cancellation.
321             </summary>
322         </member>
323         <member name="T:Tizen.WebView.WebView">
324             <summary>
325             A view used to render web contents.
326             </summary>
327         </member>
328         <member name="E:Tizen.WebView.WebView.LoadStarted">
329             <summary>
330             Event that occurs when load started.
331             </summary>
332         </member>
333         <member name="E:Tizen.WebView.WebView.LoadFinished">
334             <summary>
335             Event that occurs when load finished.
336             </summary>
337         </member>
338         <member name="E:Tizen.WebView.WebView.LoadError">
339             <summary>
340             Event that occurs when load error.
341             </summary>
342         </member>
343         <member name="E:Tizen.WebView.WebView.TitleChanged">
344             <summary>
345             Event that occurs when title of main frame was changed.
346             </summary>
347         </member>
348         <member name="E:Tizen.WebView.WebView.UrlChanged">
349             <summary>
350             Event that occurs when URL of main frame was changed.
351             </summary>
352         </member>
353         <member name="P:Tizen.WebView.WebView.Url">
354             <summary>
355             Current URL of the main frame.
356             </summary>
357         </member>
358         <member name="P:Tizen.WebView.WebView.Title">
359             <summary>
360             Current title of the main frame.
361             </summary>
362         </member>
363         <member name="P:Tizen.WebView.WebView.UserAgent">
364             <summary>
365             Current user agent string of this view.
366             </summary>
367         </member>
368         <member name="P:Tizen.WebView.WebView.HasFocus">
369             <summary>
370             Whether a view has the focus.
371             </summary>
372         </member>
373         <member name="M:Tizen.WebView.WebView.#ctor(ElmSharp.EvasObject)">
374             <summary>
375             Create a WebView object.
376             </summary>
377             <param name="parent">Parent object of WebView</param>
378         </member>
379         <member name="M:Tizen.WebView.WebView.GetContext">
380             <summary>
381             Gets the Context object of this view.
382             </summary>
383             <returns>The Context object of this view</returns>
384         </member>
385         <member name="M:Tizen.WebView.WebView.GetSettings">
386             <summary>
387             Gets the Settings object of this view.
388             </summary>
389             <returns>The Settings object of this view</returns>
390         </member>
391         <member name="M:Tizen.WebView.WebView.LoadUrl(System.String)">
392             <summary>
393             Asks the object to load the given URL.
394             </summary>
395             <remarks>
396             You can only be sure that url changed after UrlChanged event.
397             </remarks>
398             <param name="url">The uniform resource identifier to load</param>
399         </member>
400         <member name="M:Tizen.WebView.WebView.LoadHtml(System.String,System.String)">
401             <summary>
402             Loads the specified html string as the content of the view.
403             </summary>
404             <param name="html">HTML data to load</param>
405             <param name="baseUrl">Base URL used for relative paths to external objects</param>
406         </member>
407         <member name="M:Tizen.WebView.WebView.StopLoading">
408             <summary>
409             Asks the main frame to stop loading.
410             </summary>
411         </member>
412         <member name="M:Tizen.WebView.WebView.Reload">
413             <summary>
414             Asks the main frame to reload the current document.
415             </summary>
416         </member>
417         <member name="M:Tizen.WebView.WebView.GoBack">
418             <summary>
419             Asks the main frame to navigate back in history.
420             </summary>
421         </member>
422         <member name="M:Tizen.WebView.WebView.GoForward">
423             <summary>
424             Asks the main frame to navigate forward in history.
425             </summary>
426         </member>
427         <member name="M:Tizen.WebView.WebView.CanGoBack">
428             <summary>
429             Checks whether it is possible to navigate backwards one item in history.
430             </summary>
431             <returns>Whether it is possible to navigate backwards one item in history</returns>
432         </member>
433         <member name="M:Tizen.WebView.WebView.CanGoForward">
434             <summary>
435             Checks whether it is possible to navigate forwards one item in history.
436             </summary>
437             <returns>Whether it is possible to navigate forwards one item in history</returns>
438         </member>
439         <member name="M:Tizen.WebView.WebView.AddJavaScriptMessageHandler(System.String,Tizen.WebView.JavaScriptMessageHandler)">
440             <summary>
441             Injects the supplied javascript message handler into the view.
442             </summary>
443             <param name="name"> The message callback</param>
444             <param name="handler">The name used to expose the object in JavaScript</param>
445             <returns>'true' on success, otherwise 'false'</returns>
446         </member>
447         <member name="M:Tizen.WebView.WebView.EvalWithResult(System.String,System.String)">
448             <summary>
449             Requests the execution of given name and result to the JavaScript runtime.
450             </summary>
451             <param name="name">The name used to expose the object in JavaScript</param>
452             <param name="result">The result to the JavaScript runtime</param>
453         </member>
454         <member name="M:Tizen.WebView.WebView.Eval(System.String)">
455             <summary>
456             Requests the execution of the given script.
457             </summary>
458             <param name="script">The JavaScript code string to execute</param>
459         </member>
460         <member name="M:Tizen.WebView.WebView.SetFocus(System.Boolean)">
461             <summary>
462             Requests to set or unset a view as the currently focused one.
463             </summary>
464             <param name="focused">'true' to set the focus on the view, 'false' to remove the focus from the view</param>
465         </member>
466     </members>
467 </doc>