Class TagCommand

    Definition

    Namespace:
    Tizen.Content.MediaContent
    Assembly:
    Tizen.Content.MediaContent.dll

    Provides the commands to manage tags in the database.

    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag

    Methods

    View Source

    AddMedia(int, IEnumerable<string>)

    Adds the media set to a tag.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag
    View Source

    AddMedia(int, string)

    Adds the media to a tag.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag
    View Source

    Count()

    Retrieves the number of tags.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag
    View Source

    Count(CountArguments)

    Retrieves the number of tags with the CountArguments.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag
    View Source

    CountMedia(int, CountArguments)

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

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag
    View Source

    CountMedia(int)

    Retrieves the number of media info of the tag.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag
    View Source

    Delete(int)

    Deletes a tag from the database.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag
    View Source

    Insert(string)

    Inserts a tag into the database with the specified name.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag
    View Source

    RemoveMedia(int, IEnumerable<string>)

    Removes the media set from a tag.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag
    View Source

    RemoveMedia(int, string)

    Removes the media from a tag.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag
    View Source

    Select()

    Retrieves all the tags.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag
    View Source

    Select(int)

    Retrieves the tag with the specified ID.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag
    View Source

    Select(SelectArguments)

    Retrieves the tags with the SelectArguments.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag
    View Source

    SelectMedia(int, SelectArguments)

    Retrieves the media information of the tag with the SelectArguments.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag
    View Source

    SelectMedia(int)

    Retrieves the media information of the tag.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag
    View Source

    UpdateName(int, string)

    Updates a tag with the specified name.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    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.

    See Also
    Tag

    See Also

    Tag
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX