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