#include <FileOperations.h>

Inheritance diagram for JSONRPC::CFileOperations:

Static Public Member Functions
static JSONRPC_STATUS	GetRootDirectory (const std::string &method, ITransportLayer transport, IClient client, const CVariant &parameterObject, CVariant &result)

static JSONRPC_STATUS	GetDirectory (const std::string &method, ITransportLayer transport, IClient client, const CVariant &parameterObject, CVariant &result)

static JSONRPC_STATUS	GetFileDetails (const std::string &method, ITransportLayer transport, IClient client, const CVariant &parameterObject, CVariant &result)

static JSONRPC_STATUS	SetFileDetails (const std::string &method, ITransportLayer transport, IClient client, const CVariant &parameterObject, CVariant &result)

static JSONRPC_STATUS	PrepareDownload (const std::string &method, ITransportLayer transport, IClient client, const CVariant &parameterObject, CVariant &result)

static JSONRPC_STATUS	Download (const std::string &method, ITransportLayer transport, IClient client, const CVariant &parameterObject, CVariant &result)

static bool	FillFileItem (const std::shared_ptr< CFileItem > &originalItem, std::shared_ptr< CFileItem > &item, const std::string &media="", const CVariant &parameterObject=CVariant(CVariant::VariantTypeArray))

static bool	FillFileItemList (const CVariant &parameterObject, CFileItemList &list)

Static Public Member Functions inherited from JSONRPC::CJSONUtils
static void	MillisecondsToTimeObject (int time, CVariant &result)

Additional Inherited Members
Static Protected Member Functions inherited from JSONRPC::CFileItemHandler
static void	FillDetails (const ISerializable info, const std::shared_ptr< CFileItem > &item, std::set< std::string > &fields, CVariant &result, CThumbLoader thumbLoader=nullptr)

static void	HandleFileItemList (const char ID, bool allowFile, const char resultname, CFileItemList &items, const CVariant &parameterObject, CVariant &result, bool sortLimit=true)

static void	HandleFileItemList (const char ID, bool allowFile, const char resultname, CFileItemList &items, const CVariant &parameterObject, CVariant &result, int size, bool sortLimit=true)

static void	HandleFileItem (const char ID, bool allowFile, const char resultname, const std::shared_ptr< CFileItem > &item, const CVariant &parameterObject, const CVariant &validFields, CVariant &result, bool append=true, CThumbLoader *thumbLoader=nullptr)

static void	HandleFileItem (const char ID, bool allowFile, const char resultname, const std::shared_ptr< CFileItem > &item, const CVariant &parameterObject, const std::set< std::string > &validFields, CVariant &result, bool append=true, CThumbLoader *thumbLoader=nullptr)

static bool	FillFileItemList (const CVariant &parameterObject, CFileItemList &list)

Static Protected Member Functions inherited from JSONRPC::CJSONUtils
static void	HandleLimits (const CVariant &parameterObject, CVariant &result, int size, int &start, int &end)

static bool	ParseSorting (const CVariant &parameterObject, SortBy &sortBy, SortOrder &sortOrder, SortAttribute &sortAttributes)

static void	ParseLimits (const CVariant &parameterObject, int &limitStart, int &limitEnd)

static bool	ParameterExists (const CVariant &parameterObject, const std::string &key, unsigned int position)
	Checks if the given object contains a parameter.

static bool	IsValueMember (const CVariant &value, const std::string &key)
	Checks if the given object contains a value with the given key.

static CVariant	GetParameter (const CVariant &parameterObject, const std::string &key, unsigned int position)
	Returns the json value of a parameter.

static CVariant	GetParameter (const CVariant &parameterObject, const std::string &key, unsigned int position, const CVariant &fallback)
	Returns the json value of a parameter or the given default value.

static std::string	GetString (const CVariant &value, const char *defaultValue)
	Returns the given json value as a string.

static TransportLayerCapability	StringToTransportLayer (const std::string &transport)
	Returns a TransportLayerCapability value of the given string representation.

static JSONSchemaType	StringToSchemaValueType (const std::string &valueType)
	Returns a JSONSchemaType value for the given string representation.

static std::string	SchemaValueTypeToString (JSONSchemaType valueType)
	Returns a string representation for the given JSONSchemaType.

static void	SchemaValueTypeToJson (JSONSchemaType valueType, CVariant &jsonObject)
	Converts the given json schema type into a json object.

static const char *	ValueTypeToString (CVariant::VariantType valueType)

static bool	IsParameterType (const CVariant &parameterObject, const char *key, unsigned int position, JSONSchemaType valueType)
	Checks if the parameter with the given name or at the given position is of a certain type.

static bool	IsType (const CVariant &value, JSONSchemaType valueType)
	Checks if the given json value is of the given type.

static void	SetDefaultValue (CVariant &value, JSONSchemaType valueType)
	Sets the value of the given json value to the default value of the given type.

static bool	HasType (JSONSchemaType typeObject, JSONSchemaType type)

static bool	ParameterNotNull (const CVariant &parameterObject, const std::string &key)

static void	CopyStringArray (const CVariant &jsonStringArray, std::vector< std::string > &stringArray)
	Copies the values from the jsonStringArray to the stringArray. stringArray is cleared.

static void	SetFromDBDate (const CVariant &jsonDate, CDateTime &date)

static void	SetFromDBDateTime (const CVariant &jsonDate, CDateTime &date)

static bool	GetXspFiltering (const std::string &type, const CVariant &filter, std::string &xsp)

Member Function Documentation

◆ Download()

JSONRPC_STATUS CFileOperations::Download	(	const std::string &	method,
		ITransportLayer *	transport,
		IClient *	client,
		const CVariant &	parameterObject,
		CVariant &	result )

static

◆ FillFileItem()

bool CFileOperations::FillFileItem	(	const std::shared_ptr< CFileItem > &	originalItem,
		std::shared_ptr< CFileItem > &	item,
		const std::string &	media = "",
		const CVariant &	parameterObject = CVariant(CVariant::VariantTypeArray) )

static

◆ FillFileItemList()

bool CFileOperations::FillFileItemList	(	const CVariant &	parameterObject,
		CFileItemList &	list )

static

◆ GetDirectory()

JSONRPC_STATUS CFileOperations::GetDirectory	(	const std::string &	method,
		ITransportLayer *	transport,
		IClient *	client,
		const CVariant &	parameterObject,
		CVariant &	result )

static

◆ GetFileDetails()

JSONRPC_STATUS CFileOperations::GetFileDetails	(	const std::string &	method,
		ITransportLayer *	transport,
		IClient *	client,
		const CVariant &	parameterObject,
		CVariant &	result )

static

◆ GetRootDirectory()

JSONRPC_STATUS CFileOperations::GetRootDirectory	(	const std::string &	method,
		ITransportLayer *	transport,
		IClient *	client,
		const CVariant &	parameterObject,
		CVariant &	result )

static

◆ PrepareDownload()

JSONRPC_STATUS CFileOperations::PrepareDownload	(	const std::string &	method,
		ITransportLayer *	transport,
		IClient *	client,
		const CVariant &	parameterObject,
		CVariant &	result )

static

◆ SetFileDetails()

JSONRPC_STATUS CFileOperations::SetFileDetails	(	const std::string &	method,
		ITransportLayer *	transport,
		IClient *	client,
		const CVariant &	parameterObject,
		CVariant &	result )

static

The documentation for this class was generated from the following files:

Static Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ Download()

◆ FillFileItem()

◆ FillFileItemList()

◆ GetDirectory()

◆ GetFileDetails()

◆ GetRootDirectory()

◆ PrepareDownload()

◆ SetFileDetails()