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