namespace Tizen.System
{
/// <summary>
- /// Enumeration of the storage directory types.
+ /// Enumeration for the DirectoryType storage.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum DirectoryType
{
/// <summary>
- /// Image directory
+ /// Image directory.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Images = Interop.Storage.DirectoryType.Images,
/// <summary>
- /// Sounds directory
+ /// Sounds directory.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Sounds = Interop.Storage.DirectoryType.Sounds,
/// <summary>
- /// Videos directory
+ /// Videos directory.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Videos = Interop.Storage.DirectoryType.Videos,
/// <summary>
- /// Camera directory
+ /// Camera directory.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Camera = Interop.Storage.DirectoryType.Camera,
/// <summary>
- /// Downloads directory
+ /// Downloads directory.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Downloads = Interop.Storage.DirectoryType.Downloads,
/// <summary>
- /// Music directory
+ /// Music directory.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Music = Interop.Storage.DirectoryType.Music,
/// <summary>
- /// Documents directory
+ /// Documents directory.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Documents = Interop.Storage.DirectoryType.Documents,
/// <summary>
- /// Others directory
+ /// Others directory.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Others = Interop.Storage.DirectoryType.Others,
/// <summary>
- /// System ringtones directory. Only available for internal storage.
+ /// System ringtones directory is only available for an internal storage.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Ringtones = Interop.Storage.DirectoryType.Ringtones,
namespace Tizen.System
{
/// <summary>
- /// class to access storage device information
+ /// The class to access the storage device information.
/// </summary>
public class Storage
{
/// StorageStateChanged event. This event is occurred when a storage state changes.
/// </summary>
/// <remarks>
- /// Storage state will be updated before calling event handler.
+ /// The storage state will be updated before calling the event handler.
/// </remarks>
/// <since_tizen> 3 </since_tizen>
/// <example>
}
/// <summary>
- /// Storage ID
+ /// The storage ID.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public int Id { get; }
/// <summary>
- /// Type of the storage
+ /// The type of storage.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public StorageArea StorageType { get; }
/// <summary>
- /// Root directory for the storage
+ /// The root directory for the storage.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string RootDirectory { get; }
/// <summary>
- /// Total storage size in bytes
+ /// The total storage size in bytes.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public ulong TotalSpace { get { return _totalSpace; } }
/// <summary>
- /// Storage state
+ /// The StorageState.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public StorageState State
}
/// <summary>
- /// Available storage size in bytes
+ /// The available storage size in bytes.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public ulong AvaliableSpace
}
/// <summary>
- /// Absolute path for given directory type in storage
+ /// Absolute path for a given directory type in the storage.
/// </summary>
/// <remarks>
- /// returned directory path may not exist, so you must make sure that it exists before using it.
- /// For accessing internal storage except Ringtones directory, app should have http://tizen.org/privilege/mediastorage privilege.
- /// For accessing Ringtones directory, app should have http://tizen.org/privilege/systemsettings privilege.
- /// For accessing external storage, app should have http://tizen.org/privilege/externalstorage privilege.
+ /// 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 given directory type in storage</returns>
- /// <exception cref="ArgumentException">Thrown when failed because of a invalid arguament</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory exception</exception>
- /// <exception cref="NotSupportedException">Thrown when failed if storage is not supported or app does not have permission to access directory path</exception>
+ /// <param name="dirType">Directory type.</param>
+ /// <returns>Absolute path for a given directory type in the storage.</returns>
+ /// <exception cref="ArgumentException">Thrown when failed because of an invalid argument.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory exception.</exception>
+ /// <exception cref="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 video directories for all supported storage,
+ /// // To get the video directories for all the supported storage,
/// var storageList = StorageManager.Storages as List<Storage>;
/// foreach (var storage in storageList)
/// {
namespace Tizen.System
{
/// <summary>
- /// Enumeration for storage area types.
+ /// Enumeration for the storage area types.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum StorageArea
{
/// <summary>
- /// Internal device storage (built-in storage in a device, non-removable)
+ /// Internal device storage (built-in storage in a device, non-removable).
/// </summary>
/// <since_tizen> 3 </since_tizen>
Internal = Interop.Storage.StorageArea.Internal,
/// <summary>
- /// External storage
+ /// External storage.
/// </summary>
/// <since_tizen> 3 </since_tizen>
External = Interop.Storage.StorageArea.External,
namespace Tizen.System
{
/// <summary>
- /// Storage Manager, provides properties/ methods to access storage in the device.
+ /// The StorageManager provides the properties or methods to access storage in the device.
/// </summary>
public static class StorageManager
{
private const string LogTag = "Tizen.System";
/// <summary>
- /// List of all storage in the device
+ /// List of all storage in the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public static IEnumerable<Storage> Storages
public enum StorageState
{
/// <summary>
- /// Storage is present but cannot be mounted. Typically it happens if the file system of the storage is corrupted
+ /// 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>
Unmountable = Interop.Storage.StorageState.Unmountable,
/// <summary>
- /// Storage is not present or removed
+ /// The storage is not present or removed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Removed = Interop.Storage.StorageState.Removed,
/// <summary>
- /// Storage is mounted with read/write access
+ /// The storage is mounted with read/write access.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Mounted = Interop.Storage.StorageState.Mounted,
/// <summary>
- /// Storage is mounted with read only access
+ /// The storage is mounted with read-only access.
/// </summary>
/// <since_tizen> 3 </since_tizen>
MountedReadOnly = Interop.Storage.StorageState.MountedReadOnly,
projects / platform / core / csapi / tizenfx.git / commitdiff