Class TagCommand
Definition
- Namespace:
- Tizen.Content.MediaContent
- Assembly:
- Tizen.Content.MediaContent.dll
- API Level:
- 4
Provides the commands to manage tags in the database.
public class TagCommand : MediaCommand
- Inheritance
Constructors
View SourceTagCommand(MediaDatabase)
Initializes a new instance of the TagCommand class with the specified MediaDatabase.
Declaration
public TagCommand(MediaDatabase database)
Parameters
Type | Name | Description |
---|---|---|
MediaDatabase | database | The MediaDatabase that the commands run on. |
Exceptions
Type | Condition |
---|---|
ArgumentNullException |
|
ObjectDisposedException |
|
API Level: 4
Methods
View SourceAddMedia(Int32, IEnumerable<String>)
Adds the media set to a tag.
Declaration
public bool AddMedia(int tagId, IEnumerable<string> mediaIds)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tagId | The tag ID that the media will be added to. |
IEnumerable<String> | mediaIds | The media ID to add to the tag. |
Returns
Type | Description |
---|---|
Boolean | true if the matched record was found and updated, otherwise false. |
Remarks
The invalid media IDs will be ignored.
Exceptions
Type | Condition |
---|---|
InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
ArgumentNullException |
|
ArgumentException |
|
ArgumentOutOfRangeException |
|
API Level: 4
View SourceAddMedia(Int32, String)
Adds the media to a tag.
Declaration
public bool AddMedia(int tagId, string mediaId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tagId | The tag ID that the media will be added to. |
String | mediaId | The media ID to add to the tag. |
Returns
Type | Description |
---|---|
Boolean | true if the matched record was found and updated, otherwise false. |
Remarks
The invalid media ID will be ignored.
Exceptions
Type | Condition |
---|---|
InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
ArgumentNullException |
|
ArgumentException |
|
ArgumentOutOfRangeException |
|
API Level: 4
View SourceCount()
Retrieves the number of tags.
Declaration
public int Count()
Returns
Type | Description |
---|---|
Int32 | The number of tags. |
Exceptions
Type | Condition |
---|---|
InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
API Level: 4
View SourceCount(CountArguments)
Retrieves the number of tags with the CountArguments.
Declaration
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 |
---|---|
Int32 | The number of tags filtered. |
Exceptions
Type | Condition |
---|---|
InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
API Level: 4
View SourceCountMedia(Int32)
Retrieves the number of media info of the tag.
Declaration
public int CountMedia(int tagId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tagId | The tag ID. |
Returns
Type | Description |
---|---|
Int32 | The number of the media information. |
Exceptions
Type | Condition |
---|---|
InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
ArgumentOutOfRangeException |
|
API Level: 4
View SourceCountMedia(Int32, CountArguments)
Retrieves the number of the media information of the tag with the CountArguments.
Declaration
public int CountMedia(int tagId, CountArguments arguments)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tagId | The tag ID to query with. |
CountArguments | arguments | The criteria to use to filter. This value can be null. |
Returns
Type | Description |
---|---|
Int32 | The number of the media information. |
Exceptions
Type | Condition |
---|---|
InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
ArgumentOutOfRangeException |
|
API Level: 4
View SourceDelete(Int32)
Deletes a tag from the database.
Declaration
public bool Delete(int tagId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tagId | The tag ID to delete. |
Returns
Type | Description |
---|---|
Boolean | true if the matched record was found and deleted, otherwise false. |
Exceptions
Type | Condition |
---|---|
InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
ArgumentOutOfRangeException |
|
UnauthorizedAccessException | The caller has no required privilege. |
API Level: 4
Privilege Level: public
Privilege: http://tizen.org/privilege/content.write
View SourceInsert(String)
Inserts a tag into the database with the specified name.
Declaration
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 |
---|---|
InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
ArgumentNullException |
|
UnauthorizedAccessException | The caller has no required privilege. |
API Level: 4
Privilege Level: public
Privilege: http://tizen.org/privilege/content.write
View SourceRemoveMedia(Int32, IEnumerable<String>)
Removes the media set from a tag.
Declaration
public bool RemoveMedia(int tagId, IEnumerable<string> mediaIds)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tagId | The tag ID. |
IEnumerable<String> | mediaIds | The collection of media ID to remove from the tag. |
Returns
Type | Description |
---|---|
Boolean | true if the matched record was found and updated, otherwise false. |
Remarks
The invalid IDs will be ignored.
Exceptions
Type | Condition |
---|---|
InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
ArgumentNullException |
|
ArgumentException |
|
ArgumentOutOfRangeException |
|
API Level: 4
View SourceRemoveMedia(Int32, String)
Removes the media from a tag.
Declaration
public bool RemoveMedia(int tagId, string mediaId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tagId | The tag ID. |
String | mediaId | The media ID to remove from the tag. |
Returns
Type | Description |
---|---|
Boolean | true if the matched record was found and updated, otherwise false. |
Remarks
The invalid media ID will be ignored.
Exceptions
Type | Condition |
---|---|
InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
ArgumentNullException |
|
ArgumentException |
|
ArgumentOutOfRangeException |
|
API Level: 4
View SourceSelect()
Retrieves all the tags.
Declaration
public MediaDataReader<Tag> Select()
Returns
Type | Description |
---|---|
MediaDataReader<Tag> | The MediaDataReader<TRecord> containing the results. |
Exceptions
Type | Condition |
---|---|
InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
API Level: 4
View SourceSelect(Int32)
Retrieves the tag with the specified ID.
Declaration
public Tag Select(int tagId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | 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 |
---|---|
InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
ArgumentOutOfRangeException |
|
API Level: 4
View SourceSelect(SelectArguments)
Retrieves the tags with the SelectArguments.
Declaration
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 |
---|---|
InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
API Level: 4
View SourceSelectMedia(Int32)
Retrieves the media information of the tag.
Declaration
public MediaDataReader<MediaInfo> SelectMedia(int tagId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tagId | The tag ID. |
Returns
Type | Description |
---|---|
MediaDataReader<MediaInfo> | The MediaDataReader<TRecord> containing the results. |
Exceptions
Type | Condition |
---|---|
InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
ArgumentOutOfRangeException |
|
API Level: 4
View SourceSelectMedia(Int32, SelectArguments)
Retrieves the media information of the tag with the SelectArguments.
Declaration
public MediaDataReader<MediaInfo> SelectMedia(int tagId, SelectArguments filter)
Parameters
Type | Name | Description |
---|---|---|
Int32 | 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 |
---|---|
InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
ArgumentOutOfRangeException |
|
API Level: 4
View SourceUpdateName(Int32, String)
Updates a tag with the specified name.
Declaration
public bool UpdateName(int tagId, string name)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tagId | The tag ID to update. |
String | name | The new name. |
Returns
Type | Description |
---|---|
Boolean | true if the matched record was found and updated, otherwise false. |
Exceptions
Type | Condition |
---|---|
InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
ArgumentNullException |
|
ArgumentOutOfRangeException |
|
UnauthorizedAccessException | The caller has no required privilege. |