Class BookmarkCommand

    Definition

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

    Provides commands to manage bookmarks in the database.

    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    public class BookmarkCommand : MediaCommand
    Inheritance
    object
    MediaCommand
    BookmarkCommand

    Constructors

    View Source

    BookmarkCommand(MediaDatabase)

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

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

    Methods

    View Source

    Count()

    Retrieves the number of bookmarks.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    public int Count()
    Returns
    Type Description
    int

    The number of bookmarks.

    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
    Bookmark
    View Source

    Count(CountArguments)

    Retrieves the number of bookmarks with 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 bookmarks.

    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
    Bookmark
    View Source

    Delete(int)

    Deletes a bookmark from the database.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    public bool Delete(int bookmarkId)
    Parameters
    Type Name Description
    int bookmarkId

    The bookmark 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

    bookmarkId is less than zero.

    System.UnauthorizedAccessException

    The caller has no required privilege.

    See Also
    Bookmark
    View Source

    Insert(string, int, string, string)

    Inserts a new bookmark into the database with the specified media ID, offset, name, and thumbnail path.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    public Bookmark Insert(string mediaId, int offset, string name, string thumbnailPath)
    Parameters
    Type Name Description
    string mediaId

    The media ID to be associated with.

    int offset

    The time offset in milliseconds.

    string name

    The name of the bookmark. This value can be null.

    string thumbnailPath

    The thumbnail path of the bookmark. This value can be null.

    Returns
    Type Description
    Bookmark

    The Bookmark instance that contains the record information inserted.

    Remarks

    The thumbnail may be useful only when the media is video.

    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.UnauthorizedAccessException

    The caller has no required privilege.

    See Also
    Bookmark
    View Source

    Insert(string, int, string)

    Inserts a new bookmark into the database with the specified media ID, offset, and name.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    public Bookmark Insert(string mediaId, int offset, string name)
    Parameters
    Type Name Description
    string mediaId

    The media ID to be associated with.

    int offset

    The time offset in milliseconds.

    string name

    The name of the bookmark. This value can be null.

    Returns
    Type Description
    Bookmark

    The Bookmark 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

    mediaId is null.

    System.ArgumentException

    mediaId is a zero-length string, contains only white space.

    System.UnauthorizedAccessException

    The caller has no required privilege.

    See Also
    Bookmark
    View Source

    Insert(string, int)

    Inserts a new bookmark into the database with the specified media and offset.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    public Bookmark Insert(string mediaId, int offset)
    Parameters
    Type Name Description
    string mediaId

    The media ID to be associated with.

    int offset

    The time offset in milliseconds.

    Returns
    Type Description
    Bookmark

    The Bookmark 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

    mediaId is null.

    System.ArgumentException

    mediaId is a zero-length string, contains only white space.

    System.UnauthorizedAccessException

    The caller has no required privilege.

    See Also
    Bookmark
    View Source

    Select()

    Retrieves the bookmarks.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    public MediaDataReader<Bookmark> Select()
    Returns
    Type Description
    MediaDataReader<Bookmark>

    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
    Bookmark
    View Source

    Select(SelectArguments)

    Retrieves the bookmarks with SelectArguments.

    Declaration
    [Obsolete("Deprecated since API12. Will be removed in API14.")]
    public MediaDataReader<Bookmark> Select(SelectArguments filter)
    Parameters
    Type Name Description
    SelectArguments filter

    The criteria to use to filter. This value can be null.

    Returns
    Type Description
    MediaDataReader<Bookmark>

    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
    Bookmark

    See Also

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