Class TagCommand

Definition

Namespace:: Tizen.Content.MediaContent

Assembly:: Tizen.Content.MediaContent.dll

Provides the commands to manage tags in the database.


                C#
                
                    Copy
                    
                
            
public class TagCommand : MediaCommand

Inheritance: object

MediaCommand

TagCommand

Constructors

View Source

TagCommand(MediaDatabase)

Initializes a new instance of the TagCommand class with the specified MediaDatabase.

Declaration


                C#
                
                    Copy
                    
                
            
public TagCommand(MediaDatabase database)

Parameters

Type	Name	Description
MediaDatabase	database	The MediaDatabase that the commands run on.

Exceptions

Type	Condition
System.ArgumentNullException	`database` is null.
System.ObjectDisposedException	`database` has already been disposed.

Methods

View Source

AddMedia(int, IEnumerable<string>)

Adds the media set to a tag.

Declaration


                C#
                
                    Copy
                    
                
            
public bool AddMedia(int tagId, IEnumerable<string> mediaIds)

Parameters

Type	Name	Description
int	tagId	The tag ID that the media will be added to.
System.Collections.Generic.IEnumerable<T><string>	mediaIds	The media ID to add to the tag.

Returns

Type	Description
bool	true if the matched record was found and updated, otherwise false.

Remarks

The invalid media IDs will be ignored.

Exceptions

Type	Condition
System.InvalidOperationException	The MediaDatabase is disconnected.
System.ObjectDisposedException	The MediaDatabase has already been disposed.
MediaDatabaseException	An error occurred while executing the command.
System.ArgumentNullException	`mediaIds` is null.
System.ArgumentException	`mediaIds` has no element. -or- `mediaIds` contains null value. -or- `mediaIds` contains a zero-length string, contains only white space.
System.ArgumentOutOfRangeException	`tagId` is less than or equal to zero.

AddMedia(int, string)

Adds the media to a tag.

Declaration


                C#
                
                    Copy
                    
                
            
public bool AddMedia(int tagId, string mediaId)

Parameters

Type	Name	Description
int	tagId	The tag ID that the media will be added to.
string	mediaId	The media ID to add to the tag.

Returns

Type	Description
bool	true if the matched record was found and updated, otherwise false.

Remarks

The invalid media ID will be ignored.

Exceptions

Type	Condition
System.InvalidOperationException	The MediaDatabase is disconnected.
System.ObjectDisposedException	The MediaDatabase has already been disposed.
MediaDatabaseException	An error occurred while executing the command.
System.ArgumentNullException	`mediaId` is null.
System.ArgumentException	`mediaId` is a zero-length string, contains only white space.
System.ArgumentOutOfRangeException	`tagId` is less than or equal to zero.

Count()

Retrieves the number of tags.

Declaration


                C#
                
                    Copy
                    
                
            
public int Count()

Returns

Type	Description
int	The number of tags.

Exceptions

Type	Condition
System.InvalidOperationException	The MediaDatabase is disconnected.
System.ObjectDisposedException	The MediaDatabase has already been disposed.
MediaDatabaseException	An error occurred while executing the command.

Count(CountArguments)

Retrieves the number of tags with the CountArguments.

Declaration


                C#
                
                    Copy
                    
                
            
public int Count(CountArguments arguments)

Parameters

Type	Name	Description
CountArguments	arguments	The criteria to use to filter. This value can be null.

Returns

Type	Description
int	The number of tags filtered.

Exceptions

Type	Condition
System.InvalidOperationException	The MediaDatabase is disconnected.
System.ObjectDisposedException	The MediaDatabase has already been disposed.
MediaDatabaseException	An error occurred while executing the command.

CountMedia(int, CountArguments)

Retrieves the number of the media information of the tag with the CountArguments.

Declaration


                C#
                
                    Copy
                    
                
            
public int CountMedia(int tagId, CountArguments arguments)

Parameters

Type	Name	Description
int	tagId	The tag ID to query with.
CountArguments	arguments	The criteria to use to filter. This value can be null.

Returns

Type	Description
int	The number of the media information.

Exceptions

Type	Condition
System.InvalidOperationException	The MediaDatabase is disconnected.
System.ObjectDisposedException	The MediaDatabase has already been disposed.
MediaDatabaseException	An error occurred while executing the command.
System.ArgumentOutOfRangeException	`tagId` is less than or equal to zero.

CountMedia(int)

Retrieves the number of media info of the tag.

