Artifacts/bin/public/Tizen.System.Storage.xml

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Tizen.System.Storage</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="T:Tizen.System.DirectoryType">\r
   8             <summary>\r
   9             Enumeration for the DirectoryType storage.\r
  10             </summary>\r
  11             <since_tizen> 3 </since_tizen>\r
  12         </member>\r
  13         <member name="F:Tizen.System.DirectoryType.Images">\r
  14             <summary>\r
  15             Image directory.\r
  16             </summary>\r
  17             <since_tizen> 3 </since_tizen>\r
  18         </member>\r
  19         <member name="F:Tizen.System.DirectoryType.Sounds">\r
  20             <summary>\r
  21             Sounds directory.\r
  22             </summary>\r
  23             <since_tizen> 3 </since_tizen>\r
  24         </member>\r
  25         <member name="F:Tizen.System.DirectoryType.Videos">\r
  26             <summary>\r
  27             Videos directory.\r
  28             </summary>\r
  29             <since_tizen> 3 </since_tizen>\r
  30         </member>\r
  31         <member name="F:Tizen.System.DirectoryType.Camera">\r
  32             <summary>\r
  33             Camera directory.\r
  34             </summary>\r
  35             <since_tizen> 3 </since_tizen>\r
  36         </member>\r
  37         <member name="F:Tizen.System.DirectoryType.Downloads">\r
  38             <summary>\r
  39             Downloads directory.\r
  40             </summary>\r
  41             <since_tizen> 3 </since_tizen>\r
  42         </member>\r
  43         <member name="F:Tizen.System.DirectoryType.Music">\r
  44             <summary>\r
  45             Music directory.\r
  46             </summary>\r
  47             <since_tizen> 3 </since_tizen>\r
  48         </member>\r
  49         <member name="F:Tizen.System.DirectoryType.Documents">\r
  50             <summary>\r
  51             Documents directory.\r
  52             </summary>\r
  53             <since_tizen> 3 </since_tizen>\r
  54         </member>\r
  55         <member name="F:Tizen.System.DirectoryType.Others">\r
  56             <summary>\r
  57             Others directory.\r
  58             </summary>\r
  59             <since_tizen> 3 </since_tizen>\r
  60         </member>\r
  61         <member name="F:Tizen.System.DirectoryType.Ringtones">\r
  62             <summary>\r
  63             System ringtones directory is only available for an internal storage.\r
  64             </summary>\r
  65             <since_tizen> 3 </since_tizen>\r
  66         </member>\r
  67         <member name="T:Tizen.System.Storage">\r
  68             <summary>\r
  69             The class to access the storage device information.\r
  70             </summary>\r
  71         </member>\r
  72         <member name="E:Tizen.System.Storage.StorageStateChanged">\r
  73             <summary>\r
  74             StorageStateChanged event. This event is occurred when a storage state changes.\r
  75             </summary>\r
  76             <remarks>\r
  77             The storage state will be updated before calling the event handler.\r
  78             </remarks>\r
  79             <since_tizen> 3 </since_tizen>\r
  80             <example>\r
  81             <code>\r
  82             myStorage.StorageStateChanged += (s, e) =>\r
  83             {\r
  84                 var storage = s as Storage;\r
  85                 Console.WriteLine(string.Format("State Changed to {0}", storage.State));\r
  86             }\r
  87             </code>\r
  88             </example>\r
  89         </member>\r
  90         <member name="P:Tizen.System.Storage.Id">\r
  91             <summary>\r
  92             The storage ID.\r
  93             </summary>\r
  94             <since_tizen> 3 </since_tizen>\r
  95         </member>\r
  96         <member name="P:Tizen.System.Storage.StorageType">\r
  97             <summary>\r
  98             The type of storage.\r
  99             </summary>\r
 100             <since_tizen> 3 </since_tizen>\r
 101         </member>\r
 102         <member name="P:Tizen.System.Storage.RootDirectory">\r
 103             <summary>\r
 104             The root directory for the storage.\r
 105             </summary>\r
 106             <since_tizen> 3 </since_tizen>\r
 107         </member>\r
 108         <member name="P:Tizen.System.Storage.TotalSpace">\r
 109             <summary>\r
 110             The total storage size in bytes.\r
 111             </summary>\r
 112             <since_tizen> 3 </since_tizen>\r
 113         </member>\r
 114         <member name="P:Tizen.System.Storage.State">\r
 115             <summary>\r
 116             The StorageState.\r
 117             </summary>\r
 118             <since_tizen> 3 </since_tizen>\r
 119         </member>\r
 120         <member name="P:Tizen.System.Storage.AvaliableSpace">\r
 121             <summary>\r
 122             The available storage size in bytes.\r
 123             </summary>\r
 124             <since_tizen> 3 </since_tizen>\r
 125         </member>\r
 126         <member name="M:Tizen.System.Storage.GetAbsolutePath(Tizen.System.DirectoryType)">\r
 127             <summary>\r
 128             Absolute path for a given directory type in the storage.\r
 129             </summary>\r
 130             <remarks>\r
 131             The returned directory path may not exist, so you must make sure that it exists before using it.\r
 132             For accessing internal storage except the ringtones directory, the application should have http://tizen.org/privilege/mediastorage privilege.\r
 133             For accessing ringtones directory, the application should have http://tizen.org/privilege/systemsettings privilege.\r
 134             For accessing external storage, the application should have http://tizen.org/privilege/externalstorage privilege.\r
 135             </remarks>\r
 136             <since_tizen> 3 </since_tizen>\r
 137             <param name="dirType">Directory type.</param>\r
 138             <returns>Absolute path for a given directory type in the storage.</returns>\r
 139             <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>\r
 140             <exception cref="T:System.OutOfMemoryException">Thrown when failed due to out of memory exception.</exception>\r
 141             <exception cref="T:System.NotSupportedException">Thrown when failed if the storage is not supported or the application does not have the permission to access the directory path.</exception>\r
 142             <privilege>http://tizen.org/privilege/mediastorage</privilege>\r
 143             <privilege>http://tizen.org/privilege/systemsettings</privilege>\r
 144             <privilege>http://tizen.org/privilege/externalstorage</privilege>\r
 145             <example>\r
 146             <code>\r
 147             // To get the video directories for all the supported storage,\r
 148             var storageList = StorageManager.Storages as List&lt;Storage&gt;;\r
 149             foreach (var storage in storageList)\r
 150             {\r
 151                 string pathForVideoDir = storage.GetAbsolutePath(DirectoryType.Videos);\r
 152             }\r
 153             </code>\r
 154             </example>\r
 155         </member>\r
 156         <member name="T:Tizen.System.StorageArea">\r
 157             <summary>\r
 158             Enumeration for the storage area types.\r
 159             </summary>\r
 160             <since_tizen> 3 </since_tizen>\r
 161         </member>\r
 162         <member name="F:Tizen.System.StorageArea.Internal">\r
 163             <summary>\r
 164             Internal device storage (built-in storage in a device, non-removable).\r
 165             </summary>\r
 166             <since_tizen> 3 </since_tizen>\r
 167         </member>\r
 168         <member name="F:Tizen.System.StorageArea.External">\r
 169             <summary>\r
 170             External storage.\r
 171             </summary>\r
 172             <since_tizen> 3 </since_tizen>\r
 173         </member>\r
 174         <member name="T:Tizen.System.StorageManager">\r
 175             <summary>\r
 176             The StorageManager provides the properties or methods to access storage in the device.\r
 177             </summary>\r
 178         </member>\r
 179         <member name="P:Tizen.System.StorageManager.Storages">\r
 180             <summary>\r
 181             List of all storage in the device.\r
 182             </summary>\r
 183             <since_tizen> 3 </since_tizen>\r
 184         </member>\r
 185         <member name="T:Tizen.System.StorageState">\r
 186             <summary>\r
 187             Enumeration for the state of storage devices.\r
 188             </summary>\r
 189             <since_tizen> 3 </since_tizen>\r
 190         </member>\r
 191         <member name="F:Tizen.System.StorageState.Unmountable">\r
 192             <summary>\r
 193             The storage is present but cannot be mounted. Typically, it happens if the file system of the storage is corrupted.\r
 194             </summary>\r
 195             <since_tizen> 3 </since_tizen>\r
 196         </member>\r
 197         <member name="F:Tizen.System.StorageState.Removed">\r
 198             <summary>\r
 199             The storage is not present or removed.\r
 200             </summary>\r
 201             <since_tizen> 3 </since_tizen>\r
 202         </member>\r
 203         <member name="F:Tizen.System.StorageState.Mounted">\r
 204             <summary>\r
 205             The storage is mounted with read/write access.\r
 206             </summary>\r
 207             <since_tizen> 3 </since_tizen>\r
 208         </member>\r
 209         <member name="F:Tizen.System.StorageState.MountedReadOnly">\r
 210             <summary>\r
 211             The storage is mounted with read-only access.\r
 212             </summary>\r
 213             <since_tizen> 3 </since_tizen>\r
 214         </member>\r
 215     </members>\r
 216 </doc>\r