Class FolderCommand

Definition

Namespace:: Tizen.Content.MediaContent

Assembly:: Tizen.Content.MediaContent.dll

Provides commands to manage folders and query related media items in the database.


                C#
                
                    Copy
                    
                
            
public class FolderCommand : MediaCommand

Inheritance: object

MediaCommand

FolderCommand

Constructors

View Source

FolderCommand(MediaDatabase)

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

Declaration


                C#
                
                    Copy
                    
                
            
public FolderCommand(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.

Methods

View Source

Count()

Retrieves the number of folders.

Declaration


                C#
                
                    Copy
                    
                
            
public int Count()

Returns

Type	Description
int	The number of folders.

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.

View Source

Count(CountArguments)

Retrieves the number of folders with the 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
int	The number of folders.

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.

View Source

CountMedia(string, CountArguments)

Retrieves the number of media information under the folder with the CountArguments.

Declaration


                C#
                
                    Copy
                    
                
            
public int CountMedia(string folderId, CountArguments arguments)

Parameters

Type	Name	Description
string	folderId	The ID of the folder to count media in the folder.
CountArguments	arguments	The criteria to use to filter. This value can be null.

Returns

Type	Description
int	The number of 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.ArgumentNullException	`folderId` is null.
System.ArgumentException	`folderId` is a zero-length string, contains only white space.

View Source

CountMedia(string)

Retrieves the number of media information under the folder.

Declaration


                C#
                
                    Copy
                    
                
            
public int CountMedia(string folderId)

Parameters

Type	Name	Description
string	folderId	The ID of the folder to count media in the folder.

Returns

Type	Description
int	The number of 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.ArgumentNullException	`folderId` is null.
System.ArgumentException	`folderId` is a zero-length string, contains only white space.

View Source

Select()

Retrieves the folders.

Declaration


                C#
                
                    Copy
                    
                
            
public MediaDataReader<Folder> Select()

Returns

Type	Description
MediaDataReader<Folder>	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.

View Source

Select(string)

Retrieves the folder.

Declaration


                C#
                
                    Copy
                    
                
            
public Folder Select(string folderId)

Parameters

Type	Name	Description
string	folderId	The folder ID to query with.

Returns

Type	Description
Folder	The Folder 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.ArgumentNullException	`folderId` is null.
System.ArgumentException	`folderId` is a zero-length string, contains only white space.

View Source

Select(SelectArguments)

Retrieves the folders with the SelectArguments.

Declaration


                C#
                
                    Copy
                    
                
            
public MediaDataReader<Folder> Select(SelectArguments arguments)

Parameters

Type	Name	Description
SelectArguments	arguments	The criteria to use to filter. This value can be null.

Returns

Type	Description
MediaDataReader<Folder>	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.

View Source

SelectMedia(string, SelectArguments)

Retrieves the media information under the folder with the SelectArguments.

Declaration


                C#
                
                    Copy
                    
                
            
public MediaDataReader<MediaInfo> SelectMedia(string folderId, SelectArguments filter)

Parameters

Type	Name	Description
string	folderId	The ID of the folder to select media in the folder.
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.ArgumentNullException	`folderId` is null.
System.ArgumentException	`folderId` is a zero-length string, contains only white space.

View Source

SelectMedia(string)

Retrieves the media information under the folder.

Declaration


                C#
                
                    Copy
                    
                
            
public MediaDataReader<MediaInfo> SelectMedia(string folderId)

Parameters

Type	Name	Description
string	folderId	The ID of the folder to select media in the folder.

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.ArgumentNullException	`folderId` is null.
System.ArgumentException	`folderId` is a zero-length string, contains only white space.