Declaration


                C#
                
                    Copy
                    
                
            
public int CountMedia(int tagId)

Parameters

Type	Name	Description
int	tagId	The tag ID.

Returns

Type	Description
int	The number of the media information.

Exceptions

Type	Condition
System.InvalidOperationException	The MediaDatabase is disconnected.
System.ObjectDisposedException	The MediaDatabase has already been disposed.
MediaDatabaseException	An error occurred while executing the command.
System.ArgumentOutOfRangeException	`tagId` is less than or equal to zero.

Delete(int)

Deletes a tag from the database.

Declaration


                C#
                
                    Copy
                    
                
            
public bool Delete(int tagId)

Parameters

Type	Name	Description
int	tagId	The tag ID to delete.

Returns

Type	Description
bool	true if the matched record was found and deleted, otherwise false.

Exceptions

Type	Condition
System.InvalidOperationException	The MediaDatabase is disconnected.
System.ObjectDisposedException	The MediaDatabase has already been disposed.
MediaDatabaseException	An error occurred while executing the command.
System.ArgumentOutOfRangeException	`tagId` is less than or equal to zero.
System.UnauthorizedAccessException	The caller has no required privilege.

Insert(string)

Inserts a tag into the database with the specified name.

Declaration


                C#
                
                    Copy
                    
                
            
public Tag Insert(string name)

Parameters

Type	Name	Description
string	name	The name of tag.

Returns

Type	Description
Tag	The Tag instance that contains the record information inserted.

Exceptions

Type	Condition
System.InvalidOperationException	The MediaDatabase is disconnected.
System.ObjectDisposedException	The MediaDatabase has already been disposed.
MediaDatabaseException	An error occurred while executing the command.
System.ArgumentNullException	`name` is null.
System.UnauthorizedAccessException	The caller has no required privilege.

RemoveMedia(int, IEnumerable<string>)

Removes the media set from a tag.

Declaration


                C#
                
                    Copy
                    
                
            
public bool RemoveMedia(int tagId, IEnumerable<string> mediaIds)

Parameters

Type	Name	Description
int	tagId	The tag ID.
System.Collections.Generic.IEnumerable<T><string>	mediaIds	The collection of media ID to remove from the tag.

Returns

Type	Description
bool	true if the matched record was found and updated, otherwise false.

Remarks

The invalid IDs will be ignored.

Exceptions

Type	Condition
System.InvalidOperationException	The MediaDatabase is disconnected.
System.ObjectDisposedException	The MediaDatabase has already been disposed.
MediaDatabaseException	An error occurred while executing the command.
System.ArgumentNullException	`mediaIds` is null.
System.ArgumentException	`mediaIds` has no element. -or- `mediaIds` contains null value. -or- `mediaIds` contains a zero-length string or white space.
System.ArgumentOutOfRangeException	`tagId` is less than or equal to zero.

RemoveMedia(int, string)

Removes the media from a tag.

Declaration


                C#
                
                    Copy
                    
                
            
public bool RemoveMedia(int tagId, string mediaId)

Parameters

Type	Name	Description
int	tagId	The tag ID.
string	mediaId	The media ID to remove from the tag.

Returns

Type	Description
bool	true if the matched record was found and updated, otherwise false.

Remarks

The invalid media ID will be ignored.

Exceptions

Type	Condition
System.InvalidOperationException	The MediaDatabase is disconnected.
System.ObjectDisposedException	The MediaDatabase has already been disposed.
MediaDatabaseException	An error occurred while executing the command.
System.ArgumentNullException	`mediaId` is null.
System.ArgumentException	`mediaId` is a zero-length string, contains only white space.
System.ArgumentOutOfRangeException	`tagId` is less than or equal to zero.

Select()

Retrieves all the tags.

Declaration


                C#
                
                    Copy
                    
                
            
public MediaDataReader<Tag> Select()

Returns

Type	Description
MediaDataReader<Tag>	The MediaDataReader<TRecord> containing the results.

Exceptions

Type	Condition
System.InvalidOperationException	The MediaDatabase is disconnected.
System.ObjectDisposedException	The MediaDatabase has already been disposed.
MediaDatabaseException	An error occurred while executing the command.

Select(int)

Retrieves the tag with the specified ID.

Declaration


                C#
                
                    Copy
                    
                
            
public Tag Select(int tagId)

Parameters

Type	Name	Description
int	tagId	The tag ID to select.

Returns

