Release 4.0.0-preview1-00201
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.System.Storage.xml
index 92e75d7..d08cda8 100644 (file)
-<?xml version="1.0"?>
-<doc>
-    <assembly>
-        <name>Tizen.System.Storage</name>
-    </assembly>
-    <members>
-        <member name="T:Tizen.System.DirectoryType">
-            <summary>
-            Enumeration for the DirectoryType storage.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.System.DirectoryType.Images">
-            <summary>
-            Image directory.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.System.DirectoryType.Sounds">
-            <summary>
-            Sounds directory.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.System.DirectoryType.Videos">
-            <summary>
-            Videos directory.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.System.DirectoryType.Camera">
-            <summary>
-            Camera directory.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.System.DirectoryType.Downloads">
-            <summary>
-            Downloads directory.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.System.DirectoryType.Music">
-            <summary>
-            Music directory.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.System.DirectoryType.Documents">
-            <summary>
-            Documents directory.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.System.DirectoryType.Others">
-            <summary>
-            Others directory.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.System.DirectoryType.Ringtones">
-            <summary>
-            System ringtones directory is only available for an internal storage.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="T:Tizen.System.Storage">
-            <summary>
-            The class to access the storage device information.
-            </summary>
-        </member>
-        <member name="E:Tizen.System.Storage.StorageStateChanged">
-            <summary>
-            StorageStateChanged event. This event is occurred when a storage state changes.
-            </summary>
-            <remarks>
-            The storage state will be updated before calling the event handler.
-            </remarks>
-            <since_tizen> 3 </since_tizen>
-            <example>
-            <code>
-            myStorage.StorageStateChanged += (s, e) =>
-            {
-                var storage = s as Storage;
-                Console.WriteLine(string.Format("State Changed to {0}", storage.State));
-            }
-            </code>
-            </example>
-        </member>
-        <member name="P:Tizen.System.Storage.Id">
-            <summary>
-            The storage ID.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="P:Tizen.System.Storage.StorageType">
-            <summary>
-            The type of storage.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="P:Tizen.System.Storage.RootDirectory">
-            <summary>
-            The root directory for the storage.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="P:Tizen.System.Storage.TotalSpace">
-            <summary>
-            The total storage size in bytes.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="P:Tizen.System.Storage.State">
-            <summary>
-            The StorageState.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="P:Tizen.System.Storage.AvaliableSpace">
-            <summary>
-            The available storage size in bytes.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="M:Tizen.System.Storage.GetAbsolutePath(Tizen.System.DirectoryType)">
-            <summary>
-            Absolute path for a given directory type in the storage.
-            </summary>
-            <remarks>
-            The returned directory path may not exist, so you must make sure that it exists before using it.
-            For accessing internal storage except the ringtones directory, the application should have http://tizen.org/privilege/mediastorage privilege.
-            For accessing ringtones directory, the application should have http://tizen.org/privilege/systemsettings privilege.
-            For accessing external storage, the application should have http://tizen.org/privilege/externalstorage privilege.
-            </remarks>
-            <since_tizen> 3 </since_tizen>
-            <param name="dirType">Directory type.</param>
-            <returns>Absolute path for a given directory type in the storage.</returns>
-            <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>
-            <exception cref="T:System.OutOfMemoryException">Thrown when failed due to out of memory exception.</exception>
-            <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>
-            <privilege>http://tizen.org/privilege/mediastorage</privilege>
-            <privilege>http://tizen.org/privilege/systemsettings</privilege>
-            <privilege>http://tizen.org/privilege/externalstorage</privilege>
-            <example>
-            <code>
-            // To get the video directories for all the supported storage,
-            var storageList = StorageManager.Storages as List&lt;Storage&gt;;
-            foreach (var storage in storageList)
-            {
-                string pathForVideoDir = storage.GetAbsolutePath(DirectoryType.Videos);
-            }
-            </code>
-            </example>
-        </member>
-        <member name="T:Tizen.System.StorageArea">
-            <summary>
-            Enumeration for the storage area types.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.System.StorageArea.Internal">
-            <summary>
-            Internal device storage (built-in storage in a device, non-removable).
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.System.StorageArea.External">
-            <summary>
-            External storage.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="T:Tizen.System.StorageManager">
-            <summary>
-            The StorageManager provides the properties or methods to access storage in the device.
-            </summary>
-        </member>
-        <member name="P:Tizen.System.StorageManager.Storages">
-            <summary>
-            List of all storage in the device.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="T:Tizen.System.StorageState">
-            <summary>
-            Enumeration for the state of storage devices.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.System.StorageState.Unmountable">
-            <summary>
-            The storage is present but cannot be mounted. Typically, it happens if the file system of the storage is corrupted.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.System.StorageState.Removed">
-            <summary>
-            The storage is not present or removed.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.System.StorageState.Mounted">
-            <summary>
-            The storage is mounted with read/write access.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.System.StorageState.MountedReadOnly">
-            <summary>
-            The storage is mounted with read-only access.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-    </members>
-</doc>
+<?xml version="1.0"?>\r
+<doc>\r
+    <assembly>\r
+        <name>Tizen.System.Storage</name>\r
+    </assembly>\r
+    <members>\r
+        <member name="T:Tizen.System.DirectoryType">\r
+            <summary>\r
+            Enumeration for the DirectoryType storage.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.System.DirectoryType.Images">\r
+            <summary>\r
+            Image directory.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.System.DirectoryType.Sounds">\r
+            <summary>\r
+            Sounds directory.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.System.DirectoryType.Videos">\r
+            <summary>\r
+            Videos directory.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.System.DirectoryType.Camera">\r
+            <summary>\r
+            Camera directory.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.System.DirectoryType.Downloads">\r
+            <summary>\r
+            Downloads directory.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.System.DirectoryType.Music">\r
+            <summary>\r
+            Music directory.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.System.DirectoryType.Documents">\r
+            <summary>\r
+            Documents directory.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.System.DirectoryType.Others">\r
+            <summary>\r
+            Others directory.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.System.DirectoryType.Ringtones">\r
+            <summary>\r
+            System ringtones directory is only available for an internal storage.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="T:Tizen.System.Storage">\r
+            <summary>\r
+            The class to access the storage device information.\r
+            </summary>\r
+        </member>\r
+        <member name="E:Tizen.System.Storage.StorageStateChanged">\r
+            <summary>\r
+            StorageStateChanged event. This event is occurred when a storage state changes.\r
+            </summary>\r
+            <remarks>\r
+            The storage state will be updated before calling the event handler.\r
+            </remarks>\r
+            <since_tizen> 3 </since_tizen>\r
+            <example>\r
+            <code>\r
+            myStorage.StorageStateChanged += (s, e) =>\r
+            {\r
+                var storage = s as Storage;\r
+                Console.WriteLine(string.Format("State Changed to {0}", storage.State));\r
+            }\r
+            </code>\r
+            </example>\r
+        </member>\r
+        <member name="P:Tizen.System.Storage.Id">\r
+            <summary>\r
+            The storage ID.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="P:Tizen.System.Storage.StorageType">\r
+            <summary>\r
+            The type of storage.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="P:Tizen.System.Storage.RootDirectory">\r
+            <summary>\r
+            The root directory for the storage.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="P:Tizen.System.Storage.TotalSpace">\r
+            <summary>\r
+            The total storage size in bytes.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="P:Tizen.System.Storage.State">\r
+            <summary>\r
+            The StorageState.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="P:Tizen.System.Storage.AvaliableSpace">\r
+            <summary>\r
+            The available storage size in bytes.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="M:Tizen.System.Storage.GetAbsolutePath(Tizen.System.DirectoryType)">\r
+            <summary>\r
+            Absolute path for a given directory type in the storage.\r
+            </summary>\r
+            <remarks>\r
+            The returned directory path may not exist, so you must make sure that it exists before using it.\r
+            For accessing internal storage except the ringtones directory, the application should have http://tizen.org/privilege/mediastorage privilege.\r
+            For accessing ringtones directory, the application should have http://tizen.org/privilege/systemsettings privilege.\r
+            For accessing external storage, the application should have http://tizen.org/privilege/externalstorage privilege.\r
+            </remarks>\r
+            <since_tizen> 3 </since_tizen>\r
+            <param name="dirType">Directory type.</param>\r
+            <returns>Absolute path for a given directory type in the storage.</returns>\r
+            <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>\r
+            <exception cref="T:System.OutOfMemoryException">Thrown when failed due to out of memory exception.</exception>\r
+            <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
+            <privilege>http://tizen.org/privilege/mediastorage</privilege>\r
+            <privilege>http://tizen.org/privilege/systemsettings</privilege>\r
+            <privilege>http://tizen.org/privilege/externalstorage</privilege>\r
+            <example>\r
+            <code>\r
+            // To get the video directories for all the supported storage,\r
+            var storageList = StorageManager.Storages as List&lt;Storage&gt;;\r
+            foreach (var storage in storageList)\r
+            {\r
+                string pathForVideoDir = storage.GetAbsolutePath(DirectoryType.Videos);\r
+            }\r
+            </code>\r
+            </example>\r
+        </member>\r
+        <member name="T:Tizen.System.StorageArea">\r
+            <summary>\r
+            Enumeration for the storage area types.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.System.StorageArea.Internal">\r
+            <summary>\r
+            Internal device storage (built-in storage in a device, non-removable).\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.System.StorageArea.External">\r
+            <summary>\r
+            External storage.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="T:Tizen.System.StorageManager">\r
+            <summary>\r
+            The StorageManager provides the properties or methods to access storage in the device.\r
+            </summary>\r
+        </member>\r
+        <member name="P:Tizen.System.StorageManager.Storages">\r
+            <summary>\r
+            List of all storage in the device.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="T:Tizen.System.StorageState">\r
+            <summary>\r
+            Enumeration for the state of storage devices.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.System.StorageState.Unmountable">\r
+            <summary>\r
+            The storage is present but cannot be mounted. Typically, it happens if the file system of the storage is corrupted.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.System.StorageState.Removed">\r
+            <summary>\r
+            The storage is not present or removed.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.System.StorageState.Mounted">\r
+            <summary>\r
+            The storage is mounted with read/write access.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.System.StorageState.MountedReadOnly">\r
+            <summary>\r
+            The storage is mounted with read-only access.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+    </members>\r
+</doc>\r