Class BookmarkCommand
Definition
- Namespace:
- Tizen.Content.MediaContent
- Assembly:
- Tizen.Content.MediaContent.dll
Provides commands to manage bookmarks in the database.
public class BookmarkCommand : MediaCommand
- Inheritance
Constructors
View SourceBookmarkCommand(MediaDatabase)
Initializes a new instance of the BookmarkCommand class with the specified MediaDatabase.
Declaration
public BookmarkCommand(MediaDatabase database)
Parameters
Type | Name | Description |
---|---|---|
MediaDatabase | database | The MediaDatabase that the commands run on. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
|
System.ObjectDisposedException |
|
See Also
Methods
View SourceCount()
Retrieves the number of bookmarks.
Declaration
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 of. |
MediaDatabaseException | An error occurred while executing the command. |
See Also
View SourceCount(CountArguments)
Retrieves the number of bookmarks with 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 |
---|---|
int | The number of bookmarks. |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The MediaDatabase is disconnected. |
System.ObjectDisposedException | The MediaDatabase has already been disposed of. |
MediaDatabaseException | An error occurred while executing the command. |
See Also
View SourceDelete(int)
Deletes a bookmark from the database.
Declaration
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 of. |
MediaDatabaseException | An error occurred while executing the command. |
System.ArgumentOutOfRangeException |
|
System.UnauthorizedAccessException | The caller has no required privilege. |
See Also
View SourceInsert(string, int, string, string)
Inserts a new bookmark into the database with the specified media ID, offset, name, and thumbnail path.
Declaration
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 of. |
MediaDatabaseException | An error occurred while executing the command. |
System.ArgumentNullException |
|
System.ArgumentException |
|
System.UnauthorizedAccessException | The caller has no required privilege. |
See Also
View SourceInsert(string, int, string)
Inserts a new bookmark into the database with the specified media ID, offset, and name.
Declaration
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 of. |
MediaDatabaseException | An error occurred while executing the command. |
System.ArgumentNullException |
|
System.ArgumentException |
|
System.UnauthorizedAccessException | The caller has no required privilege. |
See Also
View SourceInsert(string, int)
Inserts a new bookmark into the database with the specified media and offset.
Declaration
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 of. |
MediaDatabaseException | An error occurred while executing the command. |
System.ArgumentNullException |
|
System.ArgumentException |
|
System.UnauthorizedAccessException | The caller has no required privilege. |
See Also
View SourceSelect()
Retrieves the bookmarks.
Declaration
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 of. |
MediaDatabaseException | An error occurred while executing the command. |
See Also
View SourceSelect(SelectArguments)
Retrieves the bookmarks with SelectArguments.
Declaration
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 of. |
MediaDatabaseException | An error occurred while executing the command. |