Type	Description
Tag	The Tag instance if the matched record was found in the database, otherwise null.

Exceptions

Type	Condition
System.InvalidOperationException	The MediaDatabase is disconnected.
System.ObjectDisposedException	The MediaDatabase has already been disposed.
MediaDatabaseException	An error occurred while executing the command.
System.ArgumentOutOfRangeException	`tagId` is less than or equal to zero.

Select(SelectArguments)

Retrieves the tags with the SelectArguments.

Declaration


                C#
                
                    Copy
                    
                
            
public MediaDataReader<Tag> Select(SelectArguments arguments)

Parameters

Type	Name	Description
SelectArguments	arguments	The criteria to use to filter. This value can be null.

Returns

Type	Description
MediaDataReader<Tag>	The MediaDataReader<TRecord> containing the results.

Exceptions

Type	Condition
System.InvalidOperationException	The MediaDatabase is disconnected.
System.ObjectDisposedException	The MediaDatabase has already been disposed.
MediaDatabaseException	An error occurred while executing the command.

SelectMedia(int, SelectArguments)

Retrieves the media information of the tag with the SelectArguments.

Declaration


                C#
                
                    Copy
                    
                
            
public MediaDataReader<MediaInfo> SelectMedia(int tagId, SelectArguments filter)

Parameters

Type	Name	Description
int	tagId	The tag ID.
SelectArguments	filter	The criteria to use to filter. This value can be null.

Returns

Type	Description
MediaDataReader<MediaInfo>	The MediaDataReader<TRecord> containing the results.

Exceptions

Type	Condition
System.InvalidOperationException	The MediaDatabase is disconnected.
System.ObjectDisposedException	The MediaDatabase has already been disposed.
MediaDatabaseException	An error occurred while executing the command.
System.ArgumentOutOfRangeException	`tagId` is less than or equal to zero.

SelectMedia(int)

Retrieves the media information of the tag.

Declaration


                C#
                
                    Copy
                    
                
            
public MediaDataReader<MediaInfo> SelectMedia(int tagId)

Parameters

Type	Name	Description
int	tagId	The tag ID.

Returns

Type	Description
MediaDataReader<MediaInfo>	The MediaDataReader<TRecord> containing the results.

Exceptions

Type	Condition
System.InvalidOperationException	The MediaDatabase is disconnected.
System.ObjectDisposedException	The MediaDatabase has already been disposed.
MediaDatabaseException	An error occurred while executing the command.
System.ArgumentOutOfRangeException	`tagId` is less than or equal to zero.

UpdateName(int, string)

Updates a tag with the specified name.

Declaration


                C#
                
                    Copy
                    
                
            
public bool UpdateName(int tagId, string name)

Parameters

Type	Name	Description
int	tagId	The tag ID to update.
string	name	The new name.

Returns

Type	Description
bool	true if the matched record was found and updated, otherwise false.

Exceptions

Type	Condition
System.InvalidOperationException	The MediaDatabase is disconnected.
System.ObjectDisposedException	The MediaDatabase has already been disposed.
MediaDatabaseException	An error occurred while executing the command.
System.ArgumentNullException	`name` is null.
System.ArgumentOutOfRangeException	`tagId` is less than or equal to zero.
System.UnauthorizedAccessException	The caller has no required privilege.

Class TagCommand

Definition

Constructors

TagCommand(MediaDatabase)

Declaration

Parameters

Exceptions

See Also

Methods

AddMedia(int, IEnumerable<string>)

Declaration

Parameters

Returns

Remarks

Exceptions

See Also

AddMedia(int, string)

Declaration

Parameters

Returns

Remarks

Exceptions

See Also

Count()

Declaration

Returns

Exceptions

See Also

Count(CountArguments)

Declaration

Parameters

Returns

Exceptions

See Also

CountMedia(int, CountArguments)

Declaration

Parameters

Returns

Exceptions

See Also

CountMedia(int)

Declaration

Parameters

Returns

Exceptions

See Also

Delete(int)

Declaration

Parameters

Returns

Exceptions

See Also

Insert(string)

Declaration

Parameters

Returns

Exceptions

See Also

RemoveMedia(int, IEnumerable<string>)

Declaration

Parameters

Returns

Remarks

Exceptions

See Also

RemoveMedia(int, string)

Declaration

Parameters

Returns

Remarks

Exceptions

See Also

Select()

Declaration

Returns

Exceptions

See Also

Select(int)

Declaration

Parameters