Class BookmarkCommand

View Source

Definition

Namespace:
Tizen.Content.MediaContent
Assembly:
Tizen.Content.MediaContent.dll
API Level:
4

Provides commands to manage bookmarks in the database.


                
C#

                

                    
Copy

                    

                

            
public class BookmarkCommand : MediaCommand
Inheritance
System.Object
MediaCommand
BookmarkCommand

Constructors

View Source

BookmarkCommand(MediaDatabase)

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

Declaration

                
C#

                

                    
Copy

                    

                

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

database has already been disposed.
API Level: 4

Methods

View Source

Count()

Retrieves the number of bookmarks.

Declaration

                
C#

                

                    
Copy

                    

                

            
public int Count()
Returns
Type Description
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
View Source

Count(CountArguments)

Retrieves the number of bookmarks with CountArguments.

Declaration

                
C#

                

                    
Copy

                    

                

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

Delete(Int32)

Deletes a bookmark from the database.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool Delete(int bookmarkId)
Parameters
Type Name Description
Int32 bookmarkId

The bookmark ID to delete.
Returns
Type Description
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

bookmarkId is less than zero.
UnauthorizedAccessException

The caller has no required privilege.
API Level: 4
Privilege Level: public
Privilege: http://tizen.org/privilege/content.write
View Source

Insert(String, Int32)

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public Bookmark Insert(string mediaId, int offset)
Parameters
Type Name Description
System.String mediaId

The media ID to be associated with.
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

mediaId is null.
System.ArgumentException

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

The caller has no required privilege.
API Level: 4
Privilege Level: public
Privilege: http://tizen.org/privilege/content.write
View Source

Insert(String, Int32, String)

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public Bookmark Insert(string mediaId, int offset, string name)
Parameters
Type Name Description
System.String mediaId

The media ID to be associated with.
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

mediaId is null.
System.ArgumentException

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

The caller has no required privilege.
API Level: 4
Privilege Level: public
Privilege: http://tizen.org/privilege/content.write
View Source

Insert(String, Int32, String, String)

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public Bookmark Insert(string mediaId, int offset, string name, string thumbnailPath)
Parameters
Type Name Description
System.String mediaId

The media ID to be associated with.
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

mediaId is null.
System.ArgumentException

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

The caller has no required privilege.
API Level: 4
Privilege Level: public
Privilege: http://tizen.org/privilege/content.write
View Source

Select()

Retrieves the bookmarks.

Declaration

                
C#

                

                    
Copy

                    

                

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

Select(SelectArguments)

Retrieves the bookmarks with SelectArguments.

Declaration

                
C#

                

                    
Copy

                    

                

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

The MediaDatabase has already been disposed.
MediaDatabaseException

An error occurred while executing the command.
API Level: 4

See Also