Release 4.0.0-preview1-00201
[platform/core/csapi/tizenfx.git] / Artifacts / bin / platform / Tizen.Network.Mtp.xml
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Tizen.Network.Mtp</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Tizen.Network.Mtp.MtpDevice">\r
8             <summary>\r
9             A class for Mtp Device information. It allows applications to handle device information.\r
10             </summary>\r
11             <since_tizen> 5 </since_tizen>\r
12         </member>\r
13         <member name="P:Tizen.Network.Mtp.MtpDevice.ManufacturerName">\r
14             <summary>\r
15             Gets the manufacturer name of the device information.\r
16             </summary>\r
17             <value>Manufacture name of device.</value>\r
18             <since_tizen> 5 </since_tizen>\r
19         </member>\r
20         <member name="P:Tizen.Network.Mtp.MtpDevice.ModelName">\r
21             <summary>\r
22             Gets the model name of the device information.\r
23             </summary>\r
24             <value>Model name of device.</value>\r
25             <since_tizen> 5 </since_tizen>\r
26         </member>\r
27         <member name="P:Tizen.Network.Mtp.MtpDevice.SerialNumber">\r
28             <summary>\r
29             Gets the serial number of the device information.\r
30             </summary>\r
31             <value>Serial number of device.</value>\r
32             <since_tizen> 5 </since_tizen>\r
33         </member>\r
34         <member name="P:Tizen.Network.Mtp.MtpDevice.DeviceVersion">\r
35             <summary>\r
36             Gets the device version of the device information.\r
37             </summary>\r
38             <value>Version number of device.</value>\r
39             <since_tizen> 5 </since_tizen>\r
40         </member>\r
41         <member name="M:Tizen.Network.Mtp.MtpDevice.GetStorages">\r
42             <summary>\r
43             Gets the list of storages.\r
44             </summary>\r
45             <returns>List of storage objects.</returns>\r
46             <feature>http://tizen.org/feature/network.mtp</feature>\r
47             <exception cref="T:System.NotSupportedException">Thrown when Mtp is not supported.</exception>\r
48             <exception cref="T:System.InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>\r
49             <since_tizen> 5 </since_tizen>\r
50         </member>\r
51         <member name="T:Tizen.Network.Mtp.MtpStorageType">\r
52             <summary>\r
53             Enumeration for Mtp storage type.\r
54             </summary>\r
55             <since_tizen> 5 </since_tizen>\r
56         </member>\r
57         <member name="F:Tizen.Network.Mtp.MtpStorageType.Undefined">\r
58             <summary>\r
59             Undefined\r
60             </summary>\r
61         </member>\r
62         <member name="F:Tizen.Network.Mtp.MtpStorageType.FixedRom">\r
63             <summary>\r
64             fixed ROM\r
65             </summary>\r
66         </member>\r
67         <member name="F:Tizen.Network.Mtp.MtpStorageType.RemovableRom">\r
68             <summary>\r
69             removable ROM\r
70             </summary>\r
71         </member>\r
72         <member name="F:Tizen.Network.Mtp.MtpStorageType.FixedRam">\r
73             <summary>\r
74             fixed RAM\r
75             </summary>\r
76         </member>\r
77         <member name="F:Tizen.Network.Mtp.MtpStorageType.RemovableRam">\r
78             <summary>\r
79             removable RAM\r
80             </summary>\r
81         </member>\r
82         <member name="T:Tizen.Network.Mtp.MtpFileType">\r
83             <summary>\r
84             Enumeration for Mtp file type.\r
85             </summary>\r
86             <since_tizen> 5 </since_tizen>\r
87         </member>\r
88         <member name="F:Tizen.Network.Mtp.MtpFileType.Folder">\r
89             <summary> \r
90             Folder\r
91             </summary>\r
92         </member>\r
93         <member name="F:Tizen.Network.Mtp.MtpFileType.Wav">\r
94             <summary>\r
95             Wav\r
96             </summary>\r
97         </member>\r
98         <member name="F:Tizen.Network.Mtp.MtpFileType.Mp3">\r
99             <summary>\r
100             Mp3\r
101             </summary>\r
102         </member>\r
103         <member name="F:Tizen.Network.Mtp.MtpFileType.Wma">\r
104             <summary>\r
105             Wma\r
106             </summary>\r
107         </member>\r
108         <member name="F:Tizen.Network.Mtp.MtpFileType.Ogg">\r
109             <summary>\r
110             Ogg\r
111             </summary>\r
112         </member>\r
113         <member name="F:Tizen.Network.Mtp.MtpFileType.Audible">\r
114             <summary> \r
115             Audible\r
116             </summary>\r
117         </member>\r
118         <member name="F:Tizen.Network.Mtp.MtpFileType.Mp4">\r
119             <summary>\r
120             Mp4\r
121             </summary>\r
122         </member>\r
123         <member name="F:Tizen.Network.Mtp.MtpFileType.UndefAudio">\r
124             <summary>\r
125             UndefAudio\r
126             </summary>\r
127         </member>\r
128         <member name="F:Tizen.Network.Mtp.MtpFileType.Wmv">\r
129             <summary>\r
130             Wmv\r
131             </summary>\r
132         </member>\r
133         <member name="F:Tizen.Network.Mtp.MtpFileType.Avi">\r
134             <summary>\r
135             Avi\r
136             </summary>\r
137         </member>\r
138         <member name="F:Tizen.Network.Mtp.MtpFileType.Mpeg">\r
139             <summary> \r
140             Mpeg\r
141             </summary>\r
142         </member>\r
143         <member name="F:Tizen.Network.Mtp.MtpFileType.Asf">\r
144             <summary>\r
145             Asf\r
146             </summary>\r
147         </member>\r
148         <member name="F:Tizen.Network.Mtp.MtpFileType.Qt">\r
149             <summary>\r
150             Qt\r
151             </summary>\r
152         </member>\r
153         <member name="F:Tizen.Network.Mtp.MtpFileType.UndefVideo">\r
154             <summary>\r
155             UndefVideo\r
156             </summary>\r
157         </member>\r
158         <member name="F:Tizen.Network.Mtp.MtpFileType.Jpeg">\r
159             <summary>\r
160             Jpeg\r
161             </summary>\r
162         </member>\r
163         <member name="F:Tizen.Network.Mtp.MtpFileType.Jfif">\r
164             <summary> \r
165             Jfif\r
166             </summary>\r
167         </member>\r
168         <member name="F:Tizen.Network.Mtp.MtpFileType.Tiff">\r
169             <summary>\r
170             Tiff\r
171             </summary>\r
172         </member>\r
173         <member name="F:Tizen.Network.Mtp.MtpFileType.Bmp">\r
174             <summary>\r
175             Bmp\r
176             </summary>\r
177         </member>\r
178         <member name="F:Tizen.Network.Mtp.MtpFileType.Gif">\r
179             <summary>\r
180             Gif\r
181             </summary>\r
182         </member>\r
183         <member name="F:Tizen.Network.Mtp.MtpFileType.Pict">\r
184             <summary>\r
185             Pict\r
186             </summary>\r
187         </member>\r
188         <member name="F:Tizen.Network.Mtp.MtpFileType.Png">\r
189             <summary> \r
190             Png\r
191             </summary>\r
192         </member>\r
193         <member name="F:Tizen.Network.Mtp.MtpFileType.Vcalendar1">\r
194             <summary>\r
195             Vcalendar1\r
196             </summary>\r
197         </member>\r
198         <member name="F:Tizen.Network.Mtp.MtpFileType.Vcalendar2">\r
199             <summary>\r
200             Vcalendar2\r
201             </summary>\r
202         </member>\r
203         <member name="F:Tizen.Network.Mtp.MtpFileType.Vcard2">\r
204             <summary>\r
205             Vcard2\r
206             </summary>\r
207         </member>\r
208         <member name="F:Tizen.Network.Mtp.MtpFileType.Vcard3">\r
209             <summary>\r
210             Vcard3\r
211             </summary>\r
212         </member>\r
213         <member name="F:Tizen.Network.Mtp.MtpFileType.WindowsImageFormat">\r
214             <summary> \r
215             WindowsImageFormat\r
216             </summary>\r
217         </member>\r
218         <member name="F:Tizen.Network.Mtp.MtpFileType.WinExec">\r
219             <summary>\r
220             WinExec\r
221             </summary>\r
222         </member>\r
223         <member name="F:Tizen.Network.Mtp.MtpFileType.Text">\r
224             <summary>\r
225             Text\r
226             </summary>\r
227         </member>\r
228         <member name="F:Tizen.Network.Mtp.MtpFileType.Html">\r
229             <summary>\r
230             Html\r
231             </summary>\r
232         </member>\r
233         <member name="F:Tizen.Network.Mtp.MtpFileType.Firmware">\r
234             <summary>\r
235             Firmware\r
236             </summary>\r
237         </member>\r
238         <member name="F:Tizen.Network.Mtp.MtpFileType.Aac">\r
239             <summary> \r
240             Aac\r
241             </summary>\r
242         </member>\r
243         <member name="F:Tizen.Network.Mtp.MtpFileType.Mediacard">\r
244             <summary>\r
245             Mediacard\r
246             </summary>\r
247         </member>\r
248         <member name="F:Tizen.Network.Mtp.MtpFileType.Flac">\r
249             <summary>\r
250             Flac\r
251             </summary>\r
252         </member>\r
253         <member name="F:Tizen.Network.Mtp.MtpFileType.Mp2">\r
254             <summary>\r
255             Mp2\r
256             </summary>\r
257         </member>\r
258         <member name="F:Tizen.Network.Mtp.MtpFileType.M4a">\r
259             <summary>\r
260             M4a\r
261             </summary>\r
262         </member>\r
263         <member name="F:Tizen.Network.Mtp.MtpFileType.Doc">\r
264             <summary> \r
265             Doc\r
266             </summary>\r
267         </member>\r
268         <member name="F:Tizen.Network.Mtp.MtpFileType.Xml">\r
269             <summary>\r
270             Xml\r
271             </summary>\r
272         </member>\r
273         <member name="F:Tizen.Network.Mtp.MtpFileType.Xls">\r
274             <summary>\r
275             Xls\r
276             </summary>\r
277         </member>\r
278         <member name="F:Tizen.Network.Mtp.MtpFileType.Ppt">\r
279             <summary>\r
280             Ppt\r
281             </summary>\r
282         </member>\r
283         <member name="F:Tizen.Network.Mtp.MtpFileType.Mht">\r
284             <summary>\r
285             Mht\r
286             </summary>\r
287         </member>\r
288         <member name="F:Tizen.Network.Mtp.MtpFileType.Jp2">\r
289             <summary> \r
290             Jp2\r
291             </summary>\r
292         </member>\r
293         <member name="F:Tizen.Network.Mtp.MtpFileType.Jpx">\r
294             <summary>\r
295             Jpx\r
296             </summary>\r
297         </member>\r
298         <member name="F:Tizen.Network.Mtp.MtpFileType.Album">\r
299             <summary>\r
300             Album\r
301             </summary>\r
302         </member>\r
303         <member name="F:Tizen.Network.Mtp.MtpFileType.Playlist">\r
304             <summary>\r
305             Playlist\r
306             </summary>\r
307         </member>\r
308         <member name="F:Tizen.Network.Mtp.MtpFileType.Unknown">\r
309             <summary>\r
310             Unknown\r
311             </summary>\r
312         </member>\r
313         <member name="F:Tizen.Network.Mtp.MtpFileType.All">\r
314             <summary> \r
315             All (Helper type)\r
316             </summary>\r
317         </member>\r
318         <member name="F:Tizen.Network.Mtp.MtpFileType.AllImage">\r
319             <summary>\r
320             All Image (Helper type)\r
321             </summary>\r
322         </member>\r
323         <member name="T:Tizen.Network.Mtp.MtpEventType">\r
324             <summary>\r
325             Enumeration for Mtp Event type.\r
326             </summary>\r
327             <since_tizen> 5 </since_tizen>\r
328         </member>\r
329         <member name="F:Tizen.Network.Mtp.MtpEventType.Unknown">\r
330             <summary>\r
331             Unknown\r
332             </summary>\r
333         </member>\r
334         <member name="F:Tizen.Network.Mtp.MtpEventType.StorageAdded">\r
335             <summary>\r
336             Storage Added\r
337             </summary>\r
338         </member>\r
339         <member name="F:Tizen.Network.Mtp.MtpEventType.StorageRemoved">\r
340             <summary>\r
341             Storage Removed\r
342             </summary>\r
343         </member>\r
344         <member name="F:Tizen.Network.Mtp.MtpEventType.ObjectAdded">\r
345             <summary>\r
346             Object Added\r
347             </summary>\r
348         </member>\r
349         <member name="F:Tizen.Network.Mtp.MtpEventType.ObjectRemoved">\r
350             <summary>\r
351             Object Removed\r
352             </summary>\r
353         </member>\r
354         <member name="F:Tizen.Network.Mtp.MtpEventType.DeviceAdded">\r
355             <summary>\r
356             Device Added\r
357             </summary>\r
358         </member>\r
359         <member name="F:Tizen.Network.Mtp.MtpEventType.DeviceRemoved">\r
360             <summary>\r
361             Device Removed\r
362             </summary>\r
363         </member>\r
364         <member name="F:Tizen.Network.Mtp.MtpEventType.TurnedOff">\r
365             <summary>\r
366             Turned Off\r
367             </summary>\r
368         </member>\r
369         <member name="T:Tizen.Network.Mtp.MtpError">\r
370             <summary>\r
371             Enumeration for Mtp Error.\r
372             </summary>\r
373             <since_tizen> 5 </since_tizen>\r
374         </member>\r
375         <member name="T:Tizen.Network.Mtp.MtpStateChangedEventArgs">\r
376             <summary>\r
377             An extended EventArgs class which contains Mtp event.\r
378             </summary>\r
379             <since_tizen> 5 </since_tizen>\r
380         </member>\r
381         <member name="P:Tizen.Network.Mtp.MtpStateChangedEventArgs.Type">\r
382             <summary>\r
383             The Mtp event type.\r
384             </summary>\r
385             <since_tizen> 5 </since_tizen>\r
386         </member>\r
387         <member name="P:Tizen.Network.Mtp.MtpStateChangedEventArgs.EventParameter">\r
388             <summary>\r
389             The event parameter.\r
390             </summary>\r
391             <since_tizen> 5 </since_tizen>\r
392         </member>\r
393         <member name="T:Tizen.Network.Mtp.MtpManager">\r
394             <summary>\r
395             A class for MTP management. It allows applications to use MTP service.\r
396             </summary>\r
397             <remarks>\r
398             http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.\r
399             http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.\r
400             </remarks>\r
401             <since_tizen> 5 </since_tizen>\r
402         </member>\r
403         <member name="M:Tizen.Network.Mtp.MtpManager.GetDevices">\r
404             <summary>\r
405             Gets the list of MTP devices.\r
406             </summary>\r
407             <returns>List of MtpDevice objects.</returns>\r
408             <feature>http://tizen.org/feature/network.mtp</feature>\r
409             <exception cref="T:System.NotSupportedException">Thrown when Mtp is not supported.</exception>\r
410             <exception cref="T:System.InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>\r
411             <since_tizen> 5 </since_tizen>\r
412         </member>\r
413         <member name="E:Tizen.Network.Mtp.MtpManager.MtpStateChanged">\r
414             <summary>\r
415             MtpStateChanged is raised when the Mtp device state is changed.\r
416             </summary>\r
417             <since_tizen> 5 </since_tizen>\r
418         </member>\r
419         <member name="T:Tizen.Network.Mtp.MtpObject">\r
420             <summary>\r
421             A class for Mtp Object information. It allows applications to handle object information.\r
422             </summary>\r
423             <since_tizen> 5 </since_tizen>\r
424         </member>\r
425         <member name="P:Tizen.Network.Mtp.MtpObject.FileName">\r
426             <summary>\r
427             Gets the filename of the object information.\r
428             </summary>\r
429             <value>File name of object.</value>\r
430             <since_tizen> 5 </since_tizen>\r
431         </member>\r
432         <member name="P:Tizen.Network.Mtp.MtpObject.Keywords">\r
433             <summary>\r
434             Gets the keywords of the object information.\r
435             </summary>\r
436             <value>Keywords of object.</value>\r
437             <since_tizen> 5 </since_tizen>\r
438         </member>\r
439         <member name="P:Tizen.Network.Mtp.MtpObject.AssociationDescription">\r
440             <summary>\r
441             Gets the association description of the object information.\r
442             </summary>\r
443             <value>Association description of object.</value>\r
444             <since_tizen> 5 </since_tizen>\r
445         </member>\r
446         <member name="P:Tizen.Network.Mtp.MtpObject.AssociationType">\r
447             <summary>\r
448             Gets the association type of the object information.\r
449             </summary>\r
450             <value>Association type of object.</value>\r
451             <since_tizen> 5 </since_tizen>\r
452         </member>\r
453         <member name="P:Tizen.Network.Mtp.MtpObject.Size">\r
454             <summary>\r
455             Gets the size of the object information.\r
456             </summary>\r
457             <value>Size of object.</value>\r
458             <since_tizen> 5 </since_tizen>\r
459         </member>\r
460         <member name="P:Tizen.Network.Mtp.MtpObject.ParentObjectHandle">\r
461             <summary>\r
462             Gets the parent object handle of the object information.\r
463             </summary>\r
464             <value>Handle of Parent object.</value>\r
465             <since_tizen> 5 </since_tizen>\r
466         </member>\r
467         <member name="P:Tizen.Network.Mtp.MtpObject.Storage">\r
468             <summary>\r
469              Gets the mtp storage of the object information.\r
470             </summary>\r
471             <value>Storage of object.</value>\r
472             <since_tizen> 5 </since_tizen>\r
473         </member>\r
474         <member name="P:Tizen.Network.Mtp.MtpObject.DateCreated">\r
475             <summary>\r
476             Gets the object created time of the object information.\r
477             </summary>\r
478             <value>Date created of object.</value>\r
479             <since_tizen> 5 </since_tizen>\r
480         </member>\r
481         <member name="P:Tizen.Network.Mtp.MtpObject.DateModified">\r
482             <summary>\r
483             Gets the object modified time of the object information.\r
484             </summary>\r
485             <value>Date modified of object.</value>\r
486             <since_tizen> 5 </since_tizen>\r
487         </member>\r
488         <member name="P:Tizen.Network.Mtp.MtpObject.FileType">\r
489             <summary>\r
490             Gets the file type of the object information.\r
491             </summary>\r
492             <value>File type of object.</value>\r
493             <since_tizen> 5 </since_tizen>\r
494         </member>\r
495         <member name="P:Tizen.Network.Mtp.MtpObject.ImageBitDepth">\r
496             <summary>\r
497             Gets the image bit depth of the object information.\r
498             </summary>\r
499             <value>Bit depth of image.</value>\r
500             <since_tizen> 5 </since_tizen>\r
501         </member>\r
502         <member name="P:Tizen.Network.Mtp.MtpObject.ImagePixelWidth">\r
503             <summary>\r
504             Gets the image pixel width of the object information.\r
505             </summary>\r
506             <value>Pixel width of image.</value>\r
507             <since_tizen> 5 </since_tizen>\r
508         </member>\r
509         <member name="P:Tizen.Network.Mtp.MtpObject.ImagePixelHeight">\r
510             <summary>\r
511             Gets the image pixel height of the object information.\r
512             </summary>\r
513             <value>Pixel height of image.</value>\r
514             <since_tizen> 5 </since_tizen>\r
515         </member>\r
516         <member name="P:Tizen.Network.Mtp.MtpObject.ThumbnailSize">\r
517             <summary>\r
518             Gets the thumbnail size of the object information.\r
519             </summary>\r
520             <value>Size of thumbnail.</value>\r
521             <since_tizen> 5 </since_tizen>\r
522         </member>\r
523         <member name="P:Tizen.Network.Mtp.MtpObject.ThumbnailFileType">\r
524             <summary>\r
525             Gets the thumbnail file type of the object information.\r
526             </summary>\r
527             <value>File type of thumbnail.</value>\r
528             <since_tizen> 5 </since_tizen>\r
529         </member>\r
530         <member name="P:Tizen.Network.Mtp.MtpObject.ThumbnailPixelWidth">\r
531             <summary>\r
532             Gets the thumbnail pixel width of the object information.\r
533             </summary>\r
534             <value>Pixel width of thumbnail.</value>\r
535             <since_tizen> 5 </since_tizen>\r
536         </member>\r
537         <member name="P:Tizen.Network.Mtp.MtpObject.ThumbnailPixelHeight">\r
538             <summary>\r
539             Gets the thumbnail pixel height of the object information.\r
540             </summary>\r
541             <value>Pixel height of thumbnail.</value>\r
542             <since_tizen> 5 </since_tizen>\r
543         </member>\r
544         <member name="T:Tizen.Network.Mtp.MtpStorage">\r
545             <summary>\r
546             A class for Mtp Storage information. It allows applications to handle storage information.\r
547             </summary>\r
548             <since_tizen> 5 </since_tizen>\r
549         </member>\r
550         <member name="P:Tizen.Network.Mtp.MtpStorage.Description">\r
551             <summary>\r
552             Gets the description of the storage information.\r
553             </summary>\r
554             <value>Description of storage.</value>\r
555             <since_tizen> 5 </since_tizen>\r
556         </member>\r
557         <member name="P:Tizen.Network.Mtp.MtpStorage.FreeSpace">\r
558             <summary>\r
559             Gets the free space of the storage information in bytes.\r
560             </summary>\r
561             <value>Free space of storage(bytes).</value>\r
562             <since_tizen> 5 </since_tizen>\r
563         </member>\r
564         <member name="P:Tizen.Network.Mtp.MtpStorage.MaxCapacity">\r
565             <summary>\r
566             Gets the max capacity of the storage information in bytes.\r
567             </summary>\r
568             <value>Max capacity of storage(bytes).</value>\r
569             <since_tizen> 5 </since_tizen>\r
570         </member>\r
571         <member name="P:Tizen.Network.Mtp.MtpStorage.StorageType">\r
572             <summary>\r
573             Gets the storage type of the storage information.\r
574             </summary>\r
575             <value>Type of storage.</value>\r
576             <since_tizen> 5 </since_tizen>\r
577         </member>\r
578         <member name="P:Tizen.Network.Mtp.MtpStorage.VolumeIdentifier">\r
579             <summary>\r
580             Gets the volume identifier of the storage information.\r
581             </summary>\r
582             <value>Volume identifier of stroage.</value>\r
583             <since_tizen> 5 </since_tizen>\r
584         </member>\r
585         <member name="M:Tizen.Network.Mtp.MtpStorage.GetRootObject">\r
586             <summary>\r
587             Gets the root folder object.\r
588             </summary>\r
589             <returns>List of storage objects.</returns>\r
590             <feature>http://tizen.org/feature/network.mtp</feature>\r
591             <remarks>\r
592             http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.\r
593             http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.\r
594             </remarks>\r
595             <since_tizen> 5 </since_tizen>\r
596         </member>\r
597         <member name="M:Tizen.Network.Mtp.MtpStorage.GetObjectList(Tizen.Network.Mtp.MtpObject,Tizen.Network.Mtp.MtpFileType)">\r
598             <summary>\r
599             Gets the list of objects.\r
600             </summary>\r
601             <param name="parentHandle">The parent object handle. If parentHandle is 0, it means "root folder" of mtp storage.</param>\r
602             <param name="fileType">The file type what you want.</param>\r
603             <returns>List of objects.</returns>\r
604             <feature>http://tizen.org/feature/network.mtp</feature>\r
605             <remarks>\r
606             http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.\r
607             http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.\r
608             </remarks>\r
609             <exception cref="T:System.NotSupportedException">Thrown when Mtp is not supported.</exception>\r
610             <exception cref="T:System.ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>\r
611             <exception cref="T:System.InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>\r
612             <since_tizen> 5 </since_tizen>\r
613         </member>\r
614     </members>\r
615 </doc>\r