namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Provides commands to manage playlists in the database.
+ /// Provides the commands to manage playlists in the database.
/// </summary>
/// <seealso cref="Playlist"/>
+ /// <since_tizen> 4 </since_tizen>
public class PlaylistCommand : MediaCommand
{
/// <summary>
/// </summary>
/// <param name="database">A <see cref="MediaDatabase"/> that the commands run on.</param>
/// <exception cref="ArgumentNullException"><paramref name="database"/> is null.</exception>
- /// <exception cref="ObjectDisposedException"><paramref name="database"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException"><paramref name="database"/> has already been disposed.</exception>
+ /// <since_tizen> 4 </since_tizen>
public PlaylistCommand(MediaDatabase database) : base(database)
{
}
/// </summary>
/// <returns>The number of playlists.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
+ /// <since_tizen> 4 </since_tizen>
public int Count()
{
return Count(null);
}
/// <summary>
- /// Retrieves the number of playlists with <see cref="CountArguments"/>.
+ /// Retrieves the number of playlists with the <see cref="CountArguments"/>.
/// </summary>
/// <param name="arguments">The criteria to use to filter. This value can be null.</param>
/// <returns>The number of playlists.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
+ /// <since_tizen> 4 </since_tizen>
public int Count(CountArguments arguments)
{
ValidateDatabase();
/// <summary>
/// Retrieves the play order of the member.
/// </summary>
- /// <param name="playlistId">The playlist id.</param>
- /// <param name="memberId">The member id of the playlist.</param>
- /// <returns>The <see cref="MediaDataReader{TRecord}"/> containing the results.</returns>
+ /// <param name="playlistId">The playlist ID.</param>
+ /// <param name="memberId">The member ID of the playlist.</param>
+ /// <returns>The order of the member in the playlist.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="playlistId"/> is less than or equal to zero.\n
- /// -or-\n
+ /// <paramref name="playlistId"/> is less than or equal to zero.<br/>
+ /// -or-<br/>
/// <paramref name="memberId"/> is less than or equal to zero.
/// </exception>
+ /// <since_tizen> 4 </since_tizen>
public int GetPlayOrder(int playlistId, int memberId)
{
ValidateDatabase();
/// Deletes a playlist from the database.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="playlistId">The playlist id to delete.</param>
+ /// <param name="playlistId">The playlist ID to delete.</param>
/// <returns>true if the matched record was found and deleted, otherwise false.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="playlistId"/> is less than or equal to zero.</exception>
/// <exception cref="UnauthorizedAccessException">The caller has no required privilege.</exception>
+ /// <since_tizen> 4 </since_tizen>
public bool Delete(int playlistId)
{
ValidateDatabase();
}
/// <summary>
- /// Inserts a playlist into the database from the specified m3u file.
+ /// Inserts the playlist into the database from the specified M3U file.
/// </summary>
/// <remarks>
- /// If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n
- /// If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage.
+ /// If you want to access an internal storage, you should add privilege http://tizen.org/privilege/mediastorage.<br/>
+ /// If you want to access an external storage, you should add privilege http://tizen.org/privilege/externalstorage.
/// </remarks>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
/// <privilege>http://tizen.org/privilege/mediastorage</privilege>
/// <privilege>http://tizen.org/privilege/externalstorage</privilege>
- /// <param name="name">The name of playlist.</param>
- /// <param name="path">The path to a m3u file to import.</param>
+ /// <param name="name">The name of the playlist.</param>
+ /// <param name="path">The path to a M3U file to import.</param>
/// <returns>The <see cref="Playlist"/> instance that contains the record information inserted.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentNullException">
- /// <paramref name="name"/> is null.\n
- /// -or-\n
+ /// <paramref name="name"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="path"/> is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="name"/> is a zero-length string.\n
- /// -or-\n
+ /// <paramref name="name"/> is a zero-length string.<br/>
+ /// -or-<br/>
/// <paramref name="path"/> is a zero-length string, contains only white space.
/// </exception>
/// <exception cref="FileNotFoundException"><paramref name="path"/> does not exists.</exception>
/// <exception cref="UnauthorizedAccessException">The caller has no required privilege.</exception>
+ /// <since_tizen> 4 </since_tizen>
public Playlist InsertFromFile(string name, string path)
{
ValidateDatabase();
}
}
/// <summary>
- /// Exports a playlist to a m3u file.
+ /// Exports the playlist to a M3U file.
/// </summary>
/// <remarks>
- /// If the file already exists in the file system, then it will be overwritten.\n
- /// \n
- /// If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n
- /// If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage.
+ /// If the file already exists in the file system, then it will be overwritten.<br/>
+ /// <br/>
+ /// If you want to access an internal storage, you should add privilege http://tizen.org/privilege/mediastorage.<br/>
+ /// If you want to access an external storage, you should add privilege http://tizen.org/privilege/externalstorage.
/// </remarks>
/// <privilege>http://tizen.org/privilege/mediastorage</privilege>
/// <privilege>http://tizen.org/privilege/externalstorage</privilege>
- /// <param name="playlistId">The playlist id to export.</param>
- /// <param name="path">The path to a m3u file.</param>
+ /// <param name="playlistId">The playlist ID to export.</param>
+ /// <param name="path">The path to a M3U file.</param>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
/// <exception cref="ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="playlistId"/> is less than or equal to zero.</exception>
/// <exception cref="RecordNotFoundException">No matching playlist exists.</exception>
/// <exception cref="UnauthorizedAccessException">The caller has no required privilege.</exception>
+ /// <since_tizen> 4 </since_tizen>
public void ExportToFile(int playlistId, string path)
{
ValidateDatabase();
{
Interop.Playlist.GetPlaylistFromDb(playlistId, out handle).ThrowIfError("Failed to query");
- if (handle == IntPtr.Zero)
- {
- throw new RecordNotFoundException("No matching playlist exists.");
- }
-
Interop.Playlist.ExportToFile(handle, path).ThrowIfError("Failed to export");
}
+ catch (ArgumentException)
+ {
+ // Native FW returns ArgumentException when there's no matched record.
+ throw new RecordNotFoundException("No matching playlist exists.");
+ }
finally
{
if (handle != IntPtr.Zero)
}
/// <summary>
- /// Inserts a playlist into the database with the specified name.
+ /// Inserts the playlist into the database with the specified name.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="name">The name of playlist.</param>
+ /// <param name="name">The name of the playlist.</param>
/// <returns>The <see cref="Playlist"/> instance that contains the record information inserted.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentNullException"><paramref name="name"/> is null.</exception>
/// <exception cref="ArgumentException"><paramref name="name"/> is a zero-length string.</exception>
/// <exception cref="UnauthorizedAccessException">The caller has no required privilege.</exception>
+ /// <since_tizen> 4 </since_tizen>
public Playlist Insert(string name)
{
return Insert(name, null);
}
/// <summary>
- /// Inserts a playlist into the database with the specified name and thumbnail path.
+ /// Inserts the playlist into the database with the specified name and the thumbnail path.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="name">The name of playlist.</param>
- /// <param name="thumbnailPath">The path of thumbnail for playlist. This value can be null.</param>
+ /// <param name="name">The name of the playlist.</param>
+ /// <param name="thumbnailPath">The path of the thumbnail for the playlist. This value can be null.</param>
/// <returns>The <see cref="Playlist"/> instance that contains the record information inserted.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentNullException"><paramref name="name"/> is null.</exception>
/// <exception cref="ArgumentException"><paramref name="name"/> is a zero-length string.</exception>
/// <exception cref="UnauthorizedAccessException">The caller has no required privilege.</exception>
+ /// <since_tizen> 4 </since_tizen>
public Playlist Insert(string name, string thumbnailPath)
{
ValidateDatabase();
/// </summary>
/// <returns>The <see cref="MediaDataReader{TRecord}"/> containing the results.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
+ /// <since_tizen> 4 </since_tizen>
public MediaDataReader<Playlist> Select()
{
return Select(null);
}
/// <summary>
- /// Retrieves the playlists with <see cref="SelectArguments"/>.
+ /// Retrieves the playlists with the <see cref="SelectArguments"/>.
/// </summary>
/// <param name="filter">The criteria to use to filter. This value can be null.</param>
/// <returns>The <see cref="MediaDataReader{TRecord}"/> containing the results.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
+ /// <since_tizen> 4 </since_tizen>
public MediaDataReader<Playlist> Select(SelectArguments filter)
{
ValidateDatabase();
}
/// <summary>
- /// Retrieves the playlist with the specified playlist id.
+ /// Retrieves the playlist with the specified playlist ID.
/// </summary>
- /// <param name="playlistId">The playlist id to select.</param>
+ /// <param name="playlistId">The playlist ID to select.</param>
/// <returns>The <see cref="Playlist"/> instance if the matched record was found in the database, otherwise null.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="playlistId"/> is less than or equal to zero.</exception>
+ /// <since_tizen> 4 </since_tizen>
public Playlist Select(int playlistId)
{
ValidateDatabase();
{
Interop.Playlist.GetPlaylistFromDb(playlistId, out handle).ThrowIfError("Failed to query");
- if (handle == IntPtr.Zero)
- {
- return null;
- }
-
return new Playlist(handle);
}
+ catch (ArgumentException)
+ {
+ // Native FW returns ArgumentException when there's no matched record.
+ return null;
+ }
finally
{
if (handle != IntPtr.Zero)
}
/// <summary>
- /// Retrieves the number of media info of the playlist.
+ /// Retrieves the number of media information of the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id to count media added to the playlist.</param>
- /// <returns>The number of media info.</returns>
+ /// <param name="playlistId">The playlist ID to count media added to the playlist.</param>
+ /// <returns>The number of media information.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="playlistId"/> is less than or equal to zero.</exception>
+ /// <since_tizen> 4 </since_tizen>
public int CountMember(int playlistId)
{
return CountMember(playlistId, null);
}
/// <summary>
- /// Retrieves the number of media info of the playlist with <see cref="CountArguments"/>.
+ /// Retrieves the number of media information of the playlist with the <see cref="CountArguments"/>.
/// </summary>
- /// <param name="playlistId">The playlist id to count media added to the playlist.</param>
+ /// <param name="playlistId">The playlist ID to count the media added to the playlist.</param>
/// <param name="arguments">The criteria to use to filter. This value can be null.</param>
- /// <returns>The number of media info.</returns>
+ /// <returns>The number of media information.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="playlistId"/> is less than or equal to zero.</exception>
+ /// <since_tizen> 4 </since_tizen>
public int CountMember(int playlistId, CountArguments arguments)
{
ValidateDatabase();
}
/// <summary>
- /// Retrieves the member id of the media in the playlist.
+ /// Retrieves the member ID of the media in the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id.</param>
- /// <param name="mediaId">The media id.</param>
- /// <returns>The member id if the member was found in the playlist, otherwise -1.</returns>
+ /// <param name="playlistId">The playlist ID.</param>
+ /// <param name="mediaId">The media ID.</param>
+ /// <returns>The member ID if the member was found in the playlist, otherwise -1.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="playlistId"/> is less than or equal to zero.</exception>
/// <exception cref="ArgumentNullException"><paramref name="mediaId"/> is null.</exception>
/// <exception cref="ArgumentException"><paramref name="mediaId"/> is a zero-length string, contains only white space.</exception>
+ /// <since_tizen> 4 </since_tizen>
public int GetMemberId(int playlistId, string mediaId)
{
ValidateDatabase();
}
/// <summary>
- /// Retrieves the media info of the playlist.
+ /// Retrieves the media information of the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id to query with.</param>
+ /// <param name="playlistId">The playlist ID to query with.</param>
/// <returns>The <see cref="MediaDataReader{TRecord}"/> containing the results.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="playlistId"/> is less than or equal to zero.</exception>
+ /// <since_tizen> 4 </since_tizen>
public MediaDataReader<PlaylistMember> SelectMember(int playlistId)
{
return SelectMember(playlistId, null);
}
/// <summary>
- /// Retrieves the media info of the playlist with <see cref="SelectArguments"/>.
+ /// Retrieves the media information of the playlist with the <see cref="SelectArguments"/>.
/// </summary>
- /// <param name="playlistId">The playlist id to query with.</param>
+ /// <param name="playlistId">The playlist ID to query with.</param>
/// <param name="filter">The criteria to use to filter. This value can be null.</param>
/// <returns>The <see cref="MediaDataReader{TRecord}"/> containing the results.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="playlistId"/> is less than or equal to zero.</exception>
+ /// <since_tizen> 4 </since_tizen>
public MediaDataReader<PlaylistMember> SelectMember(int playlistId, SelectArguments filter)
{
ValidateDatabase();
}
/// <summary>
- /// Updates a playlist with the specified values.
+ /// Updates the playlist with the specified values.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="playlistId">The playlist id to update.</param>
- /// <param name="values">The values for update.</param>
+ /// <param name="playlistId">The playlist ID to update.</param>
+ /// <param name="values">The values for the update.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
- /// <remarks>Only values set in <see cref="PlaylistUpdateValues"/> are updated.</remarks>
+ /// <remarks>Only values set in the <see cref="PlaylistUpdateValues"/> are updated.</remarks>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentNullException"><paramref name="values"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="playlistId"/> is less than or equal to zero.</exception>
/// <exception cref="UnauthorizedAccessException">The caller has no required privilege.</exception>
+ /// <since_tizen> 4 </since_tizen>
public bool Update(int playlistId, PlaylistUpdateValues values)
{
ValidateDatabase();
}
/// <summary>
- /// Adds media to a playlist.
+ /// Adds the media to the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id that the media will be added to.</param>
- /// <param name="mediaId">The media id to add to the playlist.</param>
+ /// <param name="playlistId">The playlist ID that the media will be added to.</param>
+ /// <param name="mediaId">The media ID to add to the playlist.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
- /// <remarks>The invalid media id will be ignored.</remarks>
+ /// <remarks>The invalid media ID will be ignored.</remarks>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentNullException"><paramref name="mediaId"/> is null.</exception>
/// <exception cref="ArgumentException"><paramref name="mediaId"/> is a zero-length string, contains only white space.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="playlistId"/> is less than or equal to zero.</exception>
+ /// <since_tizen> 4 </since_tizen>
public bool AddMember(int playlistId, string mediaId)
{
ValidationUtil.ValidateNotNullOrEmpty(mediaId, nameof(mediaId));
}
/// <summary>
- /// Adds a media set to a playlist.
+ /// Adds the media set to the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id that the media will be added to.</param>
- /// <param name="mediaIds">The collection of media id to add to the playlist.</param>
+ /// <param name="playlistId">The playlist ID that the media will be added to.</param>
+ /// <param name="mediaIds">The collection of media ID to add to the playlist.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
- /// <remarks>The invalid media ids will be ignored.</remarks>
+ /// <remarks>The invalid media IDs will be ignored.</remarks>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentNullException"><paramref name="mediaIds"/> is null.</exception>
/// <exception cref="ArgumentException">
- /// <paramref name="mediaIds"/> has no element.\n
- /// -or-\n
- /// <paramref name="mediaIds"/> contains null value.\n
- /// -or-\n
- /// <paramref name="mediaIds"/> contains a zero-length string or white space.\n
+ /// <paramref name="mediaIds"/> has no element.<br/>
+ /// -or-<br/>
+ /// <paramref name="mediaIds"/> contains null value.<br/>
+ /// -or-<br/>
+ /// <paramref name="mediaIds"/> contains a zero-length string or white space.
/// </exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="playlistId"/> is less than or equal to zero.</exception>
+ /// <since_tizen> 4 </since_tizen>
public bool AddMembers(int playlistId, IEnumerable<string> mediaIds)
{
ValidateDatabase();
}
/// <summary>
- /// Removes a member from a playlist.
+ /// Removes a member from the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id.</param>
- /// <param name="memberId">The member id to be removed.</param>
+ /// <param name="playlistId">The playlist ID.</param>
+ /// <param name="memberId">The member ID to be removed.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
- /// <remarks>The invalid id will be ignored.</remarks>
+ /// <remarks>The invalid ID will be ignored.</remarks>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="playlistId"/> is less than or equal to zero.\n
- /// -or-\n
- /// <paramref name="memberId"/> is less than or equal to zero.\n
+ /// <paramref name="playlistId"/> is less than or equal to zero.<br/>
+ /// -or-<br/>
+ /// <paramref name="memberId"/> is less than or equal to zero.
/// </exception>
+ /// <since_tizen> 4 </since_tizen>
public bool RemoveMember(int playlistId, int memberId)
{
if (memberId <= 0)
}
/// <summary>
- /// Removes a media set from a playlist.
+ /// Removes a media set from the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id.</param>
- /// <param name="memberIds">The collection of member id to remove from to the playlist.</param>
+ /// <param name="playlistId">The playlist ID.</param>
+ /// <param name="memberIds">The collection of member ID to remove from to the playlist.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
- /// <remarks>The invalid ids will be ignored.</remarks>
+ /// <remarks>The invalid IDs will be ignored.</remarks>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentNullException"><paramref name="memberIds"/> is null.</exception>
/// <exception cref="ArgumentException">
- /// <paramref name="memberIds"/> has no element.\n
- /// -or-\n
+ /// <paramref name="memberIds"/> has no element.<br/>
+ /// -or-<br/>
/// <paramref name="memberIds"/> contains a value which is less than or equal to zero.
/// </exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="playlistId"/> is less than or equal to zero.</exception>
+ /// <since_tizen> 4 </since_tizen>
public bool RemoveMembers(int playlistId, IEnumerable<int> memberIds)
{
ValidateDatabase();
}
/// <summary>
- /// Updates a play order of a playlist.
+ /// Updates a play order of the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id.</param>
+ /// <param name="playlistId">The playlist ID.</param>
/// <param name="playOrder">The <see cref="PlayOrder"/> to apply.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
/// <remarks>The <see cref="PlayOrder.MemberId"/> that is invalid will be ignored.</remarks>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentNullException"><paramref name="playOrder"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="playlistId"/> is less than or equal to zero.</exception>
+ /// <since_tizen> 4 </since_tizen>
public bool UpdatePlayOrder(int playlistId, PlayOrder playOrder)
{
if (playOrder == null)
}
/// <summary>
- /// Updates play orders of a playlist.
+ /// Updates play orders of the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id.</param>
- /// <param name="orders">The collection of <see cref="PlayOrder"/> to apply.</param>
+ /// <param name="playlistId">The playlist ID.</param>
+ /// <param name="orders">The collection of the <see cref="PlayOrder"/> to apply.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
/// <remarks>The <see cref="PlayOrder.MemberId"/> that is invalid will be ignored.</remarks>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <exception cref="ArgumentNullException"><paramref name="orders"/> is null.</exception>
/// <exception cref="ArgumentException">
- /// <paramref name="orders"/> has no element.\n
- /// -or-\n
+ /// <paramref name="orders"/> has no element.<br/>
+ /// -or-<br/>
/// <paramref name="orders"/> contains a null value.
/// </exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="playlistId"/> is less than or equal to zero.</exception>
+ /// <since_tizen> 4 </since_tizen>
public bool UpdatePlayOrders(int playlistId, IEnumerable<PlayOrder> orders)
{
ValidateDatabase();
projects / platform / core / csapi / tizenfx.git / blobdiff