Class BookmarkCommand
Definition
- Namespace:
- Tizen.Content.MediaContent
- Assembly:
- Tizen.Content.MediaContent.dll
- API Level:
- 4
Provides commands to manage bookmarks in the database.
C#Copypublic class BookmarkCommand : MediaCommand
- Inheritance
Constructors
BookmarkCommand(MediaDatabase)
Initializes a new instance of the BookmarkCommand class with the specified MediaDatabase.
Declaration
C#Copypublic BookmarkCommand(MediaDatabase database)
Parameters
Type | Name | Description |
---|---|---|
MediaDatabase | database | The MediaDatabase that the commands run on. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
|
ObjectDisposedException |
|
API Level: 4
Methods
Declaration
C#Copypublic int Count()
Returns
Type | Description |
---|---|
System.Int32 | The number of bookmarks. |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
API Level: 4
Declaration
C#Copypublic int Count(CountArguments arguments)
Parameters
Type | Name | Description |
---|---|---|
CountArguments | arguments | The criteria to use to filter. This value can be null. |
Returns
Type | Description |
---|---|
System.Int32 | The number of bookmarks. |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
API Level: 4
Declaration
C#Copypublic bool Delete(int bookmarkId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | bookmarkId | The bookmark ID to delete. |
Returns
Type | Description |
---|---|
System.Boolean | true if the matched record was found and deleted, otherwise false. |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
System.ArgumentOutOfRangeException |
|
UnauthorizedAccessException | The caller has no required privilege. |
API Level: 4
Privilege Level: public
Privilege: http://tizen.org/privilege/content.write
Insert(String, Int32)
Inserts a new bookmark into the database with the specified media and offset.
Declaration
C#Copypublic Bookmark Insert(string mediaId, int offset)
Parameters
Type | Name | Description |
---|---|---|
System.String | mediaId | The media ID to be associated with. |
System.Int32 | 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. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
System.ArgumentNullException |
|
System.ArgumentException |
|
UnauthorizedAccessException | The caller has no required privilege. |
API Level: 4
Privilege Level: public
Privilege: http://tizen.org/privilege/content.write
Insert(String, Int32, String)
Inserts a new bookmark into the database with the specified media ID, offset, and name.
Declaration
C#Copypublic Bookmark Insert(string mediaId, int offset, string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | mediaId | The media ID to be associated with. |
System.Int32 | offset | The time offset in milliseconds. |
System.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. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
System.ArgumentNullException |
|
System.ArgumentException |
|
UnauthorizedAccessException | The caller has no required privilege. |
API Level: 4
Privilege Level: public
Privilege: http://tizen.org/privilege/content.write
Insert(String, Int32, String, String)
Inserts a new bookmark into the database with the specified media ID, offset, name, and thumbnail path.
Declaration
C#Copypublic Bookmark Insert(string mediaId, int offset, string name, string thumbnailPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | mediaId | The media ID to be associated with. |
System.Int32 | offset | The time offset in milliseconds. |
System.String | name | The name of the bookmark. This value can be null. |
System.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. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
System.ArgumentNullException |
|
System.ArgumentException |
|
UnauthorizedAccessException | The caller has no required privilege. |
API Level: 4
Privilege Level: public
Privilege: http://tizen.org/privilege/content.write
Declaration
C#Copypublic MediaDataReader<Bookmark> Select()
Returns
Type | Description |
---|---|
MediaDataReader<Bookmark> | The MediaDataReader<TRecord> containing the results. |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The MediaDatabase is disconnected. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |
API Level: 4
Declaration
C#Copypublic 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. |
ObjectDisposedException | The MediaDatabase has already been disposed. |
MediaDatabaseException | An error occurred while executing the command. |