* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompAudioContentInfoConstructPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompAudioContentInfoConstructPage "here".
* @endif
*
- * @return An error code
- * @param[in] pContentPath The content path @n
- * The path should be started with directory path returned by
- * either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
- * If the path is @c null,
- * use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
- * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*),
- * instead of this method.
+ * @return An error code
+ * @param[in] pContentPath The content path @n
+ * The path should be started with the directory path returned by
+ * either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
+ * If the path is @c null,
+ * use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
+ * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*),
+ * instead of this method.
* @exception E_SUCCESS The method is successful.
- * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
+ * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_IO An I/O error has occurred.
- * @exception E_SYSTEM An internal error has occurred.
+ * @exception E_IO An I/O error has occurred.
+ * @exception E_SYSTEM An internal error has occurred.
*/
result Construct(const Tizen::Base::String* pContentPath);
* @if OSPCOMPAT
* @page CompAudioContentInfoConstructPage Compatibility for the file path.
* @section CompAudioContentInfoConstructPageIssueSection Issues
- * The content path argument of this method in OSP compatible applications has the following issues: @n
- * -# The content path should be a path that begins with an allowed path prefix. @n
- * For example, L"/Media/Images/flower.jpg", L"/Storagecard/Media/Images/flower.jpg".
+ * The content path argument of this method in OSP compatible applications has the following issues: @n
+ * -# The content path should be a path that begins with an allowed path prefix. @n
+ * For example, L"/Media/Images/flower.jpg", L"/Storagecard/Media/Images/flower.jpg".
*
* @section CompAudioContentInfoConstructPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
- * -# The content path can be a path without a specific allowed path prefix. @n
- * Application do not need to know the specific allowed path prefixes. @n
- * To get the directory path, use the following methods: @n
- * - For accessing the media directory, use Tizen::System::Environment::GetMediaPath().
- * - For accessing the external storage, use Tizen::System::Environment::GetExternalStoragePath().
+ * This issue has been resolved in Tizen. @n
+ * -# The content path can be a path without a specific allowed path prefix. @n
+ * Application do not need to know the specific allowed path prefixes. @n
+ * To get the directory path, use the following methods: @n
+ * - For accessing the media directory, use Tizen::System::Environment::GetMediaPath().
+ * - For accessing the external storage, use Tizen::System::Environment::GetExternalStoragePath().
*
* @endif
*/
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as there is a problem in managing the user-defined thumbnail and device coordinates. @n
- * Instead of using this method, use Construct(const Tizen::Base::String*). @n
- * To set the coordinates in the ContentInfo instance, use ContentInfo::SetCoordinates(const Tizen::Locations::Coordinates&).
+ * Instead of using this method, use Construct(const Tizen::Base::String*). @n
+ * To set the coordinates of the ContentInfo instance, use ContentInfo::SetCoordinates(const Tizen::Locations::Coordinates&).
* @since 2.0
*
- * @return An error code
- * @param[in] contentPath The content path
- * @param[in] thumbnailPath The thumbnail path
- * @param[in] setGps Set to @c true to save the device's last known coordinates in the ContentInfo instance, @n
- * else @c false @n
- * The coordinate information may be incorrect if it is outdated or has never been updated. @n
- * To update the coordinate information or to get the exact value,
- * use Tizen::Locations::LocationProvider::RequestLocationUpdates() before calling this method.
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] contentPath The content path
+ * @param[in] thumbnailPath The thumbnail path
+ * @param[in] setGps Set to @c true to save the device's last known coordinates of the ContentInfo instance, @n
+ * else @c false @n
+ * The coordinate information may be incorrect if it is outdated or has never been updated. @n
+ * To update the coordinate information or to get the exact value,
+ * use Tizen::Locations::LocationProvider::RequestLocationUpdates() before calling this method.
+ * @exception E_SUCCESS The method is successful.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_IO An I/O error has occurred.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_IO An I/O error has occurred.
* @remarks
* - The content path must start with @c '/Media' or @c '/Storagecard/Media'.
* - The thumbnail path must start with @c '/Home', @c '/Media', or @c '/Storagecard/Media'. @n
- * The permitted format for a thumbnail image is Bitmap (bmp).
+ * - The permitted format for a thumbnail image is bitmap (bmp).
* @endif
*/
virtual result Construct(const Tizen::Base::String& contentPath, const Tizen::Base::String& thumbnailPath = L"", bool setGps = false);
// limitations under the License.
//
/**
- * @file FCntAudioMetadata.h
+ * @file FCntAudioMetadata.h
* @brief This is the header file for the %AudioMetadata class.
*
* This header file contains the declarations of the %AudioMetadata class.
*
* @since 2.0
*
- * @param[in] rhs An instance of %AudioMetadata
+ * @param[in] rhs An instance of %AudioMetadata to copy
*/
AudioMetadata(const AudioMetadata& rhs);
Tizen::Base::String GetComment(void) const;
/**
- * Gets the description of an audio file.
+ * Gets the description of the audio file.
*
* @since 2.1
*
- * @return The description of an audio file
+ * @return The description of the audio file
*/
Tizen::Base::String GetDescription(void) const;
/**
- * Gets the track number of an audio file.
+ * Gets the track number of the audio file.
*
* @since 2.0
*
- * @return The track number of an audio file
+ * @return The track number of the audio file
*/
int GetTrack(void) const;
/**
- * Gets the genre information of an audio file.
+ * Gets the genre information of the audio file.
*
* @since 2.0
*
- * @return The genre information of an audio file
+ * @return The genre information of the audio file
*/
Tizen::Base::String GetGenre(void) const;
/**
- * Gets the composer information of an audio file.
+ * Gets the composer information of the audio file.
*
* @since 2.0
*
- * @return The composer information of an audio file
+ * @return The composer information of the audio file
*/
Tizen::Base::String GetComposer(void) const;
/**
- * Gets the copyright information of an audio file.
+ * Gets the copyright information of the audio file.
*
* @since 2.0
*
- * @return The copyright information of an audio file
+ * @return The copyright information of the audio file
*/
Tizen::Base::String GetCopyright(void) const;
/**
- * Gets the duration of an audio file.
+ * Gets the duration of the audio file.
*
* @since 2.0
*
long GetDuration(void) const;
/**
- * Gets the year information of an audio file.
+ * Gets the year information of the audio file.
*
* @since 2.0
*
- * @return The year information of an audio file
+ * @return The year information of the audio file
*/
int GetYear(void) const;
/**
- * Gets the track information of an audio file.
+ * Gets the track information of the audio file.
*
* @since 2.0
*
- * @return The track number/position embedded in content metadata @n
+ * @return The track number/position embedded in the content metadata @n
* The value can be like "4/9" or "4" in case the position is not available.
*/
Tizen::Base::String GetTrackInfo(void) const;
/**
- * Gets the recording date of an audio file.
+ * Gets the recording date of the audio file.
*
* @since 2.0
*
- * @return The recording date of an audio file
+ * @return The recording date of the audio file
*/
Tizen::Base::String GetRecordingDate(void) const;
/**
- * Gets the number of channels of an audio file.
+ * Gets the number of channels of the audio file.
*
* @since 2.0
*
- * @return The number of channels of an audio file @n
- * The values are @c 1 in a monophonic stream and @c 2c in a stereophonic stream.
+ * @return The channel count of the audio file @n
+ * The values are @c 1 in a monophonic stream and @c 2 in a stereophonic stream.
*/
int GetChannelCount(void) const;
/**
- * Gets the thumbnail of an audio file.
+ * Gets the thumbnail of the audio file.
*
* @since 2.0
*
- * @return A pointer to the thumbnail image that is resized to 80x60 pixels
- * @exception E_SUCCESS The method is successful.
- * @exception E_DATA_NOT_FOUND The thumbnail image does not exist.
+ * @return A pointer to the thumbnail image that is resized to 80x60 pixels
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DATA_NOT_FOUND The thumbnail image does not exist.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::Bitmap* GetThumbnailN(void) const;
/**
- * Gets the album art of an audio file.
+ * Gets the album art of the audio file.
*
* @since 2.0
*
- * @return A pointer to the album art that is embedded in the content metadata
- * @exception E_SUCCESS The method is successful.
- * @exception E_DATA_NOT_FOUND The album art does not exist.
+ * @return A pointer to the album art that is embedded in the content metadata
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DATA_NOT_FOUND The album art does not exist.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::Bitmap* GetAlbumArtN(void) const;
/**
- * Compares the equality of values between two %AudioMetadata objects by overriding the Tizen::Base::Object::Equals() method.
+ * Compares the equality of the values between two %AudioMetadata objects by overriding the Tizen::Base::Object::Equals() method.
*
* @since 2.0
*
- * @return @c true if all the fields in the objects are equal, @n
- * else @c false
+ * @return @c true if all the fields in the objects are equal, @n
+ * else @c false
* @param[in] rhs The Tizen::Base::Object with which the comparison is done @n
- * An instance of Tizen::Graphics::Bitmap is not taken into account in the comparisons.
+ * An instance of Tizen::Graphics::Bitmap is not taken into account in the comparisons.
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
* @since 2.0
*
* @return A reference to this instance
- * @param[in] rhs An instance of %AudioMetadata
+ * @param[in] rhs An instance of %AudioMetadata to copy
*/
AudioMetadata& operator =(const AudioMetadata& rhs);
* @final This class is not intended for extension.
*
* The %ContentDirectory class provides methods to access a list of content directories
- * and information of the content (specified content type) in the content directories.
+ * and the information of the content (specified content type) in the content directories.
*
* For more information on the database columns and their corresponding content types,
* see <a href="../org.tizen.native.appprogramming/html/guide/content/content_search_device.htm">Content Search on the Device</a>.
* @since 2.0
*
* @return An error code
- * @param contentType The content type @n
- * This method is used to access only one type of content. The allowed types are
- * @c CONTENT_TYPE_OTHER, @c CONTENT_TYPE_IMAGE, @c CONTENT_TYPE_AUDIO, and @c CONTENT_TYPE_VIDEO. @n
- * If you want to access more than one type of content, use Construct(const Tizen::Base::Collection::IListT<ContentType>&)
- * instead of this method.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM The method cannot connect to the database.
+ * @param contentType The content type @n
+ * This method is used to access only one type of content @n
+ * The allowed types are @c CONTENT_TYPE_OTHER, @c CONTENT_TYPE_IMAGE, @c CONTENT_TYPE_AUDIO,
+ * and @c CONTENT_TYPE_VIDEO @n
+ * If you want to access more than one type of content, use Construct(const Tizen::Base::Collection::IListT<ContentType>&)
+ * instead of this method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SYSTEM The method cannot connect to the database.
*/
result Construct(ContentType contentType);
* @since 2.0
*
* @return An error code
- * @param contentTypeList The list of content types @n
- * This method is used to access more than one type of content, but total count should not be greater than @c 4.
- * The allowed types are @c CONTENT_TYPE_OTHER, @c CONTENT_TYPE_IMAGE, @c CONTENT_TYPE_AUDIO,
- * and @c CONTENT_TYPE_VIDEO. Any combination with @c CONTENT_TYPE_ALL is a invalid argument. @n
- * If you want to access only one type of content, use Construct(ContentType) instead of this method.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM The method cannot connect to the database.
+ * @param contentTypeList The list of content types @n
+ * This method is used to access more than one type of content, but the total count should not be greater than @c 4 @n
+ * The allowed types are @c CONTENT_TYPE_OTHER, @c CONTENT_TYPE_IMAGE, @c CONTENT_TYPE_AUDIO,
+ * and @c CONTENT_TYPE_VIDEO @n
+ * Any combination with @c CONTENT_TYPE_ALL is a invalid argument @n
+ * If you want to access only one type of content, use Construct(ContentType) instead of this method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SYSTEM The method cannot connect to the database.
*/
result Construct(const Tizen::Base::Collection::IListT<ContentType>& contentTypeList);
/**
- * Gets the count of content directories that contains the content type that is passed as a parameter in Construct().
+ * Gets the count of the content directories that contain the content type that is passed as a parameter to Construct().
*
* @since 2.0
*
- * @return The count of content directories
+ * @return The count of the content directories
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SERVICE_BUSY The database is busy.
- * @exception E_SYSTEM The method cannot access the database.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SERVICE_BUSY The database is busy.
+ * @exception E_SYSTEM The method cannot access the database.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
int GetContentDirectoryCount(void) const;
/**
- * Gets the list of content directory path that contains the content type that is passed as a parameter in Construct().
+ * Gets the list of content directory paths that contain the content type that is passed as a parameter to Construct().
*
* @since 2.0
*
- * @return A list of Tizen::Base::String values that contains content directory path
+ * @return The list of Tizen::Base::String values that contain the content directory paths
* @param sortOrder The sort order
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SERVICE_BUSY The database is busy.
- * @exception E_SYSTEM The method cannot access the database.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SERVICE_BUSY The database is busy.
+ * @exception E_SYSTEM The method cannot access the database.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetContentDirectoryPathListN(Tizen::Base::SortOrder sortOrder) const;
/**
- * Gets the count of files in a directory.
+ * Gets the file count in the directory.
*
* @since 2.0
*
- * @return The count of files
+ * @return The file count
* @param contentDirectoryPath The content directory path @n
- * The allowed directory path can be obtained by using
- * Tizen::System::Environment::GetMediaPath() and Tizen::System::Environment::GetExternalStoragePath().
+ * The allowed directory path can be obtained by using
+ * Tizen::System::Environment::GetMediaPath() and Tizen::System::Environment::GetExternalStoragePath().
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
int GetContentDirectoryItemCount(const Tizen::Base::String& contentDirectoryPath) const;
/**
- * Gets the list of content information in a directory.
+ * Gets the list of content information in the directory.
*
* @since 2.0
*
- * @return A list of ContentInfo classes that contains content information
- * @param contentDirectoryPath The content directory path @n
- * The allowed directory path can be obtained by using
- * Tizen::System::Environment::GetMediaPath() and Tizen::System::Environment::GetExternalStoragePath().
- * @param pageNo The page number @n
- * It must be equal to or greater than @c 1.
- * @param countPerPage The count of the search results per page @n
- * It must be equal to or greater than @c 1.
- * @param column The sort column name
- * @param sortOrder The sort order
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SERVICE_BUSY The database is busy.
- * @exception E_SYSTEM The method cannot access the database.
+ * @return The list of ContentInfo classes that contain the content information
+ * @param contentDirectoryPath The content directory path @n
+ * The allowed directory path can be obtained by using
+ * Tizen::System::Environment::GetMediaPath() and Tizen::System::Environment::GetExternalStoragePath().
+ * @param pageNo The page number @n
+ * It must be either greater than or equal to @c 1.
+ * @param countPerPage The count of the search results per page @n
+ * It must be either greater than or equal to @c 1.
+ * @param column The sort column name
+ * @param sortOrder The sort order
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SERVICE_BUSY The database is busy.
+ * @exception E_SYSTEM The method cannot access the database.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see GetContentDirectoryPathListN()
*/
*
* When a user creates content, its content information is created as a new pair. @n
* When a user deletes content, its content information is deleted from the content database. @n
- * This class provides methods to get or to set the specific content information. @n
+ * This class provides methods to get or set specific content information. @n
* The physical file is not updated even if the set methods are called.
*
* For more information on the different types of content information, see <a href="../org.tizen.native.appprogramming/html/guide/content/device_content_mgmt.htm">Device Content Management</a>.
* @if OSPDEPREC
* Initializes this instance of %ContentInfo with the specified parameters.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as there is a problem in managing the user-defined thumbnail and device coordinates.
* @since 2.0
*
- * @return An error code
- * @param[in] contentPath The content path
+ * @return An error code
+ * @param[in] contentPath The content path
* @param[in] thumbnailPath The thumbnail path
- * @param[in] setGps Set to @c true to save the device's last known coordinates in the %ContentInfo instance, @n
- * else @c false
+ * @param[in] setGps Set to @c true to save the device's last known coordinates of the %ContentInfo instance, @n
+ * else @c false
* @endif
*/
virtual result Construct(const Tizen::Base::String& contentPath, const Tizen::Base::String& thumbnailPath = L"", bool setGps = false) = 0;
ContentType GetContentType(void) const;
/**
- * Gets the mime type.
+ * Gets the MIME type.
*
* @since 2.0
*
- * @return The mime type
+ * @return The MIME type
*/
Tizen::Base::String GetMimeType(void) const;
* @since 2.0
*
* @return The content name
- * @remarks The content name is not a file name.
+ * @remarks The content name is not a file name.
*/
Tizen::Base::String GetContentName(void) const;
*
* @since 2.0
*
- * @return A reference to the coordinates
+ * @return A reference to the Tizen::Locations::Coordinates instance
*/
const Tizen::Locations::Coordinates& GetCoordinates(void) const;
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] coordinates The user-defined coordinates
* @exception E_SUCCESS The method is successful.
*/
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] locationTag The new location tag
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the input data exceeds the maximum limit of 45 characters.
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] rating The new rating
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the input data exceeds the maximum limit of 45 characters.
*
* @since 2.0
*
- * @return An error code
- * @param[in] category The new category
+ * @return An error code
+ * @param[in] category The new category
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the input data exceeds the maximum limit of 45 characters.
*/
*
* @since 2.0
*
- * @return An error code
- * @param[in] description The new description
+ * @return An error code
+ * @param[in] description The new description
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the input data exceeds the maximum limit of 140 characters.
*/
* @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompContentInfoGetThumbnailNPage "here".
+ * For more information, see @ref CompContentInfoGetThumbnailNPage "here".
* @endif
*
- * @return A pointer to the thumbnail image
- * @exception E_SUCCESS The method is successful.
+ * @return A pointer to the thumbnail image
+ * @exception E_SUCCESS The method is successful.
* @exception E_DATA_NOT_FOUND The thumbnail image does not exist.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
/**
* @if OSPCOMPAT
- * @page CompContentInfoGetThumbnailNPage Compatibility for GetThumbnailN().
+ * @page CompContentInfoGetThumbnailNPage Compatibility for GetThumbnailN().
* @section CompContentInfoGetThumbnailNPageIssueSection Issue
- * The thumbnail size of this method in OSP compatible applications has the following issues: @n
- * <DIV> The size is changed from 80x60 pixels to the size of image which is returned from the platform since %Tizen API 2.1.</DIV>
+ * The thumbnail size of this method in OSP compatible applications has the following issues: @n
+ * <DIV> The size is changed from 80x60 pixels to the size of the image which is returned from the platform since %Tizen API 2.1.</DIV>
*
* @endif
*/
* @since 2.0
*
* @return @c true if this content has DRM, @n
- * else @c false
+ * else @c false
*/
bool IsDrmProtected(void) const;
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] contentName The new content name
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the input data exceeds the maximum limit of 45 characters.
/**
* Sets the keyword.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] keyword The new keyword
+ * @return An error code
+ * @param[in] keyword The new keyword
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the input data exceeds the maximum limit of 45 characters.
*/
*
* @since 2.0
*
- * @return An error code
- * @param[in] author The new author
+ * @return An error code
+ * @param[in] author The new author
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the input data exceeds the maximum limit of 45 characters.
*/
*
* @since 2.0
*
- * @return An error code
- * @param[in] provider The new content provider
+ * @return An error code
+ * @param[in] provider The new content provider
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the input data exceeds the maximum limit of 45 characters.
*/
*
* @since 2.0
*
- * @final This class is not intended for extension.
+ * @final This class is not intended for extension.
*
* The %ContentManager class manages the information stored locally on the device's content database. @n
- * It also allows you to create, read, update, and delete specific content information in the database.
+ * It also allows the user to create, read, update, and delete specific content information in the database.
*
* For more information on managing content on the device, see <a href="../org.tizen.native.appprogramming/html/guide/content/device_content_mgmt.htm">Device Content Management</a>.
*
/**
* Creates the content information.
*
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/content.write
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/content.write
*
- * @return The content ID
- * @param[in] contentInfo An instance of ContentInfo
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the specified format is invalid or not supported on the device.
+ * @return The content ID
+ * @param[in] contentInfo An instance of ContentInfo
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The specified format is either invalid or not supported on the device.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @exception E_IO An I/O error has occurred.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IO An I/O error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SERVICE_BUSY The database is busy.
* @remarks
- * - If the @c E_UNSUPPORTED_FORMAT exception is received from ContentManagerUtil::CheckContentType(),
- * the file can be created as a content only using the OtherContentInfo class.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the @c E_UNSUPPORTED_FORMAT exception is received from ContentManagerUtil::CheckContentType(),
+ * the file can be created as content only using the OtherContentInfo class.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
ContentId CreateContent(const ContentInfo& contentInfo);
* @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompContentManagerCreateContentPage "here".
+ * For more information, see @ref CompContentManagerCreateContentPage "here".
* @endif
- * @privlevel public
- * @privilege %http://tizen.org/privilege/content.write
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/content.write
*
- * @return The content ID
- * @param[in] byteBuffer The @c byteBuffer of the content to create
- * @param[in] destinationPath The destination file path formed by the @c byteBuffer @n
- * The path should be started with the directory path returned by either
- * Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath().
- * @param[in] pContentInfo A pointer to the ContentInfo instance @n
- * If the content path exists in %ContentInfo, it gets ignored.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - A specified input parameter is invalid. @n
- * - There is a mismatch between the type specified in ContentInfo and the type specified in the actual content.
- * @exception E_STORAGE_FULL The storage is full.
- * @exception E_FILE_ALREADY_EXIST The specified file already exists.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
- * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit.
- * @exception E_IO An I/O error has occurred.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SERVICE_BUSY The database is busy.
+ * @return The content ID
+ * @param[in] byteBuffer The @c byteBuffer of the content to create
+ * @param[in] destinationPath The destination file path formed by the @c byteBuffer @n
+ * The path should start with the directory path returned by either
+ * Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath().
+ * @param[in] pContentInfo A pointer to the ContentInfo instance @n
+ * If the content path exists in %ContentInfo, it gets ignored.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - There is a mismatch between the type specified in ContentInfo and the type specified in the actual content.
+ * @exception E_STORAGE_FULL The storage is full.
+ * @exception E_FILE_ALREADY_EXIST The specified file already exists.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
+ * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit.
+ * @exception E_IO An I/O error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SERVICE_BUSY The database is busy.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
ContentId CreateContent(const Tizen::Base::ByteBuffer& byteBuffer, const Tizen::Base::String& destinationPath, const ContentInfo* pContentInfo = null);
* Copies or moves the actual content to the destination path and creates the content information.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
- * @since 2.0
+ * @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompContentManagerCreateContentPage "here".
+ * For more information, see @ref CompContentManagerCreateContentPage "here".
* @endif
- * @privlevel public
- * @privilege %http://tizen.org/privilege/content.write
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/content.write
*
- * @return The content ID
- * @param[in] sourcePath The source file path @n
- * The path should be started with the directory path returned by either Tizen::App::App::GetAppRootPath()
- * or Tizen::System::Environment::GetExternalStoragePath().
- * @param[in] destinationPath The destination file path @n
- * The path should start with the directory path returned by either Tizen::System::Environment::GetMediaPath()
- * or Tizen::System::Environment::GetExternalStoragePath().
- * @param[in] deleteSource Set to @c true in order to delete the source file, @n
- * else @c false
- * @param[in] pContentInfo A pointer to the ContentInfo instance @n
- * If the content path exists in %ContentInfo, it gets ignored.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - A specified input parameter is invalid. @n
- * - There is a mismatch between the type of the source path and destination path. @n
- * - There is a mismatch between the type specified in ContentInfo and the type specified in the actual content.
+ * @return The content ID
+ * @param[in] sourcePath The source file path @n
+ * The path should start with the directory path returned by either Tizen::App::App::GetAppRootPath()
+ * or Tizen::System::Environment::GetExternalStoragePath().
+ * @param[in] destinationPath The destination file path @n
+ * The path should start with the directory path returned by either Tizen::System::Environment::GetMediaPath()
+ * or Tizen::System::Environment::GetExternalStoragePath().
+ * @param[in] deleteSource Set to @c true in order to delete the source file, @n
+ * else @c false
+ * @param[in] pContentInfo A pointer to the ContentInfo instance @n
+ * If the content path exists in %ContentInfo, it gets ignored.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - There is a mismatch between the type of the source path and the destination path.
+ * - There is a mismatch between the type specified in ContentInfo and the type specified in the actual content.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
* @exception E_STORAGE_FULL The storage is full.
* @exception E_FILE_ALREADY_EXIST The specified file already exists.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit.
- * @exception E_IO An I/O error has occurred.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IO An I/O error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SERVICE_BUSY The database is busy.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @if OSPCOMPAT
* @page CompContentManagerCreateContentPage Compatibility for the file path.
* @section CompContentManagerCreateContentPageIssueSection Issues
- * The content path argument of this method in OSP compatible applications has the following issues: @n
- * -# The content path should be a path that begins with an allowed path prefix. @n
- * For example, L"/Media/Images/flower.jpg", L"/Storagecard/Media/Images/flower.jpg".
+ * The content path argument of this method in OSP compatible applications has the following issues: @n
+ * -# The content path should be a path that begins with an allowed path prefix. @n
+ * For example, L"/Media/Images/flower.jpg", L"/Storagecard/Media/Images/flower.jpg".
*
* @section CompContentManagerCreateContentPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
- * -# The content path can be a path without a specific allowed path prefix. @n
- * Application do not need to know the specific allowed path prefixes. @n
- * To get the directory path, use the following methods: @n
- * - For accessing the home directory, use Tizen::App::App::GetInstance()->GetAppRootPath().
- * - For accessing the media directory, use Tizen::System::Environment::GetMediaPath().
- * - For accessing the external storage, use Tizen::System::Environment::GetExternalStoragePath().
+ * This issue has been resolved in Tizen. @n
+ * -# The content path can be a path without a specific allowed path prefix. @n
+ * Applications do not need to know the specific allowed path prefixes. @n
+ * To get the directory path, use the following methods: @n
+ * - For accessing the home directory, use Tizen::App::App::GetInstance()->GetAppRootPath().
+ * - For accessing the media directory, use Tizen::System::Environment::GetMediaPath().
+ * - For accessing the external storage, use Tizen::System::Environment::GetExternalStoragePath().
*
* @endif
*/
/**
* Gets the content information.
*
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/content.read
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/content.read
*
- * @return A pointer to ContentInfo
- * @param[in] contentId The content ID
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the content information corresponding to @c contentId cannot be found.
+ * @return A pointer to ContentInfo
+ * @param[in] contentId The content ID
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The content information corresponding to @c contentId cannot be found.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SERVICE_BUSY The database is busy.
* @remarks The specific error code can be accessed using the GetLastResult() method.
/**
* Updates the content information with the specified instance of ContentInfo.
*
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/content.write
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/content.write
*
- * @return An error code
- * @param[in] contentInfo An instance of ContentInfo
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @return An error code
+ * @param[in] contentInfo An instance of ContentInfo
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SERVICE_BUSY The database is busy.
*/
/**
* Deletes the content information with the specified content ID.
*
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/content.write
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/content.write
*
- * @return An error code
- * @param[in] contentId The content ID
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the content information corresponding to @c contentId cannot be found.
+ * @return An error code
+ * @param[in] contentId The content ID
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The content information corresponding to @c contentId cannot be found.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
+ * @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SERVICE_BUSY The database is busy.
* @remarks The physical file corresponding to @c contentId is deleted.
* @return An error code
* @param[in] listener The event listener to add
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_ALREADY_EXIST The listener has already been added.
+ * @exception E_OBJ_ALREADY_EXIST The listener has already been added.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks Only a listener of an instance can be added.
- * If you add more than two listeners, the listener added first will receive notification for the DB change.
+ * @remarks Only a listener of an instance can be added. If you add more than two listeners, the listener added first receives the notification for the DB change.
*/
result AddContentUpdateEventListener(IContentUpdateEventListener& listener);
* @return An error code
* @param[in] listener The event listener to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The listener is not found.
+ * @exception E_OBJ_NOT_FOUND The listener is not found.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result RemoveContentUpdateEventListener(IContentUpdateEventListener& listener);
/**
- * Requests to synchronize a specified file to the database.
+ * Requests to synchronize a specified file with the database.
*
- * @since 2.1
- * @privlevel public
- * @privilege %http://tizen.org/privilege/content.write
+ * @since 2.1
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/content.write
*
* @return An error code
* @param[in] contentPath The content path
static result ScanFile(const Tizen::Base::String& contentPath);
/**
- * Requests to synchronize files in the specified directory to the database.
+ * Requests to synchronize files in the specified directory with the database.
*
* @since 2.1
* @privlevel public
// limitations under the License.
//
/**
- * @file FCntContentManagerUtil.h
+ * @file FCntContentManagerUtil.h
* @brief This is the header file for the %ContentManagerUtil class.
*
* This header file contains the declarations of the %ContentManagerUtil class.
*
* @since 2.0
*
- * The %ContentManagerUtil class provides access to different local content types, such as image, audio, and video, and manages the content metadata.
+ * The %ContentManagerUtil class provides access to different local content types, such as images, audios, and videos, and manages the content metadata.
*
* For more information on managing the content's utility on the device, see <a href="../org.tizen.native.appprogramming/html/guide/content/device_content_mgmt.htm">Device Content Management</a>.
*
* Gets the metadata for an image from the file.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompContentManagerUtilPage "here".
+ * For more information, see @ref CompContentManagerUtilPage "here".
* @endif
*
- * @return A pointer to ImageMetadata, @n
- * else @c null if an exception occurs
- * @param[in] filePath The file path
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @return A pointer to ImageMetadata, @n
+ * else @c null if an exception occurs
+ * @param[in] filePath The file path
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @remarks
- * - If the image data is valid but meta information does not exist, the width and height are set from the actual image data.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the image data is valid but the meta information does not exist, the width and the height are set from the actual image data.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Content::ImageMetadata* GetImageMetaN(const Tizen::Base::String& filePath);
*
* @since 2.1
*
- * @return A pointer to ImageMetadata, @n
- * else @c null if an exception occurs
- * @param[in] byteBuffer The buffer that contains image data
+ * @return A pointer to ImageMetadata, @n
+ * else @c null if an exception occurs
+ * @param[in] byteBuffer The buffer that contains the image data
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @remarks
- * - If the image data in the buffer is valid but meta information does not exist, the width and height are set from the actual image data.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the image data in the buffer is valid but the meta information does not exist, the width and the height are set from the actual image data.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Content::ImageMetadata* GetImageMetaN(const Tizen::Base::ByteBuffer& byteBuffer);
* Gets the metadata for an audio from the file.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompContentManagerUtilPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompContentManagerUtilPage "here".
* @endif
*
* @return A pointer to AudioMetadata, @n
- * else @c null if an exception occurs
- * @param[in] filePath The file path
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * else @c null if an exception occurs
+ * @param[in] filePath The file path
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @remarks
- * - If the audio data is valid but meta information does not exist, the duration is set from the actual audio data.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the audio data is valid but the meta information does not exist, the duration is set from the actual audio data.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Content::AudioMetadata* GetAudioMetaN(const Tizen::Base::String& filePath);
*
* @since 2.1
*
- * @return A pointer to AudioMetadata, @n
- * else @c null if an exception occurs
- * @param[in] byteBuffer The buffer that contains audio data
+ * @return A pointer to AudioMetadata, @n
+ * else @c null if an exception occurs
+ * @param[in] byteBuffer The buffer that contains the audio data
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @remarks
- * - If the audio data in the buffer is valid but meta information does not exist, the duration is set from the actual audio data.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the audio data in the buffer is valid but the meta information does not exist, the duration is set from the actual audio data.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Content::AudioMetadata* GetAudioMetaN(const Tizen::Base::ByteBuffer& byteBuffer);
* @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompContentManagerUtilPage "here".
+ * For more information, see @ref CompContentManagerUtilPage "here".
* @endif
*
- * @return A pointer to VideoMetadata, @n
- * else @c null if an exception occurs
- * @param[in] filePath The file path
+ * @return A pointer to VideoMetadata, @n
+ * else @c null if an exception occurs
+ * @param[in] filePath The file path
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @remarks
- * - If the video data is valid but meta information does not exist, the duration is set from the actual video data.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the video data is valid but the meta information does not exist, the duration is set from the actual video data.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Content::VideoMetadata* GetVideoMetaN(const Tizen::Base::String& filePath);
*
* @since 2.1
*
- * @return A pointer to VideoMetadata, @n
- * else @c null if an exception occurs
- * @param[in] byteBuffer The buffer that contains video data
+ * @return A pointer to VideoMetadata, @n
+ * else @c null if an exception occurs
+ * @param[in] byteBuffer The buffer that contains the video data
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @remarks
- * - If the video data in the buffer is valid but meta information does not exist, the duration is set from the actual video data.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the video data in the buffer is valid but the meta information does not exist, the duration is set from the actual video data.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Content::VideoMetadata* GetVideoMetaN(const Tizen::Base::ByteBuffer& byteBuffer);
* @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompContentManagerUtilPage "here".
+ * For more information, see @ref CompContentManagerUtilPage "here".
* @endif
*
* @return The content type @n
* The value can be different for each device
- * @param[in] filePath The file path
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the length of the specified path is @c 0 or exceeds system limitations.
- * @exception E_FILE_NOT_FOUND The specified file cannot be found.
+ * @param[in] filePath The file path
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The length of the specified path is equal to @c 0 or exceeds system limitations.
+ * @exception E_FILE_NOT_FOUND The specified file cannot be found.
* @exception E_UNSUPPORTED_FORMAT The specified format is invalid or not supported.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* @if OSPDEPREC
* Copies an existing file to a new directory.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because a new method has been added. @n
- * Instead of using this method, use ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*).
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because a new method has been added. @n
+ * Instead of using this method, use ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*).
* @since 2.0
*
* @return An error code
* @param[in] srcFilePath The source file path
- * @param[in] destFilePath The destination file path
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is equal to @c 0 or exceeds system limitations. @n
- * - The specified path contains prohibited character(s). @n
- * - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * @param[in] destFilePath The destination file path
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is equal to @c 0 or exceeds system limitations.
+ * - The specified path contains prohibited character(s).
+ * - The specified path is invalid.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
* @exception E_FILE_ALREADY_EXIST The specified file already exists.
* @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit.
* @exception E_STORAGE_FULL The disk space is full.
- * @exception E_IO Either of the following conditions has occurred: @n
- * - An unexpected device failure has occurred as the media ejected suddenly. @n
- * - File corruption is detected. @n
- * - The volume or quota is no more available.
+ * @exception E_IO Either of the following conditions has occurred:
+ * - An unexpected device failure has occurred as the media ejected suddenly.
+ * - %File corruption is detected.
+ * - The volume or quota is no more available.
* @remarks
* - The source file in the system region cannot be copied.
* - The destination file path must start with @c '/Media' or @c '/Storagecard/Media'.
* @if OSPDEPREC
* Moves the file to a new directory.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because a new method has been added. @n
- * Instead of using this method, use ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*).
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because a new method has been added. @n
+ * Instead of using this method, use ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*).
* @since 2.0
*
* @return An error code
* @param[in] srcFilePath The source file path
- * @param[in] destFilePath The destination file path
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is equal to @c 0 or exceeds system limitations. @n
- * - The specified path contains prohibited character(s). @n
- * - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * @param[in] destFilePath The destination file path
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is equal to @c 0 or exceeds system limitations.
+ * - The specified path contains prohibited character(s).
+ * - The specified path is invalid.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
* @exception E_FILE_ALREADY_EXIST The specified file already exists.
* @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit.
* @exception E_STORAGE_FULL The disk space is full.
- * @exception E_IO Either of the following conditions has occurred: @n
- * - An unexpected device failure has occurred as the media ejected suddenly. @n
- * - File corruption is detected. @n
- * - The volume or quota is no more available.
+ * @exception E_IO Either of the following conditions has occurred:
+ * - An unexpected device failure has occurred as the media ejected suddenly.
+ * - %File corruption is detected.
+ * - The volume or quota is no more available.
* @remarks
* - The source file in the system region cannot be copied.
* - The destination file path must start with @c '/Media' or @c '/Storagecard/Media'.
* @if OSPCOMPAT
* @page CompContentManagerUtilPage Compatibility for the file path.
* @section CompContentManagerUtilPageIssueSection Issues
- * The file path argument of this method in OSP compatible applications has the following issues: @n
- * -# The file path should be a path that begins with an allowed path prefix. @n
- * For example, L"/Media/Images/flower.jpg", "/Storagecard/Media/Images/flower.jpg".
+ * The file path argument of this method in OSP compatible applications has the following issues: @n
+ * -# The file path should be a path that begins with an allowed path prefix. @n
+ * For example, L"/Media/Images/flower.jpg", "/Storagecard/Media/Images/flower.jpg".
*
* @section CompContentManagerUtilPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
- * -# The file path can be a path without a specific allowed path prefix. @n
- * Application do not need to know the specific allowed path prefixes. @n
- * To get the directory path, use the following methods: @n
- * - For accessing the home directory, use Tizen::App::App::GetInstance()->GetAppRootPath().
- * - For accessing the media directory, use Tizen::System::Environment::GetMediaPath().
- * - For accessing the external storage, use Tizen::System::Environment::GetExternalStoragePath().
+ * This issue has been resolved in Tizen. @n
+ * -# The file path can be a path without a specific allowed path prefix. @n
+ * Applications do not need to know the specific allowed path prefixes. @n
+ * To get the directory path, use the following methods: @n
+ * - For accessing the home directory, use Tizen::App::App::GetInstance()->GetAppRootPath().
+ * - For accessing the media directory, use Tizen::System::Environment::GetMediaPath().
+ * - For accessing the external storage, use Tizen::System::Environment::GetExternalStoragePath().
*
* @endif
*/
/**
* @class ContentSearch
- * @brief This class provides methods for the content search.
+ * @brief This class provides methods to search content.
*
* @since 2.0
*
*
* @return An error code
* @param[in] type The content type @n
- * Only @c CONTENT_TYPE_OTHER, @c CONTENT_TYPE_IMAGE,
- * @c CONTENT_TYPE_AUDIO, or @c CONTENT_TYPE_VIDEO is supported.
+ * Only @c CONTENT_TYPE_OTHER, @c CONTENT_TYPE_IMAGE,
+ * @c CONTENT_TYPE_AUDIO, and @c CONTENT_TYPE_VIDEO is supported.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* Searches the content and returns the search result list according to the query.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/content.read
*
- * @return A pointer to a list containing the ContentSearchResult instances @n
- * An empty list is returned if there is no result and there is no error, @n
+ * @return A pointer to the list that contains the ContentSearchResult instances @n
+ * An empty list is returned if there is no result or error, @n
* else @c null if an exception occurs.
- * @param[in] pageNo The page number @n
- * It must be equal to or greater than @c 1.
- * @param[in] countPerPage The count of the search results per page @n
- * It must be equal to or greater than @c 1.
- * @param[out] totalPageCount The total page count of the search result
- * @param[out] totalCount The total count of the search result
- * @param[in] whereExpr The search condition like an sql "where" expression style @n
- * If it uses the default value, L"", it searches for all the content of the content type set in the constructor. @n
- * In case of the "DateTime" condition, the range starts from '01/01/1970 00:00:00'. @n
- * Every type of value has to be covered with single quotation marks, even if it is a decimal type.
- * @param[in] sortColumn The sort <a href="../org.tizen.native.appprogramming/html/guide/content/content_search_device.htm">column</a> @n
- * The default value is @c L"".
- * @param[in] sortOrder The sort order
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The specified @c column is either invalid or empty. @n
- * - The content is searched with @c type set as ::CONTENT_TYPE_UNKNOWN. @n
- * - The length of the specified @c whereExpr parameter exceeds @c 512 characters.
+ * @param[in] pageNo The page number @n
+ * It must be greater than or equal to @c 1.
+ * @param[in] countPerPage The count of the search results per page @n
+ * It must be greater than or equal to @c 1.
+ * @param[out] totalPageCount The total page count of the search result
+ * @param[out] totalCount The total count of the search result
+ * @param[in] whereExpr The search condition like an sql "where" expression style @n
+ * If it uses the default value, L"", it searches for all the content of the content type set in the constructor @n
+ * In case of the "DateTime" condition, the range starts from '01/01/1970 00:00:00' @n
+ * Every type of value has to be enclosed in single quotation marks, even if it is a decimal type.
+ * @param[in] sortColumn
The sort <a href="../org.tizen.native.appprogramming/html/guide/content/content_search_device.htm">column</a> @n
+ * The default value is @c L"".
+ * @param[in] sortOrder The sort order
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c column is either invalid or empty.
+ * - The content is searched with @c type set to ::CONTENT_TYPE_UNKNOWN.
+ * - The length of the specified @c whereExpr exceeds @c 512 characters.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - The return value must be deleted.
Tizen::Base::Collection::IList* SearchN(int pageNo, int countPerPage, int& totalPageCount, int& totalCount, const Tizen::Base::String& whereExpr = L"", const Tizen::Base::String& sortColumn = L"", Tizen::Base::SortOrder sortOrder = Tizen::Base::SORT_ORDER_NONE) const;
/**
- * Gets the value list of the specified column within a specified range.
+ * Gets the value list of the specified column within the specified range.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/content.read
*
- * @return A pointer to a list containing the values of a column @n
- * The type of value can be Tizen::Base::Float, Tizen::Base::Double, Tizen::Base::LongLong, Tizen::Base::DateTime, or Tizen::Base::String. @n
+ * @return A pointer to the list that contains the values of the column @n
+ * The type of value can be Tizen::Base::Float, Tizen::Base::Double, Tizen::Base::LongLong, Tizen::Base::DateTime, or Tizen::Base::String @n
* An empty list is returned if the specified column has no value and there is no error, @n
* else @c null if an exception occurs.
- * @param[in] pageNo The page number @n
- * It must be equal to or greater than @c 1.
- * @param[in] countPerPage The count of the value list per page @n
- * It must be equal to or greater than @c 1.
- * @param[out] totalPageCount The total page count of the value list
- * @param[out] totalCount The total count of the value list
- * @param[in] column The <a href="../org.tizen.native.appprogramming/html/guide/content/content_search_device.htm">column</a> name
- * @param[in] sortOrder The sort order
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c column is either invalid or empty, or
- * the content is searched with @c type set as ::CONTENT_TYPE_UNKNOWN.
+ * @param[in] pageNo The page number @n
+ * It must be greater than or equal to @c 1.
+ * @param[in] countPerPage The count of the value list per page @n
+ * It must be greater than or equal to @c 1.
+ * @param[out] totalPageCount The total page count of the value list
+ * @param[out] totalCount The total count of the value list
+ * @param[in] column The <a href="../org.tizen.native.appprogramming/html/guide/content/content_search_device.htm">column</a> name
+ * @param[in] sortOrder The sort order
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c column is either invalid or empty.
+ * - The content is searched with @c type set to ::CONTENT_TYPE_UNKNOWN.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
- * - The return value must be deleted. @n
- * The result of GetValueListN() returns a distinct value.
+ * - The return value must be deleted.
+ * - The result of GetValueListN() returns a distinct value.
* - ContentType supports ::CONTENT_TYPE_OTHER, ::CONTENT_TYPE_IMAGE, ::CONTENT_TYPE_AUDIO, and ::CONTENT_TYPE_VIDEO. @n
- * If %ContentType in Construct() uses ::CONTENT_TYPE_UNKNOWN or an invalid value, @c E_INVALID_ARG occurs.
+ * If %ContentType in Construct() uses ::CONTENT_TYPE_UNKNOWN or an invalid value, @c E_INVALID_ARG occurs.
*
* The following example demonstrates how to use the %GetValueListN() method.
*
/**
* @if OSPDEPREC
- * Gets the list consisting of values of a specified column in the specified order.
+ * Gets the list consisting of the values of the specified column in the specified order.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. Instead of using this method, it is recommended to use the GetValueListN(int, int, int&, int&, const Tizen::Base::String&, @n
* @privlevel public
* @privilege %http://tizen.org/privilege/content.read
*
- * @return A pointer to a list containing the values of a column @n
- * The type of value can be Tizen::Base::Integer, Tizen::Base::Double, Tizen::Base::LongLong, Tizen::Base::DateTime, or Tizen::Base::String. @n
+ * @return A pointer to the list that contains the values of the column @n
+ * The type of value can be Tizen::Base::Integer, Tizen::Base::Double, Tizen::Base::LongLong, Tizen::Base::DateTime, or Tizen::Base::String @n
* An empty list is returned if the specified column has no value and there is no error, @n
* else @c null if an exception occurs.
- * @param[in] column The <a href="../org.tizen.native.appprogramming/html/guide/content/content_search_device.htm">column</a> name
- * @param[in] sortOrder The sort order
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c column is either invalid or empty, or the content is searched with @c type set as CONTENT_TYPE_UNKNOWN.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] column The <a href="../org.tizen.native.appprogramming/html/guide/content/content_search_device.htm">column</a> name
+ * @param[in] sortOrder The sort order
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c column is either invalid or empty.
+ * - The content is searched with @c type set to ::CONTENT_TYPE_UNKNOWN.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - The return value must be deleted. @n
- * The result of GetValueListN() returns a distinct value.
+ * - The result of GetValueListN() returns a distinct value.
* - ContentType supports ::CONTENT_TYPE_OTHER, ::CONTENT_TYPE_IMAGE, ::CONTENT_TYPE_AUDIO, and ::CONTENT_TYPE_VIDEO. @n
- * If %ContentType in Construct() uses ::CONTENT_TYPE_UNKNOWN or an invalid value, @c E_INVALID_ARG occurs.
+ * If %ContentType in Construct() uses ::CONTENT_TYPE_UNKNOWN or an invalid value, @c E_INVALID_ARG occurs.
*
* The following example demonstrates how to use the %GetValueListN() method.
*
* @class ContentTransfer
* @brief <i> [Deprecated] </i> This class provides methods to download the content.
*
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
* The %ContentTransfer class provides the following features:
* For full construction, the Construct(IContentTransferListener&) method must be called right after calling this constructor.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
* @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance.
* This destructor overrides Tizen::Base::Object::~Object().
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
*
* @since 2.0
*/
* The %Construct() method should be called after every instance of %ContentTransfer is constructed.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
* @return An error code
* @privlevel public
* @privilege %http://tizen.org/privilege/download
*
- * @return An error code
- * @param[in] uri The content URL
- * @param[in] fileSize The content file size in bytes @n
- * If set to @c 0, the method does not check the storage limitation.
- * @param[in] destFilePath The full destination path
- * @param[in] replace The replace option of the destination file @n
- * Set to @c true to replace the file, @n
- * else @c false.
- * @param[out] reqId The request ID
- * @param[in] pListener A pointer to the IContentTransferListener instance
- * @param[in] sec The timeout period in seconds
+ * @return An error code
+ * @param[in] uri The content URL
+ * @param[in] fileSize The content file size in bytes @n
+ * If set to @c 0, the method does not check the storage limitation.
+ * @param[in] destFilePath The full destination path
+ * @param[in] replace The replace option of the destination file @n
+ * Set to @c true to replace the file, @n
+ * else @c false.
+ * @param[out] reqId The request ID
+ * @param[in] pListener A pointer to the IContentTransferListener instance
+ * @param[in] sec The timeout period in seconds
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_ALREADY_EXIST The specified file already exists.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_IN_PROGRESS A previous request is in progress.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @see IContentTransferListener::OnContentDownloadCompleted()
* @see IContentTransferListener::OnContentTransferInProgress()
*/
* When the data is being downloaded, the application is notified of the progress using the IContentTransferListener::OnContentTransferInProgress() method.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompContentTransferDownloadPage3 "here".
+ * For more information, see @ref CompContentTransferDownloadPage3 "here".
* @endif
- * @privlevel public
- * @privilege %http://tizen.org/privilege/download
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/download
*
- * @return An error code
- * @param[in] uri The content URL
- * @param[in] filePath The destination file path @n
- * Use Tizen::System::Environment::GetMediaPath(), Tizen::System::Environment::GetExternalStoragePath() and Tizen::App::App::GetInstance()->GetAppRootPath().
- * @param[out] reqId The request ID
- * @param[in] replace The replace option of the destination file @n
- * Set to @c true to replace the file, @n
+ * @return An error code
+ * @param[in] uri The content URL
+ * @param[in] filePath The destination file path @n
+ * Use Tizen::System::Environment::GetMediaPath(), Tizen::System::Environment::GetExternalStoragePath() and Tizen::App::App::GetInstance()->GetAppRootPath().
+ * @param[out] reqId The request ID
+ * @param[in] replace The replace option of the destination file @n
+ * Set to @c true to replace the file, @n
* else @c false.
- * @param[in] timeout The timeout period in seconds
- * @param[in] progressInterval The progress period interval as a percentage value
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
- * @exception E_FILE_ALREADY_EXIST The specified file already exists.
- * @exception E_IN_PROGRESS A previous request is in progress.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
+ * @param[in] timeout The timeout period in seconds
+ * @param[in] progressInterval The progress period interval as a percentage value
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
+ * @exception E_FILE_ALREADY_EXIST The specified file already exists.
+ * @exception E_IN_PROGRESS A previous request is in progress.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @remarks
- * - The @c progressInterval is the interval of the progress for each download request. If the value of the @c progressInterval is @c 0, the @c progressInterval uses the value set by the ContentTransfer::SetProgressIntervalByPercent(int). The @c progressInterval is a percentage value between @c 0 and @c 100.
- * - The @c timeout is the value of the response timeout for each download request. If the value of the @c timeout is @c 0, the value for the @c timeout uses the value set by the ContentTransfer::SetDefaultTimeout(int).
+ * - The @c progressInterval is the interval of the progress for each download request. If the value of the @c progressInterval is @c 0, the
+ * @c progressInterval uses the value set by the ContentTransfer::SetProgressIntervalByPercent(int). The @c progressInterval is a percentage
+ * value between @c 0 and @c 100.
+ * - The @c timeout is the value of the response timeout for each download request. If the value of the @c timeout is @c 0, the value for the
+ * @c timeout uses the value set by the ContentTransfer::SetDefaultTimeout(int).
* @see IContentTransferListener::OnContentDownloadCompleted()
* @see IContentTransferListener::OnContentTransferInProgress()
*/
/**
* @if OSPCOMPAT
- * @page CompContentTransferDownloadPage3 Compatibility for the file path.
+ * @page CompContentTransferDownloadPage3 Compatibility for the file path.
* @section CompContentTransferDownloadPageIssueSection Issues
- * The content path argument of this method in OSP compatible applications has the following issues: @n
- * -# The content path should be a path that begins with an allowed path prefix. @n
- * For example, L"/Media/Images/flower.jpg", "/Storagecard/Media/Images/flower.jpg".
+ * The content path argument of this method in OSP compatible applications has the following issues: @n
+ * -# The content path should be a path that begins with an allowed path prefix. @n
+ * For example, L"/Media/Images/flower.jpg", "/Storagecard/Media/Images/flower.jpg".
*
* @section CompImageContentInfoConstructPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
- * -# The content path can be a path without a specific allowed path prefix. @n
- * Application do not need to know the specific allowed path prefixes. @n
- * To get the directory path, use the following methods: @n
- * - For accessing the media directory, use Tizen::System::Environment::GetMediaPath().
- * - For accessing the external storage, use Tizen::System::Environment::GetExternalStoragePath().
+ * This issue has been resolved in Tizen. @n
+ * -# The content path can be a path without a specific allowed path prefix. @n
+ * Applications do not need to know the specific allowed path prefixes. @n
+ * To get the directory path, use the following methods: @n
+ * - For accessing the media directory, use Tizen::System::Environment::GetMediaPath().
+ * - For accessing the external storage, use Tizen::System::Environment::GetExternalStoragePath().
*
* @endif
*/
/**
- * Downloads a content file to a buffer from the content provider's servers. @n
+ * Downloads a content file from the content provider's servers into a buffer. @n
* The %DownloadToBuffer() method does not register the content. @n
* When the download is completed, the application is notified using the IContentTransferListener::OnContentDownloadToBufferCompleted() method. @n
* When the data is being downloaded, the application is notified of the progress using the IContentTransferListener::OnContentTransferInProgress() method.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated due to the operation policy of the Tizen Server.
- * When downloading the contents to a buffer from a third party server, it is recommended to use the DownloadToBuffer(const Tizen::Base::Utility::Uri&, RequestId&, int, int) method.
- * @since 2.0
+ * When downloading the contents into a buffer from a third party server, it is recommended to use the DownloadToBuffer(const Tizen::Base::Utility::Uri&, RequestId&, int, int) method.
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/download
*
* @return An error code
- * @param[in] uri The content URL
- * @param[in] fileSize The content file size in bytes @n
- * If set to @c 0, the method does not check the storage limitation.
- * @param[out] reqId The request ID
- * @param[in] pListener A pointer to the IContentTransferListener instance
- * @param[in] sec The timeout period in seconds
+ * @param[in] uri The content URL
+ * @param[in] fileSize The content file size in bytes @n
+ * If set to @c 0, the method does not check the storage limitation.
+ * @param[out] reqId The request ID
+ * @param[in] pListener A pointer to the IContentTransferListener instance
+ * @param[in] sec The timeout period in seconds
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
+ * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @see IContentTransferListener::OnContentDownloadToBufferCompleted()
* @see IContentTransferListener::OnContentTransferInProgress()
*/
result DownloadToBuffer(const Tizen::Base::Utility::Uri& uri, int fileSize, RequestId& reqId, IContentTransferListener* pListener = null, int sec = 0);
/**
- * Downloads a content file to a buffer from the content provider's servers. @n
+ * Downloads a content file from the content provider's servers into a buffer . @n
* The %DownloadToBuffer() method does not register the content. @n
* When the download is completed, the application is notified using the IContentTransferListener::OnContentDownloadToBufferCompleted() method. @n
* When the data is being downloaded, the application is notified of the progress using the IContentTransferListener::OnContentTransferInProgress() method.
*
* @brief <i> [Deprecated] </i>
* @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/download
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/download
*
- * @return An error code
+ * @return An error code
* @param[in] uri The content URL
* @param[out] reqId The request ID
* @param[in] timeout The timeout period in seconds
* @param[in] progressInterval The progress period interval as a percentage value
* @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_IN_PROGRESS A previous request is in progress.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @remarks
- * - The @c progressInterval is the interval of the progress for each download request. If the value of the @c progressInterval is @c 0, the @c progressInterval uses the value set by the ContentTransfer::SetProgressIntervalByPercent(int). The @c progressInterval is a percentage value between @c 0 and @c 100.
- * - The @c timeout is the value of the response timeout for each download request. If the value of the @c timeout is @c 0, the value for the @c timeout uses the value set by the ContentTransfer::SetDefaultTimeout(int).
+ * - The @c progressInterval is the interval of the progress for each download request. If the value of the @c progressInterval is @c 0, the
+ * @c progressInterval uses the value set by the ContentTransfer::SetProgressIntervalByPercent(int). The @c progressInterval is a percentage
+ * value between @c 0 and @c 100.
+ * - The @c timeout is the value of the response timeout for each download request. If the value of the @c timeout is @c 0, the value for the
+ * @c timeout uses the value set by the ContentTransfer::SetDefaultTimeout(int).
* @see IContentTransferListener::OnContentDownloadToBufferCompleted()
* @see IContentTransferListener::OnContentTransferInProgress()
*/
* @c 0 or minus second means unlimited period.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
* @param[in] sec The default timeout period in seconds @n
- * The default value is @c 0.
+ * The default value is @c 0
*/
void SetDefaultTimeout(int sec);
* Gets the default timeout period.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
* @return The default timeout period
* A download operation in progress is not removed by this operation.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
* @return An error code
- * @param[in] reqId The request ID
+ * @param[in] reqId The request ID
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_NOT_FOUND The specified @c reqId is not found.
- * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OBJ_NOT_FOUND The specified @c reqId is not found.
+ * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
* @remarks To stop an on-going transfer, use the Cancel() method.
*/
result Remove(RequestId reqId);
* The download operations in progress are not removed by this operation.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
* @remarks To stop an on-going transfer, use the Cancel() method.
*/
result RemoveAll(void);
/**
* Cancels a transfer operation. @n
* The downloaded file is deleted from the file system. @n
- * When a transfer download operation is canceled, the application is notified via the IContentTransferListener::OnContentTransferCanceled() method.
+ * When a transfer download operation is cancelled, the application is notified through the IContentTransferListener::OnContentTransferCanceled() method.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
* @return An error code
- * @param[in] reqId The request ID
+ * @param[in] reqId The request ID
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c reqId is not found.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
+ * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
* @see IContentTransferListener::OnContentTransferCanceled()
*/
result Cancel(RequestId reqId);
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
*/
result CancelAll(void);
* Gets the content transfer information list.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
- * @return A pointer to a list containing the ContentTransferInfo instances, @n
- * else an empty list if there is no result and no error
+ * @return A pointer to the list that contains the ContentTransferInfo instances, @n
+ * else an empty list is returned if there is no result or error
*/
Tizen::Base::Collection::IList* GetContentTransferInfoListN(void) const;
* Gets the list of transfers that are in progress.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
- * @return A pointer to a list containing the ContentTransferInfo instances, @n
- * else an empty list if there is no result and no error
+ * @return A pointer to the list that contains the ContentTransferInfo instances, @n
+ * else an empty list is retuned if there is no result or error
*/
Tizen::Base::Collection::IList* GetContentTransferInfoListInProgressN(void) const;
/**
* Sets the interval of the progress. @n
* The input is a percentage value between @c 0 and @c 100. The default value is @c 0.
- * @c 0 means the application would not receive progress events.
+ * @c 0 means the application does not receive progress events.
*
* @brief <i> [Deprecated] </i>
* @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
*
* @param[in] percent The progress period interval as a percentage value
* @remarks If a server does not provide the information about the content size, then the content module cannot verify the information. @n
- * In that case, progress event will occur randomly.
+ * In that case, the progress event will occur randomly.
*/
void SetProgressIntervalByPercent(int percent);
*/
enum ContentTransferStatus
{
- CONTENT_TRANSFER_STATUS_NONE, /**< @if OSPDEPREC None @endif */
- CONTENT_TRANSFER_STATUS_DOWNLOADING, /**< @if OSPDEPREC The Downloading status @endif*/
- CONTENT_TRANSFER_STATUS_DOWNLOAD_COMPLETED, /**< @if OSPDEPREC The Download completed status @endif*/
- CONTENT_TRANSFER_STATUS_DOWNLOAD_READY, /**< @if OSPDEPREC The Download ready status @endif*/
+ CONTENT_TRANSFER_STATUS_NONE, /**< @if OSPDEPREC None @endif */
+ CONTENT_TRANSFER_STATUS_DOWNLOADING, /**< @if OSPDEPREC The downloading status @endif */
+ CONTENT_TRANSFER_STATUS_DOWNLOAD_COMPLETED, /**< @if OSPDEPREC The download completed status @endif */
+ CONTENT_TRANSFER_STATUS_DOWNLOAD_READY, /**< @if OSPDEPREC The download ready status @endif */
};
/**
* @if OSPDEPREC
* @class ContentTransferInfo
- * @brief <i> [Deprecated] </i> This class contains methods that provide information about the content transfer.
+ * @brief <i> [Deprecated] </i> This class contains methods that provide information about content transfer.
*
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
- * The %ContentTransferInfo class provides information about the transfer of content between the device and servers.
+ * The %ContentTransferInfo class provides information about the transfer of content between the device and the servers.
* @endif
*/
class _OSP_EXPORT_ ContentTransferInfo
* This is the constructor for this class.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*/
ContentTransferInfo(void);
* This destructor overrides Tizen::Base::Object::~Object().
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*/
virtual ~ContentTransferInfo(void);
* Gets the requested Uniform Resource Identifier (URI).
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
* @return The requested URI
* Gets the request ID.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
* @return The request ID
* Gets the destination file path.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
* @return The destination file path
Tizen::Base::String GetDestPath(void) const;
/**
- * Gets the content transfer's status.
+ * Gets the content transfer status.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
- * @return The content transfer's status
+ * @return The content transfer status
*/
ContentTransferStatus GetContentTransferStatus(void) const;
*
* @final This class is not intended for extension.
*
-* The %DownloadManager class provides methods to handle HTTP downloads. A download request consists of a URL and a destination path; of which the URL is mandatory for downloading content. If the destination path is not specified, the content is downloaded to a default download storage that can be obtained with the System::Environment::GetDefaultDownloadPath() method.
-* This class conducts the download in the background and calls the Start() method that takes care of HTTP connections. @n
+* The %DownloadManager class provides methods to handle HTTP downloads. A download request consists of a URL and a destination path; of which the URL is mandatory for downloading the content. If the destination path is not specified, the content is downloaded to a default download storage that can be obtained with the System::Environment::GetDefaultDownloadPath() method.
+* This class conducts the download in the background and calls the Start() method that takes care of the HTTP connections. @n
* The download operation can be:
* - Paused by calling the Pause() method
* - Resumed by calling the Resume() method
* Depending on how the download operation is terminated the following methods are called:
* - IDownloadListener::OnDownloadCanceled() when the download is cancelled
* - IDownloadListener::OnDownloadCompleted() when the download is completed without any errors
-* - IDownloadListener::OnDownloadFailed() when the download has been stopped because of an error
+* - IDownloadListener::OnDownloadFailed() when the download is stopped because of an error
*
* The following example demonstrates how to use the %DownloadManager class.
*
{
public:
/**
- * Gets the download manager instance of an application.
+ * Gets the download manager instance of the application.
*
* @since 2.0
*
- * @return A pointer to the %DownloadManager instance, @n
- * else @c null if it fails
+ * @return A pointer to the %DownloadManager instance, @n
+ * else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @privilege %http://tizen.org/privilege/download
*
* @return An error code
- * @param[in] request The download request
- * @param[out] reqId The request ID
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The information of the download request is invalid.
- * @exception E_ILLEGAL_ACCESS Access to the path of the download request is denied due to insufficient permission.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @param[in] request The download request
+ * @param[out] reqId The request ID
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The information of the download request is invalid.
+ * @exception E_ILLEGAL_ACCESS The access to the path of the download request is denied due to insufficient permission.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result Start(const DownloadRequest& request, RequestId& reqId);
* @param[in] reqId The request ID returned by Start()
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG There is no download request for the specified @c reqId.
- * @exception E_INVALID_OPERATION The current download state prohibits the execution of this operation. @n
- * The download state of the request ID is not downloading.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current download state prohibits the execution of this operation.
+ * - The download state of the request ID is not downloading.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result Pause(RequestId reqId);
* @param[in] reqId The request ID returned by Start()
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG There is no download request for the specified @c reqId.
- * @exception E_INVALID_OPERATION The current download state prohibits the execution of this operation. @n
- * The download state for the specified request ID is either not paused or has failed.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current download state prohibits the execution of this operation.
+ * - The download state for the specified request ID is either not paused or has failed.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result Resume(RequestId reqId);
* @since 2.0
*
* @return The download request @n
- * The download request information is available for at least the next 24 hours after IDownloadListener::OnDownloadCompleted() has been called.
+ * The download request information is available for at least the next 24 hours after IDownloadListener::OnDownloadCompleted() is called.
* @param[in] reqId The request ID returned by Start()
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG There is no download request for the specified @c reqId.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
DownloadRequest* GetDownloadRequestN(RequestId reqId) const;
* @since 2.0
*
* @return The download state @n
- * The download state information is available for at least the next 24 hours after IDownloadListener::OnDownloadCompleted() has been called.
+ * The download state information is available for at least the next 24 hours after IDownloadListener::OnDownloadCompleted() is called.
* @param[in] reqId The request ID returned by Start()
*/
DownloadState GetState(RequestId reqId) const;
* @return An error code
* @param[in] reqId The request ID returned by Start()
* @param[out] mimeType The MIME type @n
- * The MIME type information is available for at least the next 24 hours after IDownloadListener::OnDownloadCompleted() has
- * been called.
+ * The MIME type information is available for at least the next 24 hours after IDownloadListener::OnDownloadCompleted()
+ * is called.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG There is no download request for the specified @c reqId.
- * @exception E_INVALID_OPERATION The current download state prohibits the execution of this operation. @n
- * The download operation has not yet started.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current download state prohibits the execution of this operation.
+ * - The download operation has not yet started.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result GetMimeType(RequestId reqId, Tizen::Base::String& mimeType) const;
/**
- * Sets a download listener.
+ * Sets the download listener.
*
* @since 2.0
*
* @param[in] pListener The download listener @n
- * If this is @c null, it unsets the download listener.
+ * If this is @c null, it unsets the download listener
*/
void SetDownloadListener(IDownloadListener* pListener);
*
* @final This class is not intended for extension.
*
-* The %DownloadRequest class provides information of a download request. It provides the URL of a download request, which is mandatory information. It also provides the destination directory path and the file name. The destination directory path and file name can be set by the SetDirectoryPath() and SetFileName() methods. @n
-* If the download path is not specified, the data will be downloaded to the default download directory returned by Tizen::System::Environment::GetDefaultDownloadPath().
+* The %DownloadRequest class provides information of a download request. It provides the URL of a download request, which is the mandatory information. It also provides the destination directory path and the file name. The destination directory path and file name can be set by the SetDirectoryPath() and SetFileName() methods. @n
+* If the download path is not specified, the data is downloaded to the default download directory returned by Tizen::System::Environment::GetDefaultDownloadPath().
*
*/
* @since 2.0
*
* @param[in] url The URL of the download request
- * @param[in] dirPath The directory path of the data that will be downloaded
+ * @param[in] dirPath The directory path of the data that is downloaded
*/
DownloadRequest(const Tizen::Base::String& url, const Tizen::Base::String& dirPath);
* Copying of objects using this copy assignment operator is allowed.
*
* @return A reference to this instance
- * @param[in] rhs An instance of %DownloadRequest
+ * @param[in] rhs An instance of %DownloadRequest to copy
*/
DownloadRequest& operator =(const DownloadRequest& rhs);
virtual int GetHashCode(void) const;
/**
- * Sets the directory path of the data that will be downloaded.
+ * Sets the directory path of the data that is downloaded.
*
* @since 2.0
*
void SetDirectoryPath(const Tizen::Base::String& dirPath);
/**
- * Sets the file name of the data to be downloaded.
+ * Sets the file name of the data that is downloaded.
*
* @since 2.0
*
void SetFileName(const Tizen::Base::String& fileName);
/**
- * Gets the URL of a download request.
+ * Gets the URL of the download request.
*
* @since 2.0
*
Tizen::Base::String GetUrl(void) const;
/**
- * Gets the directory path of the data that will be downloaded.
+ * Gets the directory path of the data that is downloaded.
*
* @since 2.0
*
Tizen::Base::String GetDirectoryPath(void) const;
/**
- * Gets the file name of the data to be downloaded.
+ * Gets the file name of the data that is downloaded.
*
* @since 2.0
*
/**
* Determines whether the system should show the download notification or not. @n
* If @c true, the system posts notifications about this download request through the Tizen::Shell::NotificationManager. @n
- * By default, this value sets to @c true.
+ * By default, this value is set to @c true.
*
* @since 2.1
*
/**
* Sets extra data that is delivered to the application when the notification message is selected. @n
- * The extra data will be passed to the application through the
+ * The extra data is passed to the application through the
* Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived() method.
*
* @since 2.1
*
- * @return An error code
- * @param[in] pExtraData A pointer to an argument map of the Tizen::Base::String key and the Tizen::Base::String value pair
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] pExtraData A pointer to the argument map of the Tizen::Base::String key and the %Tizen::Base::String value pair
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred:
- * - The argument is @c null.
- * - The argument is not a map of the Tizen::Base::String key and the Tizen::Base::String value pair.
+ * - The argument is @c null.
+ * - The argument is not a map of the Tizen::Base::String key and the %Tizen::Base::String value pair.
* @see Tizen::Shell::NotificationManager
*/
result SetNotificationExtraData(const Tizen::Base::Collection::IMap *pExtraData);
/**
- * Sets an allowed network type. @n
+ * Sets the allowed network type. @n
* By default, all network types are allowed.
*
* @since 2.1
* @since 2.1
*
* @return @c true if the system should show a notification for this download request, @n
- * else @c false
+ * else @c false
*/
bool IsNotificationEnabled(void) const;
/**
- * Gets extra data that is delivered to the application when the notification message is selected.
+ * Gets the extra data that is delivered to the application when the notification message is selected.
*
* @since 2.1
*
- * @return The extra data map that consists of the Tizen::Base::String key and the Tizen::Base::String value pair
+ * @return The extra data map that consists of the Tizen::Base::String key and the %Tizen::Base::String value pair
*/
const Tizen::Base::Collection::IMap* GetNotificationExtraData(void) const;
/**
- * Gets an allowed network type.
+ * Gets the allowed network type.
*
* @since 2.1
*
DownloadNetworkType GetNetworkType(void) const;
/**
- * Adds an HTTP header field.
+ * Adds the HTTP header field.
*
* @since 2.1
*
- * @return An error code
- * @param[in] field The HTTP header field
- * @param[in] value The value of the header field
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the field is empty or it already exists.
+ * @return An error code
+ * @param[in] field The HTTP header field
+ * @param[in] value The value of the header field
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either the field is empty or it already exists.
*/
result AddRequestHeader(const Tizen::Base::String& field, const Tizen::Base::String& value);
/**
- * Sets an HTTP header field.
+ * Sets the HTTP header field.
*
* @since 2.1
*
- * @return An error code
- * @param[in] field The HTTP header field
- * @param[in] value The value of the header field
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the field is empty or it does not exist.
+ * @return An error code
+ * @param[in] field The HTTP header field
+ * @param[in] value The value of the header field
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either the field is empty or it does not exist.
*/
result SetRequestHeader(const Tizen::Base::String& field, const Tizen::Base::String& value);
/**
- * Removes an HTTP header field.
+ * Removes the HTTP header field.
*
* @since 2.1
*
- * @return An error code
- * @param[in] field The HTTP header field
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the field is empty or it does not exist.
+ * @return An error code
+ * @param[in] field The HTTP header field
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either the field is empty or it does not exist.
*/
result RemoveRequestHeader(const Tizen::Base::String& field);
/**
- * Gets the value of an HTTP header field.
+ * Gets the value of the HTTP header field.
*
* @since 2.1
*
- * @return The value of the HTTP header field if successful, @n
- * else @c null if there is no HTTP header field
- * @param[in] field The HTTP header field
+ * @return The value of the HTTP header field if successful, @n
+ * else @c null if there is no HTTP header field
+ * @param[in] field The HTTP header field
*/
Tizen::Base::String* GetRequestHeaderN(const Tizen::Base::String& field);
virtual ~IContentScanListener(void) {}
/**
- * Called when a scan operation is completed.
+ * Called when the scan operation is completed.
*
* @since 2.1
*
* @param[in] reqId The request ID returned by ContentManager::ScanDirectory()
* @param[in] scanPath The scan path
- * @param[in] r The error of scan operation @n
+ * @param[in] r The error of the scan operation @n
* The following exceptions are given through this parameter.
* @exception E_SUCCESS The method is successful
* @exception E_SERVICE_BUSY The database is busy.
//
/**
* @if OSPDEPREC
- * @file FCntIContentTransferListener.h
+ * @file FCntIContentTransferListener.h
* @brief This is the header file for the %IContentTransferListener interface.
*
* This header file contains the declarations of the %IContentTransferListener interface.
/**
* @if OSPDEPREC
* @interface IContentTransferListener
- * @brief <i> [Deprecated] </i> This interface provides event handlers that receive the events associated with ContentTransfer.
+ * @brief <i> [Deprecated] </i> This interface provides event handlers that receive the events associated with %ContentTransfer.
*
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
* The %IContentTransferListener interface handles the content download events.
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*/
virtual ~IContentTransferListener(void) {}
* Called when the content transfer is in progress.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
- * @param[in] reqId The request ID
+ * @param[in] reqId The request ID
* @param[in] totalTransferedSize The total size of the data to transfer in bytes
*/
virtual void OnContentTransferInProgress(RequestId reqId, int totalTransferedSize) = 0;
/**
- * Called when a download operation is completed.
+ * Called when the download operation is completed.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
- * @param[in] reqId The request ID
- * @param[in] contentId The registered content ID
- * @param[in] r The result of the download
- * @param[in] errorCode The error code from the server
- * @param[in] errorMessage The error message from the server
- * @exception E_SUCCESS The method is successful.
- * @exception E_SERVER An error has occurred on the server side.
+ * @param[in] reqId The request ID
+ * @param[in] contentId The registered content ID
+ * @param[in] r The result of the download
+ * @param[in] errorCode The error code from the server
+ * @param[in] errorMessage The error message from the server
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SERVER An error has occurred on the server side.
* @exception E_CONNECTION_FAILED The server connection has failed.
- * @exception E_ILLEGAL_ACCESS The request to access a server is illegal.
+ * @exception E_ILLEGAL_ACCESS The request to access the server is illegal.
* @exception E_STORAGE_FULL The storage is full.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
*/
virtual void OnContentDownloadCompleted(RequestId reqId, ContentId contentId, result r, const Tizen::Base::String& errorCode, const Tizen::Base::String& errorMessage) = 0;
/**
- * Called when a download to buffer operation is completed.
+ * Called when the download to buffer operation is completed.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
+ * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class.
* @since 2.0
*
- * @param[in] reqId The request ID
- * @param[in] pBuffer The binary buffer that has been downloaded
- * @param[in] r The result of the download
- * @param[in] errorCode The error code from the server
- * @param[in] errorMessage The error message from the server
- * @exception E_SUCCESS The method is successful.
- * @exception E_SERVER An error has occurred on the server side.
+ * @param[in] reqId The request ID
+ * @param[in] pBuffer The binary buffer that is downloaded
+ * @param[in] r The result of the download
+ * @param[in] errorCode The error code from the server
+ * @param[in] errorMessage The error message from the server
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SERVER An error has occurred on the server side.
* @exception E_FILE_ALREADY_EXIST The specified file already exists.
- * @exception E_STORAGE_FULL The storage is full.
- * @exception E_CONNECTION_FAILED The server connection has failed.
- * @exception E_ILLEGAL_ACCESS The request to access a server is illegal.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_STORAGE_FULL The storage is full.
+ * @exception E_CONNECTION_FAILED The server connection has failed.
+ * @exception E_ILLEGAL_ACCESS The request to access the server is illegal.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SYSTEM A system error has occurred.
*/
virtual void OnContentDownloadToBufferCompleted(RequestId reqId, Tizen::Base::ByteBuffer* pBuffer, result r, const Tizen::Base::String& errorCode, const Tizen::Base::String& errorMessage) = 0;
/**
- * Called when a transfer operation is cancelled.
+ * Called when the transfer operation is cancelled.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
- * @since 2.0
+ * @since 2.0
*
- * @param[in] reqId The request ID
- * @param[in] r The result of the transfer
- * @param[in] errorCode The error code from the server
+ * @param[in] reqId The request ID
+ * @param[in] r The result of the transfer
+ * @param[in] errorCode The error code from the server
* @param[in] errorMessage The error message from the server
* @exception E_SUCCESS The method is successful.
* @exception E_SERVER An error has occurred on the server side.
* @since 2.1
*
* @param[in] contentId The content ID
- * @param[in] contentType The content type
+ * @param[in] contentType The content type
* @param[in] r An error code @n
* The following exceptions are given through this parameter.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks This listener method doesn't be called when the scan for a directory is completed.
+ * @remarks This listener method is not called when the scan for a directory is completed.
*/
virtual void OnContentFileCreated(ContentId contentId, ContentType contentType, result r) = 0;
* @since 2.1
*
* @param[in] contentId The content ID
- * @param[in] contentType The content type
+ * @param[in] contentType The content type
* @param[in] r An error code @n
* The following exceptions are given through this parameter.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks This listener method doesn't be called when the scan for a directory is completed.
+ * @remarks This listener method is not called when the scan for a directory is completed.
*/
virtual void OnContentFileUpdated(ContentId contentId, ContentType contentType, result r) = 0;
* @since 2.1
*
* @param[in] contentId The content ID
- * @param[in] contentType The content type
+ * @param[in] contentType The content type
* @param[in] r An error code @n
* The following exceptions are given through this parameter.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks This listener method doesn't be called when the scan for a directory is completed.
+ * @remarks This listener method is not called when the scan for a directory is completed.
*/
virtual void OnContentFileDeleted(ContentId contentId, ContentType contentType, result r) = 0;
virtual ~IDownloadListener(void) {}
/**
- * Called when a download operation is canceled.
+ * Called when the download operation is cancelled.
*
* @since 2.0
*
virtual void OnDownloadCanceled(RequestId reqId) = 0;
/**
- * Called when a download operation is completed.
+ * Called when the download operation is completed.
*
* @since 2.0
*
virtual void OnDownloadCompleted(RequestId reqId, const Tizen::Base::String& path) = 0;
/**
- * Called when a download operation fails.
+ * Called when the download operation fails.
*
* @since 2.0
*
- * @param[in] reqId The request ID returned by DownloadManager::Start()
- * @param[in] r The error of a download operation @n The following error codes may be given through this argument.
- * @param[in] errorCode The http error code from the server
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_URL The specified URL is invalid.
- * @exception E_CONNECTION_FAILED The server connection fails.
- * @exception E_TIMEOUT The connection has timed out.
- * @exception E_MAX_EXCEEDED The request has exceeded the limit.
- * @exception E_STORAGE_FULL The storage is full.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @param[in] reqId The request ID returned by DownloadManager::Start()
+ * @param[in] r The error of the download operation @n
+ * The following error codes may be given through this argument.
+ * @param[in] errorCode The http error code from the server
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_URL The specified URL is invalid.
+ * @exception E_CONNECTION_FAILED The server connection failed.
+ * @exception E_TIMEOUT The connection has timed out.
+ * @exception E_MAX_EXCEEDED The request has exceeded the maximum limit.
+ * @exception E_STORAGE_FULL The storage is full.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
virtual void OnDownloadFailed(RequestId reqId, result r, const Tizen::Base::String& errorCode) = 0;
/**
- * Called when a download operation pauses.
+ * Called when the download operation pauses.
*
* @since 2.0
*
virtual void OnDownloadPaused(RequestId reqId) = 0;
/**
- * Called when the progress of download operation is changed.
+ * Called when the progress of the download operation is changed.
*
* @since 2.0
*
* @param[in] reqId The request ID
- * @param[in] receivedSize The size of received data in bytes
- * @param[in] totalSize The total size of data to receive in bytes
+ * @param[in] receivedSize The size of the received data in bytes
+ * @param[in] totalSize The total size of the data to receive in bytes
*/
virtual void OnDownloadInProgress(RequestId reqId, unsigned long long receivedSize, unsigned long long totalSize) = 0;
* @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompImageContentInfoConstructPage "here".
+ * For more information, see @ref CompImageContentInfoConstructPage "here".
* @endif
*
- * @return An error code
- * @param[in] pContentPath The content path @n
- * The path should be started with directory path returned by
- * either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
- * If the path is @c null,
- * use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
- * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*),
- * instead of this method.
- * @exception E_SUCCESS The method is successful.
- * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @return An error code
+ * @param[in] pContentPath The content path @n
+ * The path should start with the directory path returned by
+ * either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath() @n
+ * If the path is @c null,
+ * use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
+ * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*),
+ * instead of this method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_IO An I/O error has occurred.
- * @exception E_SYSTEM An internal error has occurred.
+ * @exception E_IO An I/O error has occurred.
+ * @exception E_SYSTEM An internal error has occurred.
* @remarks If the content has coordinates as metadata, they are automatically set.
*/
result Construct(const Tizen::Base::String* pContentPath);
* <UL><li> The content path should be a path that begins with an allowed path prefix.
* For example, L"/Media/Images/flower.jpg", L"/Storagecard/Media/Images/flower.jpg". </UL></li>
*
- * @section CompImageContentInfoConstructPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * @section CompImageContentInfoConstructPageSolutionSection Resolutions
+ * This issue has been resolved in Tizen. @n
* <UL><li> The content path can be a path without a specific allowed path prefix.
- * Application do not need to know the specific allowed path prefixes.
+ * Applications do not need to know the specific allowed path prefixes.
* To get the directory path, use the following methods: </UL></li>
* - For accessing the media directory, use Tizen::System::Environment::GetMediaPath().
* - For accessing the external storage, use Tizen::System::Environment::GetExternalStoragePath().
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as there is a problem in managing the user-defined thumbnail and device coordinates. @n
- * Instead of using this method, use Construct(const Tizen::Base::String*). @n
- * To set the coordinates in the ContentInfo instance, use ContentInfo::SetCoordinates(const Tizen::Locations::Coordinates&).
+ * Instead of using this method, use Construct(const Tizen::Base::String*). @n
+ * To set the coordinates in the ContentInfo instance, use ContentInfo::SetCoordinates(const Tizen::Locations::Coordinates&).
* @since 2.0
*
* @return An error code
* @param[in] contentPath The content path
* @param[in] thumbnailPath The thumbnail path
- * @param[in] setGps Set to @c true to save the device's last known coordinates in the ContentInfo instance, @n
- * else @c false @n
- * The coordinate information may be incorrect if it is outdated or has never been updated.
- * To update the coordinate information or to get the exact value,
- * use Tizen::Locations::LocationProvider::RequestLocationUpdates() before calling this method.
+ * @param[in] setGps Set to @c true to save the device's last known coordinates of the ContentInfo instance, @n
+ * else @c false @n
+ * The coordinate information may be incorrect if it is outdated or has never been updated @n
+ * To update the coordinate information or to get the exact value,
+ * use Tizen::Locations::LocationProvider::RequestLocationUpdates() before calling this method.
* @exception E_SUCCESS The method is successful.
- * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
+ * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_IO An I/O error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_IO An I/O error has occurred.
* @remarks
- * - The content path must start with @c '/Media' or @c '/Storagecard/Media'.
- * - The thumbnail path must start with @c '/Home', @c '/Media', or @c '/Storagecard/Media'. @n
- * The permitted format for a thumbnail image is Bitmap (bmp).
+ * - The content path must start with @c '/Media' or @c '/Storagecard/Media'.
+ * - The thumbnail path must start with @c '/Home', @c '/Media', or @c '/Storagecard/Media'. @n
+ * The permitted format for a thumbnail image is bitmap (bmp).
* @endif
*/
virtual result Construct(const Tizen::Base::String& contentPath, const Tizen::Base::String& thumbnailPath = L"", bool setGps = false);
*
* @since 2.0
*
- * @param[in] rhs An instance of %ImageMetadata
+ * @param[in] rhs An instance of %ImageMetadata to copy
*/
ImageMetadata(const ImageMetadata& rhs);
* @since 2.0
*
* @return The version of either the software or the firmware of the camera or the image input device
- * used to generate the image
+ * used to generate the image
*/
Tizen::Base::String GetSoftware(void) const;
* @since 2.0
*
* @return The latitude of the image
- * @remarks If there is no latitude in the image, @c -200.0 is returned.
+ * @remarks If there is no latitude in the image, @c -200.0 is returned.
*/
double GetLatitude(void) const;
* @since 2.0
*
* @return The longitude of the image
- * @remarks If there is no longitude in the image, @c -200.0 is returned.
+ * @remarks If there is no longitude in the image, @c -200.0 is returned.
*/
double GetLongitude(void) const;
*
* @since 2.0
*
- * @return A pointer to the thumbnail image
+ * @return A pointer to the thumbnail image
* @exception E_SUCCESS The method is successful.
* @exception E_DATA_NOT_FOUND The thumbnail image does not exist.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
Tizen::Graphics::Bitmap* GetThumbnailN(void) const;
/**
- * Compares the equality of values between two %ImageMetadata objects by overriding the Tizen::Base::Object::Equals() method.
+ * Compares the equality of the values between the two %ImageMetadata objects by overriding the Tizen::Base::Object::Equals() method.
*
* @since 2.0
*
* @return @c true if all the fields in the objects are equal, @n
- * else @c false
- * @param[in] rhs The Tizen::Base::Object with which the comparison is done @n
- * An instance of Tizen::Graphics::Bitmap is not taken into account in the comparisons.
+ * else @c false
+ * @param[in] rhs The Tizen::Base::Object with which the comparison is done @n
+ * An instance of Tizen::Graphics::Bitmap is not taken into account in the comparisons.
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
* @since 2.0
*
* @return A reference to this instance
- * @param[in] rhs An instance of %ImageMetadata
+ * @param[in] rhs An instance of %ImageMetadata to copy
*/
ImageMetadata& operator =(const ImageMetadata& rhs);
*
* The %OtherContentInfo class provides methods to access the other content information. @n
* Before getting the other content information, the ContentManager class must be used to create the content. @n
- * If the E_UNSUPPORTED_FORMAT exception is received from the ContentManagerUtil::CheckContentType() method, the file can only be created as %OtherContentInfo.
+ * If the @c E_UNSUPPORTED_FORMAT exception is received from the ContentManagerUtil::CheckContentType() method, the file can only be created as %OtherContentInfo.
*
* For more information on the different types of content information, see <a href="../org.tizen.native.appprogramming/html/guide/content/device_content_mgmt.htm">Device Content Management</a>.
*
* @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompOtherContentInfoConstructPage "here".
+ * For more information, see @ref CompOtherContentInfoConstructPage "here".
* @endif
*
- * @return An error code
- * @param[in] pContentPath The content path @n
- * The path should be started with directory path returned by
- * either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
- * If the path is @c null,
- * use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
- * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*),
- * instead of this method.
- * @exception E_SUCCESS The method is successful.
- * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @return An error code
+ * @param[in] pContentPath The content path @n
+ * The path should start with the directory path returned by
+ * either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath() @n
+ * If the path is @c null,
+ * use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
+ * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*),
+ * instead of this method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_IO An I/O error has occurred.
- * @exception E_SYSTEM An internal error has occurred.
- * @remarks
+ * @exception E_IO An I/O error has occurred.
+ * @exception E_SYSTEM An internal error has occurred.
*
*/
result Construct(const Tizen::Base::String* pContentPath);
* @if OSPCOMPAT
* @page CompOtherContentInfoConstructPage Compatibility for the file path.
* @section CompOtherContentInfoConstructPageIssueSection Issues
- * The content path argument of this method in OSP compatible applications has the following issues: @n
- * -# The content path should be a path that begins with an allowed path prefix. @n
- * For example, L"/Media/Images/flower.jpg", L"/Storagecard/Media/Images/flower.jpg".
+ * The content path argument of this method in OSP compatible applications has the following issues: @n
+ * -# The content path should be a path that begins with an allowed path prefix. @n
+ * For example, L"/Media/Images/flower.jpg", L"/Storagecard/Media/Images/flower.jpg".
*
* @section CompOtherContentInfoConstructPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
- * -# The content path can be a path without a specific allowed path prefix. @n
- * Application do not need to know the specific allowed path prefixes. @n
- * To get the directory path, use the following methods: @n
- * - For accessing the media directory, use Tizen::System::Environment::GetMediaPath().
- * - For accessing the external storage, use Tizen::System::Environment::GetExternalStoragePath().
+ * This issue has been resolved in Tizen. @n
+ * -# The content path can be a path without a specific allowed path prefix. @n
+ * Applications do not need to know the specific allowed path prefixes. @n
+ * To get the directory path, use the following methods: @n
+ * - For accessing the media directory, use Tizen::System::Environment::GetMediaPath().
+ * - For accessing the external storage, use Tizen::System::Environment::GetExternalStoragePath().
* @endif
*/
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as there is a problem in managing the user-defined thumbnail and device coordinates. @n
- * Instead of using this method, use Construct(const Tizen::Base::String*). @n
- * To set the coordinates in the ContentInfo instance, use ContentInfo::SetCoordinates(const Tizen::Locations::Coordinates&).
+ * Instead of using this method, use Construct(const Tizen::Base::String*). @n
+ * To set the coordinates in the ContentInfo instance, use ContentInfo::SetCoordinates(const Tizen::Locations::Coordinates&).
* @since 2.0
*
* @return An error code
* @param[in] contentPath The content path
* @param[in] thumbnailPath The thumbnail path
- * @param[in] setGps Set to @c true to save the device's last known coordinates in the ContentInfo instance, @n
- * else @c false @n
- * The coordinate information may be incorrect if it is outdated or has never been updated. @n
- * To update the coordinate information or to get the exact value,
- * use Tizen::Locations::LocationProvider::RequestLocationUpdates() before calling this method.
+ * @param[in] setGps Set to @c true to save the device's last known coordinates of the ContentInfo instance, @n
+ * else @c false @n
+ * The coordinate information may be incorrect if it is outdated or has never been updated @n
+ * To update the coordinate information or to get the exact value,
+ * use Tizen::Locations::LocationProvider::RequestLocationUpdates() before calling this method.
* @exception E_SUCCESS The method is successful.
- * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
+ * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_IO An I/O error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_IO An I/O error has occurred.
* @remarks
* - The content path must start with @c '/Media' or @c '/Storagecard/Media'.
* - The thumbnail path must start with @c '/Home', @c '/Media', or @c '/Storagecard/Media'. @n
- * The permitted format for a thumbnail image is bitmap (bmp).
+ * The permitted format for a thumbnail image is bitmap (bmp).
* @endif
*/
virtual result Construct(const Tizen::Base::String& contentPath, const Tizen::Base::String& thumbnailPath = L"", bool setGps = false);
/**
* @class PlayList
- * @brief This class provides methods for a playlist information.
+ * @brief This class provides methods to access the playlist information.
*
- * @since 2.0
+ * @since 2.0
*
- * @final This class is not intended for extension.
+ * @final This class is not intended for extension.
*
- * The %PlayList class provides methods to access a playlist information.
- * The methods of this class are immediately access to the database and update.
+ * The %PlayList class provides methods to access the playlist information.
+ * The methods of this class help to immediately access the database and update it.
*
* The following example demonstrates how to use the %PlayList class.
*
* The object is not fully constructed after this constructor is called. @n
* For full construction, the Construct() method must be called right after calling this constructor.
*
- * @since 2.0
+ * @since 2.0
*/
PlayList(void);
/**
* This destructor overrides Tizen::Base::Object::~Object().
*
- * @since 2.0
+ * @since 2.0
*/
virtual ~PlayList(void);
/**
* Initializes this instance of %PlayList with the specified parameter.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] playListName The playlist name
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SERVICE_BUSY The database is busy.
- * @exception E_DATABASE The method cannot access the database.
+ * @return An error code
+ * @param[in] playListName The playlist name
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SERVICE_BUSY The database is busy.
+ * @exception E_DATABASE The method cannot access the database.
*/
result Construct(const Tizen::Base::String& playListName);
/**
- * Gets the count of playlist items.
+ * Gets the count of the playlist items.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The item count
- * @exception E_SUCCESS The method is successful.
- * @exception E_SERVICE_BUSY The database is busy.
- * @exception E_DATABASE The method cannot access the database.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @return The item count
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SERVICE_BUSY The database is busy.
+ * @exception E_DATABASE The method cannot access the database.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
int GetPlayListItemCount(void) const;
/**
* Gets the list of playlist items.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The list that contains playlist items as ContentInfo class
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SERVICE_BUSY The database is busy.
- * @exception E_DATABASE The method cannot access the database.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @return The list that contains the playlist items as ContentInfo
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SERVICE_BUSY The database is busy.
+ * @exception E_DATABASE The method cannot access the database.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetContentInfoListN(void) const;
/**
- * Adds the item to the playlist.
+ * Adds an item to the playlist.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] contentId The content ID
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_SERVICE_BUSY The database is busy.
- * @exception E_DATABASE The method cannot access the database.
- * @see AddItems(const Tizen::Base::Collection::IList&)
+ * @return An error code
+ * @param[in] contentId The content ID
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_SERVICE_BUSY The database is busy.
+ * @exception E_DATABASE The method cannot access the database.
+ * @see AddItems(const Tizen::Base::Collection::IList&)
*/
result AddItem(const ContentId& contentId);
/**
- * Adds the items to the playlist.
+ * Adds items to the playlist.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] contentIdList The list that contains ContentId
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_SERVICE_BUSY The database is busy.
- * @exception E_DATABASE The method cannot access the database.
- * @see AddItem(const ContentId&)
+ * @return An error code
+ * @param[in] contentIdList The list that contains content IDs
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_SERVICE_BUSY The database is busy.
+ * @exception E_DATABASE The method cannot access the database.
+ * @see AddItem(const ContentId&)
*/
result AddItems(const Tizen::Base::Collection::IList& contentIdList);
/**
- * Removes the item from the playlist.
+ * Removes an item from the playlist.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] contentId The content ID
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OBJ_NOT_FOUND The specified @c contentId is not found.
- * @exception E_SERVICE_BUSY The database is busy.
- * @exception E_DATABASE The method cannot access the database.
- * @see RemoveItems(const Tizen::Base::Collection::IList&)
+ * @return An error code
+ * @param[in] contentId The content ID
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_OBJ_NOT_FOUND The specified @c contentId is not found.
+ * @exception E_SERVICE_BUSY The database is busy.
+ * @exception E_DATABASE The method cannot access the database.
+ * @see RemoveItems(const Tizen::Base::Collection::IList&)
*/
result RemoveItem(const ContentId& contentId);
/**
- * Removes the items from the playlist.
+ * Removes items from the playlist.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] contentIdList The list that contains ContentId
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OBJ_NOT_FOUND The specified @c contentId in the list is not found.
- * @exception E_SERVICE_BUSY The database is busy.
- * @exception E_DATABASE The method cannot access the database.
- * @see RemoveItem(const ContentId&)
+ * @return An error code
+ * @param[in] contentIdList The list that contains content IDs
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_OBJ_NOT_FOUND The specified @c contentId is not found.
+ * @exception E_SERVICE_BUSY The database is busy.
+ * @exception E_DATABASE The method cannot access the database.
+ * @see RemoveItem(const ContentId&)
*/
result RemoveItems(const Tizen::Base::Collection::IList& contentIdList);
/**
* Gets the playlist name.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The playlist name
+ * @return The playlist name
*/
Tizen::Base::String GetPlayListName(void) const;
/**
* Sets the playlist name.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] playListName The playlist name
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SERVICE_BUSY The database is busy.
- * @exception E_DATABASE The method cannot access the database.
+ * @return An error code
+ * @param[in] playListName The playlist name
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SERVICE_BUSY The database is busy.
+ * @exception E_DATABASE The method cannot access the database.
*/
result SetPlayListName(const Tizen::Base::String& playListName);
/**
* Gets the play order.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The play order
- * @param[in] contentId The content ID
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OBJ_NOT_FOUND The specified @c contentId is not found.
- * @exception E_SERVICE_BUSY The database is busy.
- * @exception E_DATABASE The method cannot access the database.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @return The play order
+ * @param[in] contentId The content ID
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_OBJ_NOT_FOUND The specified @c contentId is not found.
+ * @exception E_SERVICE_BUSY The database is busy.
+ * @exception E_DATABASE The method cannot access the database.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
int GetPlayOrder(const ContentId& contentId) const;
class _PlayListManagerImpl;
/**
- * @class PlayListManager
- * @brief This class provides methods to manage the playlist.
+ * @class PlayListManager
+ * @brief This class provides methods to manage the playlist.
*
- * @since 2.0
+ * @since 2.0
*
- * @final This class is not intended for extension.
+ * @final This class is not intended for extension.
*
* The %PlayListManager class provides methods to manage the playlist.
- * The methods of this class are immediately access to the database and update.
+ * The methods of this class help to immediately access the database and update it.
*
* The following example demonstrates how to use the %PlayListManager class.
*
/**
* Gets the playlist.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to the PlayList instance
- * @param[in] playListName The playlist name
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SERVICE_BUSY The database is busy.
- * @exception E_DATABASE The method cannot access the database.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @return A pointer to the PlayList instance
+ * @param[in] playListName The playlist name
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SERVICE_BUSY The database is busy.
+ * @exception E_DATABASE The method cannot access the database.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
PlayList* GetPlayListN(const Tizen::Base::String& playListName) const;
/**
* Removes the playlist.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] playListName The playlist name
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_SERVICE_BUSY The database is busy.
- * @exception E_DATABASE The method cannot access the database.
+ * @return An error code
+ * @param[in] playListName The playlist name
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_SERVICE_BUSY The database is busy.
+ * @exception E_DATABASE The method cannot access the database.
*/
result RemovePlayList(const Tizen::Base::String& playListName);
/**
- * Gets the count of all playlists.
+ * Gets the count of all the playlists.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The count of all playlists
- * @exception E_SUCCESS The method is successful.
- * @exception E_SERVICE_BUSY The database is busy.
- * @exception E_DATABASE The method cannot access the database.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @return The count of all the playlists
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SERVICE_BUSY The database is busy.
+ * @exception E_DATABASE The method cannot access the database.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
int GetAllPlayListCount(void) const;
/**
- * Gets all playlist names.
+ * Gets all the playlist names.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The list that contains playlist names as Tizen::Base::String class
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SERVICE_BUSY The database is busy.
- * @exception E_DATABASE The method cannot access the database.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @return The list that contains the playlist names as Tizen::Base::String
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SERVICE_BUSY The database is busy.
+ * @exception E_DATABASE The method cannot access the database.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetAllPlayListNameN(void) const;
/**
* Gets the playlist manager instance.
*
- * @since 2.0
+ * @since 2.0
*
* @return A pointer to the %PlayListManager instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static PlayListManager* GetInstance(void);
//
/**
* @file FCntTypes.h
- * @brief This is the header file for the definitions of constants and enumerators in the Content namespace.
+ * @brief This is the header file for the %Content namespace.
*
* This header file contains definitions for the constants and enumerators in the Content namespace.
*/
/**
* The content ID.
*
- * @since 2.0
+ * @since 2.0
*/
typedef Tizen::Base::UuId ContentId;
/**
- * @enum ContentType
+ * @enum ContentType
*
* Defines the content type.
*
- * @since 2.0
+ * @since 2.0
*/
enum ContentType
{
CONTENT_TYPE_IMAGE, /**< An Image */
CONTENT_TYPE_AUDIO, /**< An Audio */
CONTENT_TYPE_VIDEO, /**< A Video */
- CONTENT_TYPE_ALL, /**< @if OSPDEPREC The content type: all types @endif */ /**< @if OSPDEPREC @deprecated This enum field is deprecated as unified search will not be supported. @endif */
- CONTENT_TYPE_UNKNOWN /**< An Unknown type */
+ CONTENT_TYPE_ALL, /**< @if OSPDEPREC The content type: all types @endif */ /**< @if OSPDEPREC @deprecated This enum field is deprecated as a unified search is not supported. @endif */
+ CONTENT_TYPE_UNKNOWN /**< An Unknown type */
};
/**
- * @enum ImageOrientationType
+ * @enum ImageOrientationType
*
* Defines the orientation type of an image.
*
- * @since 2.0
+ * @since 2.0
*/
enum ImageOrientationType
{
IMAGE_ORIENTATION_TYPE_UNKNOWN = 0, /**< An Unknown type */
- IMAGE_ORIENTATION_TYPE_NORMAL, /**< Normal */
+ IMAGE_ORIENTATION_TYPE_NORMAL, /**< Normal */
IMAGE_ORIENTATION_TYPE_FLIP_HORIZONTAL, /**< Flip horizontal */
- IMAGE_ORIENTATION_TYPE_ROTATE_180, /**< Rotate 180 degree */
- IMAGE_ORIENTATION_TYPE_FLIP_VERTICAL, /**< Flip vertical */
- IMAGE_ORIENTATION_TYPE_TRANSPOSE, /**< Transpose */
- IMAGE_ORIENTATION_TYPE_ROTATE_90, /**< Rotate 90 degree */
- IMAGE_ORIENTATION_TYPE_TRANSVERSE, /**< Transverse */
- IMAGE_ORIENTATION_TYPE_ROTATE_270 /**< Rotate 270 degree */
+ IMAGE_ORIENTATION_TYPE_ROTATE_180, /**< Rotate 180 degree */
+ IMAGE_ORIENTATION_TYPE_FLIP_VERTICAL, /**< Flip vertical */
+ IMAGE_ORIENTATION_TYPE_TRANSPOSE, /**< Transpose */
+ IMAGE_ORIENTATION_TYPE_ROTATE_90, /**< Rotate 90 degree */
+ IMAGE_ORIENTATION_TYPE_TRANSVERSE, /**< Transverse */
+ IMAGE_ORIENTATION_TYPE_ROTATE_270 /**< Rotate 270 degree */
};
/**
- * @enum DownloadNetworkType
+ * @enum DownloadNetworkType
+ *
* Defines the download network type.
- * @since 2.1
+ *
+ * @since 2.1
*/
enum DownloadNetworkType
{
};
/**
- * @enum DownloadState
+ * @enum DownloadState
*
* Defines the download state.
*
- * @since 2.0
+ * @since 2.0
*/
enum DownloadState
{
DOWNLOAD_STATE_NONE = 0, /**< The download request does not exist */
- DOWNLOAD_STATE_QUEUED, /**< The download request is listed in a download queue */
+ DOWNLOAD_STATE_QUEUED, /**< The download request is listed in the download queue */
DOWNLOAD_STATE_DOWNLOADING, /**< The download request is in progress */
DOWNLOAD_STATE_PAUSED, /**< The download request is in a paused state by user request */
DOWNLOAD_STATE_CANCELLED, /**< The download request is cancelled by user request */
//
/**
* @file FCntVideoContentInfo.h
- * @brief This is the header file for the %VideoContentInfo class.
+ * @brief This is the header file for the %VideoContentInfo class.
*
* This header file contains the declarations of the %VideoContentInfo class.
*/
class _VideoContentData;
/**
- * @class VideoContentInfo
- * @brief This class provides methods to access the video content information.
+ * @class VideoContentInfo
+ * @brief This class provides methods to access the video content information.
*
- * @since 2.0
+ * @since 2.0
*
- * @final This class is not intended for extension.
+ * @final This class is not intended for extension.
*
- * The %VideoContentInfo class provides methods to access the video content information that is extracted from a physical file. @n
+ * The %VideoContentInfo class provides methods to access the video content information that is extracted from a
+ * physical file. @n
* Before getting the video content information, the ContentManager class must be used to create the content.
*
- * For more information on the different types of content information, see <a href="../org.tizen.native.appprogramming/html/guide/content/device_content_mgmt.htm">Device Content Management</a>.
+ * For more information on the different types of content information, see
+ * <a href="../org.tizen.native.appprogramming/html/guide/content/device_content_mgmt.htm">
+ * Device Content Management</a>.
*
* The following example demonstrates how to use the %VideoContentInfo class.
*
/**
* Initializes this instance of %VideoContentInfo with the specified parameter.
*
- * @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @if OSPCOMPAT
+ * @brief <i> [Compatibility] </i>
* @endif
- * @since 2.0
- * @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompVideoContentInfoConstructPage "here".
+ * @since 2.0
+ * @if OSPCOMPAT
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompVideoContentInfoConstructPage "here".
* @endif
*
- * @return An error code
+ * @return An error code
* @param[in] pContentPath The content path @n
- * The path should be started with directory path returned by
- * either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
- * If the path is @c null,
- * use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
- * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*),
- * instead of this method.
- * @exception E_SUCCESS The method is successful.
+ * The path should start with the directory path returned by
+ * either Tizen::System::Environment::GetMediaPath() or
+ * Tizen::System::Environment::GetExternalStoragePath() @n
+ * If the path is @c null, use ContentManager::CreateContent
+ * (const Tizen::Base::ByteBuffer&, const Tizen::Base::String&,
+ * const ContentInfo*) @n
+ * or ContentManager::CreateContent(const Tizen::Base::String&,
+ * const Tizen::Base::String&, bool, const ContentInfo*), instead of this
+ * method.
+ * @exception E_SUCCESS The method is successful.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_IO An I/O error has occurred.
- * @exception E_SYSTEM An internal error has occurred.
- * @remarks
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_IO An I/O error has occurred.
+ * @exception E_SYSTEM An internal error has occurred.
*/
result Construct(const Tizen::Base::String* pContentPath);
/**
- * @if OSPCOMPAT
- * @page CompVideoContentInfoConstructPage Compatibility for the file path.
- * @section CompVideoContentInfoConstructPageIssueSection Issues
- * The content path argument of this method in OSP compatible applications has the following issues: @n
- * -# The content path should be a path that begins with an allowed path prefix. @n
- * For example, L"/Media/Images/flower.jpg", L"/Storagecard/Media/Images/flower.jpg".
+ * @if OSPCOMPAT
+ * @page CompVideoContentInfoConstructPage Compatibility for the file path.
+ * @section CompVideoContentInfoConstructPageIssueSection Issues
+ * The content path argument of this method in OSP compatible applications has the following issues: @n
+ * -# The content path should be a path that begins with an allowed path prefix. @n
+ * For example, L"/Media/Images/flower.jpg", L"/Storagecard/Media/Images/flower.jpg".
*
- * @section CompVideoContentInfoConstructPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
- * -# The content path can be a path without a specific allowed path prefix. @n
- * Application do not need to know the specific allowed path prefixes. @n
+ * @section CompVideoContentInfoConstructPageSolutionSection Resolutions
+ * This issue has been resolved in Tizen. @n
+ * -# The content path can be a path without a specific allowed path prefix. @n
+ * Applications do not need to know the specific allowed path prefixes. @n
* To get the directory path, use the following methods: @n
* - For accessing the media directory, use Tizen::System::Environment::GetMediaPath().
* - For accessing the external storage, use Tizen::System::Environment::GetExternalStoragePath().
*/
/**
- * @if OSPDEPREC
+ * @if OSPDEPREC
* Initializes this instance of %VideoContentInfo with the specified parameters.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated as there is a problem in managing the user-defined thumbnail and device coordinates. @n
- * Instead of using this method, use Construct(const Tizen::Base::String*). @n
- * To set the coordinates in the ContentInfo instance, use ContentInfo::SetCoordinates(const Tizen::Locations::Coordinates&).
- * @since 2.0
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated as there is a problem in managing the user-defined thumbnail and
+ * device coordinates. @n
+ * Instead of using this method, use Construct(const Tizen::Base::String*). @n
+ * To set the coordinates in the ContentInfo instance, use
+ * ContentInfo::SetCoordinates(const Tizen::Locations::Coordinates&).
+ * @since 2.0
*
- * @return An error code
- * @param[in] contentPath The content path
- * @param[in] thumbnailPath The thumbnail path
- * @param[in] setGps Set to @c true to save the device's last known coordinates in the ContentInfo instance, @n
- * else @c false @n
- * The coordinate information may be incorrect if it is outdated or has never been updated. @n
- * To update the coordinate information or to get the exact value,
- * use Tizen::Locations::LocationProvider::RequestLocationUpdates() before calling this method.
- * @exception E_SUCCESS The method is successful.
- * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @return An error code
+ * @param[in] contentPath The content path
+ * @param[in] thumbnailPath The thumbnail path
+ * @param[in] setGps Set to @c true to save the device's last known coordinates of the
+ * ContentInfo instance, @n
+ * else @c false @n
+ * The coordinate information may be incorrect if it is outdated or has
+ * never been updated @n
+ * To update the coordinate information or to get the exact value, use
+ * Tizen::Locations::LocationProvider::RequestLocationUpdates()
+ * before calling this method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_IO An I/O error has occurred.
+ * @exception E_IO An I/O error has occurred.
* @remarks
- * - The content path must start with @c '/Media' or @c '/Storagecard/Media'.
- * - The thumbnail path must start with @c '/Home', @c '/Media', or @c '/Storagecard/Media'. @n
- * The permitted format for a thumbnail image is bitmap (bmp).
+ * - The content path must start with @c '/Media' or @c '/Storagecard/Media'.
+ * - The thumbnail path must start with @c '/Home', @c '/Media', or @c '/Storagecard/Media'. @n
+ * The permitted format for a thumbnail image is bitmap (bmp).
* @endif
*/
virtual result Construct(const Tizen::Base::String& contentPath, const Tizen::Base::String& thumbnailPath = L"", bool setGps = false);
Tizen::Base::String GetArtist(void) const;
/**
- * @if OSPDEPREC
+ * @if OSPDEPREC
* Gets the bit rate of the video file.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because a new method has been added. @n
- * Instead of using this method, use GetAudioBitrate() or GetVideoBitrate().
+ * Instead of using this method, use GetAudioBitrate() or GetVideoBitrate().
* @since 2.0
*
* @return The bit rate in bits per second (bps)
- * @remarks There are two kinds of bit rates in a video file: audio and video. @n
- * The return value is the bit rate for the audio.
+ * @remarks
+ * - There are two kinds of bit rates in a video file: audio and video.
+ * - The return value is the bit rate for the audio.
* @endif
*/
int GetBitrate(void) const;
/**
* Gets the audio bit rate of the video file.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The audio bit rate in bits per second (bps)
+ * @return The audio bit rate in bits per second (bps)
*/
int GetAudioBitrate(void) const;
/**
* Gets the video bit rate of the video file.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The video bit rate in bits per second (bps)
+ * @return The video bit rate in bits per second (bps)
*/
int GetVideoBitrate(void) const;
// limitations under the License.
//
/**
- * @file FCntVideoMetadata.h
+ * @file FCntVideoMetadata.h
* @brief This is the header file for the %VideoMetadata class.
*
* This header file contains the declarations of the %VideoMetadata class.
class _VideoMetadataImpl;
/**
- * @class VideoMetadata
- * @brief This class provides methods to access the video metadata.
+ * @class VideoMetadata
+ * @brief This class provides methods to access the video metadata.
*
- * @since 2.0
+ * @since 2.0
*
- * The %VideoMetadata class provides methods to access the video metadata that contains video content-specific attributes.
+ * The %VideoMetadata class provides methods to access the video metadata that contains video content-specific
+ * attributes.
*
* The following example demonstrates how to use the %VideoMetadata class.
*
*
* @since 2.0
*
- * @param[in] rhs An instance of %VideoMetadata
+ * @param[in] rhs An instance of %VideoMetadata to copy
*/
VideoMetadata(const VideoMetadata& rhs);
int GetFramerate(void) const;
/**
- * @if OSPDEPREC
+ * @if OSPDEPREC
* Gets the bit rate.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because a new method has been added. @n
- * Instead of using this method, use GetAudioBitrate() or GetVideoBitrate().
+ * Instead of using this method, use GetAudioBitrate() or GetVideoBitrate().
* @since 2.0
*
* @return The bit rate in bits per second (bps)
- * @remarks There are two kinds of bit rates in a video file: audio and video. @n
- * The return value is the bit rate for the audio.
+ * @remarks
+ * - There are two kinds of bit rates in a video file: audio and video.
+ * - The return value is the bit rate for the audio.
* @endif
*/
int GetBitrate(void) const;
Tizen::Base::String GetGenre(void) const;
/**
- * Gets a comment of a video file.
+ * Gets the comment of the video file.
*
* @since 2.1
*
- * @return A comment of a video file
+ * @return The comment of the video file
*/
Tizen::Base::String GetComment(void) const;
/**
- * Gets the description of a video file.
+ * Gets the description of the video file.
*
* @since 2.1
*
- * @return The description of a video file
+ * @return The description of the video file
*/
Tizen::Base::String GetDescription(void) const;
/**
- * Gets the album art of a video.
+ * Gets the album art of the video.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to the album art
- * @exception E_SUCCESS The method is successful.
+ * @return A pointer to the album art
+ * @exception E_SUCCESS The method is successful.
* @exception E_DATA_NOT_FOUND The album art does not exist.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::Bitmap* GetAlbumArtN(void) const;
/**
- * Compares the equality of values between two %VideoMetadata objects by overriding the Tizen::Base::Object::Equals() method.
+ * Compares the equality of the values between two %VideoMetadata objects by overriding the
+ * Tizen::Base::Object::Equals() method.
*
- * @since 2.0
+ * @since 2.0
*
- * @return @c true if all the fields in the objects are equal, @n
- * else @c false
- * @param[in] rhs The Tizen::Base::Object with which the comparison is done @n
- * An instance of Tizen::Graphics::Bitmap is not taken into account in the comparisons.
+ * @return @c true if all the fields in the objects are equal, @n
+ * else @c false
+ * @param[in] rhs The Tizen::Base::Object with which the comparison is done @n
+ * An instance of Tizen::Graphics::Bitmap is not taken into account in
+ * the comparisons.
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
/**
* Gets the hash value of the current instance by overriding the Tizen::Base::Object::GetHashCode() method.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The hash value of the current instance
+ * @return The hash value of the current instance
*/
virtual int GetHashCode(void) const;
/**
* Copying of objects using this copy assignment operator is allowed.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A reference to this instance
- * @param[in] rhs An instance of %VideoMetadata
+ * @return A reference to this instance
+ * @param[in] rhs An instance of %VideoMetadata to copy
*/
VideoMetadata& operator =(const VideoMetadata& rhs);
* @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FContent.h> @n
- * @b Library : @b osp-content
+ * @b Library: @b osp-content
*
* The %Content namespace contains classes for managing the most common media data types, such as image, audio, and video on the device. This namespace also provides operations to search content and content information stored on the device, and to download content from servers through HTTP access.
*
projects / platform / framework / native / content.git / commitdiff