Prefix:4.0.0
-Suffix:preview1-00117
-Number:117
-VCS:10ef0abe887fc32d1fa27a5e139e7807d1ee3d91
+Suffix:preview1-00120
+Number:120
+VCS:7d7bdd2cb35cdbdada0aad7599b458de558b971a
Sets or gets the selector icon image of a rotary selector item object.
</summary>
</member>
- <!-- Badly formed XML comment ignored for member "T:ElmSharp.Wearable.RotarySelectorItemEventArgs" -->
+ <member name="T:ElmSharp.Wearable.RotarySelectorItemEventArgs">
+ <summary>
+ <see cref="E:ElmSharp.Wearable.RotarySelector.Selected"/> and <see cref="E:ElmSharp.Wearable.RotarySelector.Clicked"/> events of RotarySelector contain RotarySelectorItemEventArgs as a parameter.
+ Inherits <see cref="T:System.EventArgs"/>.
+ </summary>
+ </member>
+ <member name="P:ElmSharp.Wearable.RotarySelectorItemEventArgs.Item">
+ <summary>
+ Sets or gets the rotary selector item.
+ </summary>
+ </member>
</members>
</doc>
<summary>
Hides the input panel (virtual keyboard).
</summary>
- <remark>
+ <remarks>
Note that the input panel is shown or hidden automatically according to the focus state of the entry widget.
This API can be used in case of manually controlling by using SetInputPanelEnabled(false).
- </remark>
+ </remarks>
</member>
<member name="M:ElmSharp.Entry.SelectAll">
<summary>
<summary>
This removes a custom item provider to the list for that entry.
</summary>
- <param name="itemProvider">This function is used to provide items.</param>
+ <param name="func">This function is used to provide items.</param>
</member>
<member name="M:ElmSharp.Entry.AppendMarkUpFilter(System.Func{ElmSharp.Entry,System.String,System.String})">
<summary>
</summary>
<param name="itemClass">The itemClass defines how to display the data.</param>
<param name="data">The item data.</param>
- <param name="func">User defined comparison function that defines the sort order based on gengrid item and its data.</param>
+ <param name="comparison">User defined comparison function that defines the sort order based on gengrid item and its data.</param>
<returns>Return a gengrid item that contains data and itemClass.</returns>
</member>
<member name="M:ElmSharp.GenGrid.ScrollTo(ElmSharp.GenGridItem,ElmSharp.ScrollToPosition,System.Boolean)">
</summary>
<param name="x">The input x coordinate</param>
<param name="y">The input y coordinate</param>
- <param name="positionX">The position relative to the item returned here.
+ <param name="portionX">The position relative to the item returned here.
-1, 0 or 1, depending if the coordinate is on the left portion of that item(-1), on the middle section(0) or on the right part(1).
</param>
- <param name="positionY">The position relative to the item returned here
+ <param name="portionY">The position relative to the item returned here
-1, 0 or 1, depending if the coordinate is on the upper portion of that item (-1), on the middle section (0) or on the lower part (1).
</param>
<returns></returns>
<see cref="M:ElmSharp.GenGrid.UpdateRealizedItems"/> to update the contents of all the realized items.
</remarks>
</member>
+ <member name="T:ElmSharp.GenItemSelectionMode">
+ <summary>
+ Enumeration for select mode of GenItem.
+ </summary>
+ </member>
<member name="F:ElmSharp.GenItemSelectionMode.Default">
<summary>
Default select mode.
<param name="itemClass">The itemClass defines how to display the data.</param>
<param name="data">The item data.</param>
<param name="type">The genlist item type.</param>
- <param name="parent">The parent item, otherwise null if there is no parent item.</param>
<returns>Return a new added genlist item that contains data and itemClass.</returns>
</member>
<member name="M:ElmSharp.GenList.Prepend(ElmSharp.GenItemClass,System.Object,ElmSharp.GenListItemType,ElmSharp.GenListItem)">
</summary>
<param name="itemClass">The itemClass defines how to display the data.</param>
<param name="data">The item data.</param>
- <param name="before">The item after which to place this new one.</param>
+ <param name="after">The item after which to place this new one.</param>
<param name="type">The genlist item type.</param>
<param name="parent">The parent item, otherwise null if there is no parent item.</param>
<returns>Return a new added genlist item that contains data and itemClass.</returns>
</summary>
<param name="itemClass">The itemClass defines how to display the data.</param>
<param name="data">The item data.</param>
- <param name="func">User defined comparison function that defines the sort order based on genlist item and its data.</param>
+ <param name="comparison">User defined comparison function that defines the sort order based on genlist item and its data.</param>
<param name="type">The genlist item type.</param>
<param name="parent">The parent item, otherwise null if there is no parent item.</param>
<returns>Return a genlist item that contains data and itemClass.</returns>
<summary>
Demote an item to the end of the list.
</summary>
- <param name="item">The genlistitem object</param>
</member>
<member name="P:ElmSharp.GenListItem.SelectionMode">
<summary>
<summary>
Remove all sub-items (children) of the given item.
</summary>
- <remark>
+ <remarks>
This removes all items that are children (and their descendants) of the given item it.
- </remark>
+ </remarks>
</member>
<member name="M:ElmSharp.GenListItem.UpdateItemClass(ElmSharp.GenItemClass,System.Object)">
<summary>
<summary>
Create a socket to provide the service for Plug widget.
</summary>
- <param name="serviceName">A service name</param>
- <param name="serviceNumber">A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.</param>
+ <param name="name">A service name</param>
+ <param name="number">A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.</param>
<param name="systemWide">A boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user id that created the service.</param>
- <returns></returns>
+ <returns>If true, create successfull, otherwise false</returns>
</member>
<member name="M:ElmSharp.Window.SetRotation(System.Int32,System.Boolean)">
<summary>
<members>
<member name="T:Tizen.Content.Download.DownloadState">
<summary>
- Enumeration for download state.
+ Enumeration for the download states.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Content.Download.DownloadState.None">
<summary>
- Unhandled exception
+ Unhandled exception.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Content.Download.DownloadState.Ready">
<summary>
- Ready to download
+ Ready to download.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Content.Download.DownloadState.Queued">
<summary>
- Queued to start downloading
+ Queued to start downloading.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Content.Download.DownloadState.Downloading">
<summary>
- Currently downloading
+ Currently downloading.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Content.Download.DownloadState.Paused">
<summary>
- Download is paused and can be resumed
+ The download is paused and can be resumed.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Content.Download.DownloadState.Completed">
<summary>
- The download is completed
+ The download is completed.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Content.Download.DownloadState.Failed">
<summary>
- The download failed
+ The download failed.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Content.Download.DownloadState.Canceled">
<summary>
- User canceled the download request
+ A user canceled the download request.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="T:Tizen.Content.Download.NetworkType">
<summary>
- Enumeration for network type.
+ Enumeration for the network types.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Content.Download.NetworkType.DataNetwork">
<summary>
- Download is available through data network
+ The download is available through data network.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Content.Download.NetworkType.Wifi">
<summary>
- Download is available through WiFi
+ The download is available through Wi-Fi.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Content.Download.NetworkType.WifiDirect">
<summary>
- Download is available through WiFi-Direct
+ The download is available through Wi-Fi Direct.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Content.Download.NetworkType.All">
<summary>
- Download is available through either data network or WiFi
+ The download is available either through data network or Wi-Fi.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="T:Tizen.Content.Download.NotificationType">
<summary>
- Enumeration for notification type.
+ Enumeration for the notification types.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Content.Download.NotificationType.None">
<summary>
- Do not register notification
+ Do not register notification.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Content.Download.NotificationType.CompleteOnly">
<summary>
- Completion notification for success state and failed state
+ Completion notification for success state and failed state.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Content.Download.NotificationType.All">
<summary>
- All download notifications for ongoing state, success state and failed state
+ All download notifications for ongoing state, success state, and failed state.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="T:Tizen.Content.Download.Notification">
<summary>
- The Notification class consists of all the properties required to set notifications for download operation.
+ The Notification class consists of all the properties required to set notifications for the download operation.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="P:Tizen.Content.Download.Notification.Title">
<summary>
Title of the notification.
- If user tries to get before setting, empty string is returned.
+ If a user tries to get before the setting, an empty string is returned.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Notification.Description">
<summary>
Description of the notification.
- If user tries to get before setting, empty string is returned.
+ If a user tries to get before the setting, an empty string is returned.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Notification.Type">
<summary>
- Type of Notification.
- If user tries to get before setting, default NotificationType None is returned.
+ Type of the notification.
+ If a user tries to get before the setting, the default NotificationType none is returned.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Notification.AppControlOngoing">
<summary>
AppControl for an ongoing download notification.
- If user tries to get before setting, null is returned.
+ If a user tries to get before the setting, null is returned.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<remarks>
- When the notification message is clicked, the action is decided by the app control.
+ When the notification message is clicked, the action is decided by the application control.
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Notification.AppControlCompleted">
<summary>
AppControl for a completed download notification.
- If user tries to get before setting, null is returned.
+ If a user tries to get before the setting, null is returned.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<remarks>
- When the notification message is clicked, the action is decided by the app control
+ When the notification message is clicked, the action is decided by the application control.
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Notification.AppControlFailed">
<summary>
AppControl for a failed download notification.
- If user tries to get before setting, null is returned.
+ If a user tries to get before the setting, null is returned.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<remarks>
- When the notification message is clicked, the action is decided by the app control
+ When the notification message is clicked, the action is decided by the application control.
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="T:Tizen.Content.Download.ProgressChangedEventArgs">
<summary>
</member>
<member name="P:Tizen.Content.Download.ProgressChangedEventArgs.ReceivedDataSize">
<summary>
- Received data size in bytes.
+ The received data size in bytes.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="T:Tizen.Content.Download.Request">
<summary>
- The Request class provides functions to create and manage a single download request.
+ The Request class provides the functions to create and manage a single download request.
</summary>
<since_tizen> 3 </since_tizen>
</member>
Creates a Request object.
</summary>
<since_tizen> 3 </since_tizen>
- <param name="url"> URL to download</param>
+ <param name="url">The URL to download.</param>
<privilege>http://tizen.org/privilege/download</privilege>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="M:Tizen.Content.Download.Request.#ctor(System.String,System.String,System.String,Tizen.Content.Download.NetworkType)">
<summary>
Creates a Request object.
</summary>
<since_tizen> 3 </since_tizen>
- <param name="url"> URL to download</param>
- <param name="destinationPath"> Directory path where downloaded file is stored </param>
- <param name="fileName"> Name of the downloaded file </param>
- <param name="type"> Network type which the download request must adhere to </param>
+ <param name="url">The URL to download</param>
+ <param name="destinationPath">The directory path where downloaded file is stored.</param>
+ <param name="fileName">The name of the downloaded file.</param>
+ <param name="type">The network type which the download request must adhere to.</param>
<privilege>http://tizen.org/privilege/download</privilege>
<feature>http://tizen.org/feature/network.wifi</feature>
<feature>http://tizen.org/feature/network.wifi.direct</feature>
<feature>http://tizen.org/feature/network.telephony</feature>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- <exception cref="T:System.NotSupportedException">Thrown when feature is not supported.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ <exception cref="T:System.NotSupportedException">Thrown when a feature is not supported.</exception>
</member>
<member name="M:Tizen.Content.Download.Request.#ctor(System.String,System.String,System.String,Tizen.Content.Download.NetworkType,System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Creates a Request object.
</summary>
<since_tizen> 3 </since_tizen>
- <param name="url"> URL to download</param>
- <param name="destinationPath"> Directory path where downloaded file is stored </param>
- <param name="fileName"> Name of the downloaded file </param>
- <param name="type"> Network type which the download request must adhere to </param>
- <param name="httpHeaders"> HTTP header fields for download request </param>
+ <param name="url">The URL to download.</param>
+ <param name="destinationPath">The directory path where the downloaded file is stored.</param>
+ <param name="fileName">The name of the downloaded file.</param>
+ <param name="type">The network type which the download request must adhere to.</param>
+ <param name="httpHeaders">HTTP header fields for the download request.</param>
<privilege>http://tizen.org/privilege/download</privilege>
<feature>http://tizen.org/feature/network.wifi</feature>
<feature>http://tizen.org/feature/network.wifi.direct</feature>
<feature>http://tizen.org/feature/network.telephony</feature>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- <exception cref="T:System.NotSupportedException">Thrown when features is not supported.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ <exception cref="T:System.NotSupportedException">Thrown when a feature is not supported.</exception>
</member>
<member name="E:Tizen.Content.Download.Request.StateChanged">
<summary>
- Event that occurs when the download state changes.
+ An event that occurs when the download state changes.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="E:Tizen.Content.Download.Request.ProgressChanged">
<summary>
- Event that occurs when the download progress changes.
+ An event that occurs when the download progress changes.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Request.DownloadedPath">
<summary>
- Absolute path where the file will be downloaded.
+ The absolute path where the file will be downloaded.
If you try to get this property value before calling Start(), an empty string is returned.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<remarks>
- Returns empty string if download is not completed or if state has not yet changed to Completed or if any other error occurs.
+ Returns an empty string if the download is not completed or if a state has not yet changed to completed or if any other error occurs.
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Request.MimeType">
<summary>
- MIME type of the downloaded content.
+ The MIME type of the downloaded content.
If you try to get this property value before calling Start(), an empty string is returned.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Request.State">
<summary>
- Current state of the download.
+ The current state of the download.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Request.ContentName">
<summary>
The content name of the downloaded file.
- This can be defined with reference of HTTP response header data. The content name can be received when HTTP response header is received.
+ This can be defined with reference of the HTTP response header data. The content name can be received when the HTTP response header is received.
If you try to get this property value before calling Start(), an empty string is returned.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Request.ContentSize">
<summary>
- Total size of downloaded content.
+ The total size of the downloaded content.
This information is received from the server. If the server does not send the total size of the content, the content size is set to zero.
If you try to get this property value before calling Start(), 0 is returned.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Request.HttpStatus">
<summary>
- HTTP status code when a download exception occurs.
+ The HTTP status code when a download exception occurs.
If you try to get this property value before calling Start(), 0 is returned.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<remarks>
- State of download request must be DownlodState.Failed.
+ The state of the download request must be DownlodState.Failed.
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Request.ETagValue">
<summary>
- ETag value from the HTTP response header when making a HTTP request for resume.
+ The ETag value from the HTTP response header when making a HTTP request for resume.
If you try to get this property value before calling Start() or if any other error occurs, an empty string is returned.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<remarks>
- The etag value is available or not depending on the web server. If not available, then on get of the property null is returned.
- After download is started, it can get the etag value.
+ The ETag value is either available or not dependent on the web server. If not available, then, on getting the property, a null value is returned.
+ After the download is started, it can get the ETag value.
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Request.NotificationProperties">
<summary>
</summary>
<since_tizen> 3 </since_tizen>
<remarks>
- When the notification message is clicked, the action taken by the system is decided by the app control properties of the NotificationProperties instance.
+ When the notification message is clicked, the action taken by the system is decided by the application control properties of the NotificationProperties instance.
If the app control is not set, the following default operation is executed when the notification message is clicked:
- 1) download completed state - the viewer application is executed according to extension name of downloaded content,
- 2) download failed state and ongoing state - the client application is executed.
+ 1) The download completed state - the viewer application is executed according to the extension name of the downloaded content.
+ 2) The download failed state and ongoing state - the client application is executed.
This property should be set before calling Start().
</remarks>
</member>
<member name="P:Tizen.Content.Download.Request.TemporaryPath">
<summary>
- Full path of the temporary file which stores downloaded content.
+ The full path of the temporary file stores the downloaded content.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<remarks>
- The download state must be one of the states after Downloading.
+ The download state must be one of the states after downloading.
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Request.Url">
<summary>
- URL to download.
+ The URL to download.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
If you try to get this property value before setting or if any other error occurs, an empty string is returned.
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Request.AllowedNetworkType">
<summary>
- Allowed network type for downloading the file.
+ The allowed network type for downloading the file.
The file will be downloaded only under the allowed network.
- If you try to get this property value before setting or if any other error occurs, default value NetworkType All is returned.
+ If you try to get this property value before setting or if any other error occurs, the default value NetworkType All is returned.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
Should be set before calling Start().
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
<exception cref="T:System.NotSupportedException">Thrown when feature is not supported.</exception>
</member>
<member name="P:Tizen.Content.Download.Request.DestinationPath">
<summary>
- The file will be downloaded to the set destination file path. The downloaded file is saved to an auto-generated file name in the destination. If the destination is not specified, the file will be downloaded to default storage.
+ The file will be downloaded to the set the destination file path. The downloaded file is saved to an auto-generated file name in the destination. If the destination is not specified, the file will be downloaded to the default storage.
If you try to get this property value before setting or if any other error occurs, an empty string is returned.
</summary>
<since_tizen> 3 </since_tizen>
Should be set before calling Start().
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Request.FileName">
<summary>
- The file will be saved in the specified destination or default storage with the set file name. If the file name is not specified, the downloaded file will be saved with an auto-generated file name in the destination.
+ The file will be saved in the specified destination or the default storage with the set file name. If the file name is not specified, the downloaded file will be saved with an auto-generated file name in the destination.
If you try to get this property value before setting or if any other error occurs, an empty string is returned.
</summary>
<since_tizen> 3 </since_tizen>
Should be set before calling Start().
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Request.AutoDownload">
<summary>
Enables or disables auto download.
If this option is enabled, the previous downloading item is restarted automatically as soon as the download daemon is restarted. The download progress continues after the client process is terminated.
- If you try to get this property value before setting, default value false is returned.
+ If you try to get this property value before setting, the default value false is returned.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
The default value is false.
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="P:Tizen.Content.Download.Request.HttpHeaders">
<summary>
- HTTP header field and value pairs to the download request.
- HTTP header <field,value> pair is the <key,value> pair in the Dictionary HttpHeaders
+ The HTTP header field and value pairs to the download request.
+ The HTTP header <field,value> pair is the <key,value> pair in the dictionary HttpHeaders.
The given HTTP header field will be included with the HTTP request of the download request.
If you try to get this property value before setting, an empty dictionary is returned.
</summary>
<member name="M:Tizen.Content.Download.Request.SetTemporaryFilePath(System.String)">
<summary>
Sets the directory path of a temporary file used in a previous download request.
- This is only useful when resuming download to make HTTP request header at the client side. Otherwise, the path is ignored.
+ This is only useful when resuming download to make the HTTP request header at the client side. Otherwise, the path is ignored.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<remarks>
- If the etag value is not present in the download database, it is not useful to set the temporary file path.
+ If the ETag value is not present in the download database, it is not useful to set the temporary file path.
When resuming the download request, the data is attached at the end of this temporary file.
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="M:Tizen.Content.Download.Request.Start">
<summary>
- Starts or resumes download.
+ Starts or resumes the download.
Starts to download the current URL, or resumes the download if paused.
</summary>
<since_tizen> 3 </since_tizen>
The URL is the mandatory information to start the download.
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="M:Tizen.Content.Download.Request.Pause">
<summary>
- Pauses download request.
+ Pauses the download request.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
The paused download request can be restarted with Start() or canceled with Cancel().
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="M:Tizen.Content.Download.Request.Cancel">
<summary>
- Cancels download request.
+ Cancels the download request.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
The canceled download can be restarted with Start().
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="M:Tizen.Content.Download.Request.Dispose">
<summary>
- Releases all resources used by the Request class.
+ Releases all the resources used by the Request class.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<remarks>
- After calling this method, download request related data exists in the download database for a certain period of time. Within that time, it is possible to use other APIs with this data.
+ After calling this method, the download request related data exists in the download database for a certain period of time. Within that time, it is possible to use other APIs with this data.
</remarks>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="M:Tizen.Content.Download.Request.Dispose(System.Boolean)">
<summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/download</privilege>
<exception cref="T:System.ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ <exception cref="T:System.InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
</member>
<member name="T:Tizen.Content.Download.StateChangedEventArgs">
<summary>
</member>
<member name="P:Tizen.Content.Download.StateChangedEventArgs.State">
<summary>
- Present download state.
+ The present download state.
</summary>
<since_tizen> 3 </since_tizen>
</member>
Name: csapi-tizenfx
Summary: Assemblies of Tizen .NET
-Version: 4.0.0.117
+Version: 4.0.0.120
Release: 1
Group: Development/Libraries
License: Apache-2.0
Tizen.Maps.dll #mobile #mobile-emul #tv #wearable
Tizen.Messaging.dll #mobile #mobile-emul #wearable
Tizen.Messaging.Push.dll #mobile #mobile-emul #tv #ivi
-Tizen.Multimedia.AudioIO.dll #common #mobile #mobile-emul #tv #ivi
+Tizen.Multimedia.AudioIO.dll #common #mobile #mobile-emul #tv #ivi #wearable
Tizen.Multimedia.Camera.dll #common #mobile #mobile-emul #tv #ivi
Tizen.Multimedia.dll #common #mobile #mobile-emul #tv #ivi #wearable
Tizen.Multimedia.MediaCodec.dll #common #mobile #mobile-emul #tv #ivi #wearable
namespace ElmSharp.Wearable
{
/// <summary>
- /// <see cref="RotarySelector.Selected"> and <see cref="RotarySelector.Clicked"> events of RotarySelector contain RotarySelectorItemEventArgs as a parameter.
+ /// <see cref="RotarySelector.Selected"/> and <see cref="RotarySelector.Clicked"/> events of RotarySelector contain RotarySelectorItemEventArgs as a parameter.
/// Inherits <see cref="EventArgs"/>.
/// </summary>
public class RotarySelectorItemEventArgs : EventArgs
{
+ /// <summary>
+ /// Sets or gets the rotary selector item.
+ /// </summary>
public RotarySelectorItem Item { get; set; }
}
}
/// <summary>
/// Hides the input panel (virtual keyboard).
/// </summary>
- /// <remark>
+ /// <remarks>
/// Note that the input panel is shown or hidden automatically according to the focus state of the entry widget.
/// This API can be used in case of manually controlling by using SetInputPanelEnabled(false).
- /// </remark>
+ /// </remarks>
public void HideInputPanel()
{
Interop.Elementary.elm_entry_input_panel_hide(RealHandle);
/// <summary>
/// This removes a custom item provider to the list for that entry.
/// </summary>
- /// <param name="itemProvider">This function is used to provide items.</param>
+ /// <param name="func">This function is used to provide items.</param>
public void RemoveItemProvider(Func<string, EvasObject> func)
{
if (_itemsProvider.ContainsKey(func))
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
- /// <param name="func">User defined comparison function that defines the sort order based on gengrid item and its data.</param>
+ /// <param name="comparison">User defined comparison function that defines the sort order based on gengrid item and its data.</param>
/// <returns>Return a gengrid item that contains data and itemClass.</returns>
public GenGridItem InsertSorted(GenItemClass itemClass, object data, Comparison<object> comparison)
{
/// </summary>
/// <param name="x">The input x coordinate</param>
/// <param name="y">The input y coordinate</param>
- /// <param name="positionX">The position relative to the item returned here.
+ /// <param name="portionX">The position relative to the item returned here.
/// -1, 0 or 1, depending if the coordinate is on the left portion of that item(-1), on the middle section(0) or on the right part(1).
/// </param>
- /// <param name="positionY">The position relative to the item returned here
+ /// <param name="portionY">The position relative to the item returned here
/// -1, 0 or 1, depending if the coordinate is on the upper portion of that item (-1), on the middle section (0) or on the lower part (1).
/// </param>
/// <returns></returns>
namespace ElmSharp
{
+ /// <summary>
+ /// Enumeration for select mode of GenItem.
+ /// </summary>
public enum GenItemSelectionMode
{
/// <summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="type">The genlist item type.</param>
- /// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
/// <returns>Return a new added genlist item that contains data and itemClass.</returns>
public GenListItem Prepend(GenItemClass itemClass, object data, GenListItemType type)
{
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
- /// <param name="before">The item after which to place this new one.</param>
+ /// <param name="after">The item after which to place this new one.</param>
/// <param name="type">The genlist item type.</param>
/// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
/// <returns>Return a new added genlist item that contains data and itemClass.</returns>
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
- /// <param name="func">User defined comparison function that defines the sort order based on genlist item and its data.</param>
+ /// <param name="comparison">User defined comparison function that defines the sort order based on genlist item and its data.</param>
/// <param name="type">The genlist item type.</param>
/// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
/// <returns>Return a genlist item that contains data and itemClass.</returns>
/// <summary>
/// Demote an item to the end of the list.
/// </summary>
- /// <param name="item">The genlistitem object</param>
public void DemoteItem()
{
Interop.Elementary.elm_genlist_item_demote(Handle);
/// <summary>
/// Remove all sub-items (children) of the given item.
/// </summary>
- /// <remark>
+ /// <remarks>
/// This removes all items that are children (and their descendants) of the given item it.
- /// </remark>
+ /// </remarks>
public void ClearSubitems()
{
Interop.Elementary.elm_genlist_item_subitems_clear(Handle);
/// <summary>
/// Create a socket to provide the service for Plug widget.
/// </summary>
- /// <param name="serviceName">A service name</param>
- /// <param name="serviceNumber">A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.</param>
+ /// <param name="name">A service name</param>
+ /// <param name="number">A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.</param>
/// <param name="systemWide">A boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user id that created the service.</param>
- /// <returns></returns>
+ /// <returns>If true, create successfull, otherwise false</returns>
public bool CreateServiceSocket(string name, int number, bool systemWide)
{
return Interop.Elementary.elm_win_socket_listen(RealHandle, name, number, systemWide);
namespace Tizen.Content.Download
{
/// <summary>
- /// Enumeration for download state.
+ /// Enumeration for the download states.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum DownloadState
{
/// <summary>
- /// Unhandled exception
+ /// Unhandled exception.
/// </summary>
/// <since_tizen> 3 </since_tizen>
None = 0,
/// <summary>
- /// Ready to download
+ /// Ready to download.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Ready,
/// <summary>
- /// Queued to start downloading
+ /// Queued to start downloading.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Queued,
/// <summary>
- /// Currently downloading
+ /// Currently downloading.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Downloading,
/// <summary>
- /// Download is paused and can be resumed
+ /// The download is paused and can be resumed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Paused,
/// <summary>
- /// The download is completed
+ /// The download is completed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Completed,
/// <summary>
- /// The download failed
+ /// The download failed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Failed,
/// <summary>
- /// User canceled the download request
+ /// A user canceled the download request.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Canceled
}
/// <summary>
- /// Enumeration for network type.
+ /// Enumeration for the network types.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum NetworkType
{
/// <summary>
- /// Download is available through data network
+ /// The download is available through data network.
/// </summary>
/// <since_tizen> 3 </since_tizen>
DataNetwork = 0,
/// <summary>
- /// Download is available through WiFi
+ /// The download is available through Wi-Fi.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Wifi,
/// <summary>
- /// Download is available through WiFi-Direct
+ /// The download is available through Wi-Fi Direct.
/// </summary>
/// <since_tizen> 3 </since_tizen>
WifiDirect,
/// <summary>
- /// Download is available through either data network or WiFi
+ /// The download is available either through data network or Wi-Fi.
/// </summary>
/// <since_tizen> 3 </since_tizen>
All
}
/// <summary>
- /// Enumeration for notification type.
+ /// Enumeration for the notification types.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum NotificationType
{
/// <summary>
- /// Do not register notification
+ /// Do not register notification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
None = 0,
/// <summary>
- /// Completion notification for success state and failed state
+ /// Completion notification for success state and failed state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
CompleteOnly,
/// <summary>
- /// All download notifications for ongoing state, success state and failed state
+ /// All download notifications for ongoing state, success state, and failed state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
All
namespace Tizen.Content.Download
{
/// <summary>
- /// The Notification class consists of all the properties required to set notifications for download operation.
+ /// The Notification class consists of all the properties required to set notifications for the download operation.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class Notification
/// <summary>
/// Title of the notification.
- /// If user tries to get before setting, empty string is returned.
+ /// If a user tries to get before the setting, an empty string is returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public string Title
{
get
/// <summary>
/// Description of the notification.
- /// If user tries to get before setting, empty string is returned.
+ /// If a user tries to get before the setting, an empty string is returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public string Description
{
get
}
/// <summary>
- /// Type of Notification.
- /// If user tries to get before setting, default NotificationType None is returned.
+ /// Type of the notification.
+ /// If a user tries to get before the setting, the default NotificationType none is returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public NotificationType Type
{
get
/// <summary>
/// AppControl for an ongoing download notification.
- /// If user tries to get before setting, null is returned.
+ /// If a user tries to get before the setting, null is returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <remarks>
- /// When the notification message is clicked, the action is decided by the app control.
+ /// When the notification message is clicked, the action is decided by the application control.
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public AppControl AppControlOngoing
{
get
/// <summary>
/// AppControl for a completed download notification.
- /// If user tries to get before setting, null is returned.
+ /// If a user tries to get before the setting, null is returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <remarks>
- /// When the notification message is clicked, the action is decided by the app control
+ /// When the notification message is clicked, the action is decided by the application control.
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public AppControl AppControlCompleted
{
get
/// <summary>
/// AppControl for a failed download notification.
- /// If user tries to get before setting, null is returned.
+ /// If a user tries to get before the setting, null is returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <remarks>
- /// When the notification message is clicked, the action is decided by the app control
+ /// When the notification message is clicked, the action is decided by the application control.
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public AppControl AppControlFailed
{
get
}
/// <summary>
- /// Received data size in bytes.
+ /// The received data size in bytes.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public ulong ReceivedDataSize
namespace Tizen.Content.Download
{
/// <summary>
- /// The Request class provides functions to create and manage a single download request.
+ /// The Request class provides the functions to create and manage a single download request.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class Request : IDisposable
/// Creates a Request object.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="url"> URL to download</param>
+ /// <param name="url">The URL to download.</param>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public Request(string url)
{
if (String.IsNullOrEmpty(url))
/// Creates a Request object.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="url"> URL to download</param>
- /// <param name="destinationPath"> Directory path where downloaded file is stored </param>
- /// <param name="fileName"> Name of the downloaded file </param>
- /// <param name="type"> Network type which the download request must adhere to </param>
+ /// <param name="url">The URL to download</param>
+ /// <param name="destinationPath">The directory path where downloaded file is stored.</param>
+ /// <param name="fileName">The name of the downloaded file.</param>
+ /// <param name="type">The network type which the download request must adhere to.</param>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <feature>http://tizen.org/feature/network.wifi.direct</feature>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when a feature is not supported.</exception>
public Request(string url, string destinationPath, string fileName, NetworkType type)
{
if (String.IsNullOrEmpty(url))
/// Creates a Request object.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="url"> URL to download</param>
- /// <param name="destinationPath"> Directory path where downloaded file is stored </param>
- /// <param name="fileName"> Name of the downloaded file </param>
- /// <param name="type"> Network type which the download request must adhere to </param>
- /// <param name="httpHeaders"> HTTP header fields for download request </param>
+ /// <param name="url">The URL to download.</param>
+ /// <param name="destinationPath">The directory path where the downloaded file is stored.</param>
+ /// <param name="fileName">The name of the downloaded file.</param>
+ /// <param name="type">The network type which the download request must adhere to.</param>
+ /// <param name="httpHeaders">HTTP header fields for the download request.</param>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <feature>http://tizen.org/feature/network.wifi.direct</feature>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="NotSupportedException">Thrown when features is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when a feature is not supported.</exception>
public Request(string url, string destinationPath, string fileName, NetworkType type, IDictionary<string, string> httpHeaders)
{
if (String.IsNullOrEmpty(url))
}
/// <summary>
- /// Event that occurs when the download state changes.
+ /// An event that occurs when the download state changes.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public event EventHandler<StateChangedEventArgs> StateChanged
{
add
}
/// <summary>
- /// Event that occurs when the download progress changes.
+ /// An event that occurs when the download progress changes.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public event EventHandler<ProgressChangedEventArgs> ProgressChanged
{
add
}
/// <summary>
- /// Absolute path where the file will be downloaded.
+ /// The absolute path where the file will be downloaded.
/// If you try to get this property value before calling Start(), an empty string is returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <remarks>
- /// Returns empty string if download is not completed or if state has not yet changed to Completed or if any other error occurs.
+ /// Returns an empty string if the download is not completed or if a state has not yet changed to completed or if any other error occurs.
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public string DownloadedPath
{
get
}
/// <summary>
- /// MIME type of the downloaded content.
+ /// The MIME type of the downloaded content.
/// If you try to get this property value before calling Start(), an empty string is returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public string MimeType
{
get
}
/// <summary>
- /// Current state of the download.
+ /// The current state of the download.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public DownloadState State
{
get
/// <summary>
/// The content name of the downloaded file.
- /// This can be defined with reference of HTTP response header data. The content name can be received when HTTP response header is received.
+ /// This can be defined with reference of the HTTP response header data. The content name can be received when the HTTP response header is received.
/// If you try to get this property value before calling Start(), an empty string is returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public string ContentName
{
get
}
/// <summary>
- /// Total size of downloaded content.
+ /// The total size of the downloaded content.
/// This information is received from the server. If the server does not send the total size of the content, the content size is set to zero.
/// If you try to get this property value before calling Start(), 0 is returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public ulong ContentSize
{
get
}
/// <summary>
- /// HTTP status code when a download exception occurs.
+ /// The HTTP status code when a download exception occurs.
/// If you try to get this property value before calling Start(), 0 is returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <remarks>
- /// State of download request must be DownlodState.Failed.
+ /// The state of the download request must be DownlodState.Failed.
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public int HttpStatus
{
get
}
/// <summary>
- /// ETag value from the HTTP response header when making a HTTP request for resume.
+ /// The ETag value from the HTTP response header when making a HTTP request for resume.
/// If you try to get this property value before calling Start() or if any other error occurs, an empty string is returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <remarks>
- /// The etag value is available or not depending on the web server. If not available, then on get of the property null is returned.
- /// After download is started, it can get the etag value.
+ /// The ETag value is either available or not dependent on the web server. If not available, then, on getting the property, a null value is returned.
+ /// After the download is started, it can get the ETag value.
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public string ETagValue
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// When the notification message is clicked, the action taken by the system is decided by the app control properties of the NotificationProperties instance.
+ /// When the notification message is clicked, the action taken by the system is decided by the application control properties of the NotificationProperties instance.
/// If the app control is not set, the following default operation is executed when the notification message is clicked:
- /// 1) download completed state - the viewer application is executed according to extension name of downloaded content,
- /// 2) download failed state and ongoing state - the client application is executed.
+ /// 1) The download completed state - the viewer application is executed according to the extension name of the downloaded content.
+ /// 2) The download failed state and ongoing state - the client application is executed.
/// This property should be set before calling Start().
/// </remarks>
public Notification NotificationProperties
}
/// <summary>
- /// Full path of the temporary file which stores downloaded content.
+ /// The full path of the temporary file stores the downloaded content.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <remarks>
- /// The download state must be one of the states after Downloading.
+ /// The download state must be one of the states after downloading.
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public string TemporaryPath
{
get
}
/// <summary>
- /// URL to download.
+ /// The URL to download.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// If you try to get this property value before setting or if any other error occurs, an empty string is returned.
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public string Url
{
get
}
/// <summary>
- /// Allowed network type for downloading the file.
+ /// The allowed network type for downloading the file.
/// The file will be downloaded only under the allowed network.
- /// If you try to get this property value before setting or if any other error occurs, default value NetworkType All is returned.
+ /// If you try to get this property value before setting or if any other error occurs, the default value NetworkType All is returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// Should be set before calling Start().
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
/// <exception cref="NotSupportedException">Thrown when feature is not supported.</exception>
public NetworkType AllowedNetworkType
{
}
/// <summary>
- /// The file will be downloaded to the set destination file path. The downloaded file is saved to an auto-generated file name in the destination. If the destination is not specified, the file will be downloaded to default storage.
+ /// The file will be downloaded to the set the destination file path. The downloaded file is saved to an auto-generated file name in the destination. If the destination is not specified, the file will be downloaded to the default storage.
/// If you try to get this property value before setting or if any other error occurs, an empty string is returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// Should be set before calling Start().
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public string DestinationPath
{
get
}
/// <summary>
- /// The file will be saved in the specified destination or default storage with the set file name. If the file name is not specified, the downloaded file will be saved with an auto-generated file name in the destination.
+ /// The file will be saved in the specified destination or the default storage with the set file name. If the file name is not specified, the downloaded file will be saved with an auto-generated file name in the destination.
/// If you try to get this property value before setting or if any other error occurs, an empty string is returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// Should be set before calling Start().
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public string FileName
{
get
/// <summary>
/// Enables or disables auto download.
/// If this option is enabled, the previous downloading item is restarted automatically as soon as the download daemon is restarted. The download progress continues after the client process is terminated.
- /// If you try to get this property value before setting, default value false is returned.
+ /// If you try to get this property value before setting, the default value false is returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// The default value is false.
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public bool AutoDownload
{
get
}
/// <summary>
- /// HTTP header field and value pairs to the download request.
- /// HTTP header <field,value> pair is the <key,value> pair in the Dictionary HttpHeaders
+ /// The HTTP header field and value pairs to the download request.
+ /// The HTTP header <field,value> pair is the <key,value> pair in the dictionary HttpHeaders.
/// The given HTTP header field will be included with the HTTP request of the download request.
/// If you try to get this property value before setting, an empty dictionary is returned.
/// </summary>
/// <summary>
/// Sets the directory path of a temporary file used in a previous download request.
- /// This is only useful when resuming download to make HTTP request header at the client side. Otherwise, the path is ignored.
+ /// This is only useful when resuming download to make the HTTP request header at the client side. Otherwise, the path is ignored.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <remarks>
- /// If the etag value is not present in the download database, it is not useful to set the temporary file path.
+ /// If the ETag value is not present in the download database, it is not useful to set the temporary file path.
/// When resuming the download request, the data is attached at the end of this temporary file.
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public void SetTemporaryFilePath(string path)
{
int ret = Interop.Download.SetTempFilePath(_downloadId, path);
}
/// <summary>
- /// Starts or resumes download.
+ /// Starts or resumes the download.
/// Starts to download the current URL, or resumes the download if paused.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// The URL is the mandatory information to start the download.
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public void Start()
{
int ret = (int)DownloadError.None;
}
/// <summary>
- /// Pauses download request.
+ /// Pauses the download request.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// The paused download request can be restarted with Start() or canceled with Cancel().
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public void Pause()
{
int ret = Interop.Download.PauseDownload(_downloadId);
}
/// <summary>
- /// Cancels download request.
+ /// Cancels the download request.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// The canceled download can be restarted with Start().
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public void Cancel()
{
int ret = Interop.Download.CancelDownload(_downloadId);
}
/// <summary>
- /// Releases all resources used by the Request class.
+ /// Releases all the resources used by the Request class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <remarks>
- /// After calling this method, download request related data exists in the download database for a certain period of time. Within that time, it is possible to use other APIs with this data.
+ /// After calling this method, the download request related data exists in the download database for a certain period of time. Within that time, it is possible to use other APIs with this data.
/// </remarks>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
public void Dispose()
{
Dispose(true);
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/download</privilege>
/// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when it is failed due to an invalid operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when a permission is denied.</exception>
protected virtual void Dispose(bool disposing)
{
if (_disposed)
}
/// <summary>
- /// Present download state.
+ /// The present download state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public DownloadState State
projects / platform / core / csapi / tizenfx.git / commitdiff