Class CKFinder.dataTypes.Connector

Class Summary
Constructor Attributes	Constructor Name and Description
	CKFinder.dataTypes.Connector(app) The server connector.

Method Summary
Method Attributes	Method Name and Description
	composeUrl(command, paramsObj, type, folder) Compose a standard connector request URL.
	composeUrlParams(paramsObj) Creates a query string from given object.
	currentFolderUrl() Returns url to a currently selected folder.
	currentResourceType() Returns current resource type.
	currentType() Returns the name of current resource type.
	currentTypeHash() Returns the unique hash of current resource type.
	sendCommand(command, paramsObj, callBackFunction, type, folder) Sends a command to the server side connector.
	sendCommandPost(command, paramsGetObj, paramsPostObj, callBackFunction, type, folder) Sends a command to the server side connector.

Class Detail

CKFinder.dataTypes.Connector(app)

Since: 2.0

The server connector.

alert( api.connector.currentFolderUrl() );

Parameters:
{Undefined} app

See:: CKFinderAPI.connector
Note: the CKFinder.dataTypes namespace is not directly accessible (CKFinder.dataTypes is undefined).
Data types are used internally by CKFinder and returned by many functions, like {@link CKFinderAPI#getSelectedFile}.

Method Detail

{Undefined} composeUrl(command, paramsObj, type, folder)

Since: 2.0

Compose a standard connector request URL.

NO EXAMPLE AVAILABLE

Parameters:
{String} command: The command name.
{Object} paramsObj: (Optional) An object from which elements will be added to the URL.
{String} type: (Optional) Resource type name.
{CKFinder.dataTypes.Folder} folder: (Optional) The current folder where the command will be executed.

{String} composeUrlParams(paramsObj)

Since: 2.0

Creates a query string from given object.

NO EXAMPLE AVAILABLE

Parameters:
{Object} paramsObj: (Optional) An object from which elements will be taken.

Returns:: {String}

{String} currentFolderUrl()

Since: 2.0

Returns url to a currently selected folder.

alert( api.connector.currentFolderUrl() );

Returns:: {String} Url of a selected folder.

{CKFinder.dataTypes.ResourceType} currentResourceType()

Since: 2.0

Returns current resource type.

Returns:: {CKFinder.dataTypes.ResourceType} Resource type.

{String} currentType()

Since: 2.0

Returns the name of current resource type.

Returns:: {String} Name of a resource type.

{String} currentTypeHash()

Since: 2.0

Returns the unique hash of current resource type.

Returns:: {String} Hash.

{Undefined} sendCommand(command, paramsObj, callBackFunction, type, folder)

Since: 2.0

Sends a command to the server side connector.

api.connector.sendCommand( 'RotateImage', { FileName : 'foo.jpg' }, function( xml )
	{
		if ( xml.checkError() )
			return;
	} );

Parameters:
{String} command: The command name.
{String} paramsObj: (Optional) An object from which elements will be added to the URL.
{Function} callBackFunction: A callback function that will be executed when the xml response is received from the server (see CKFinder.xml).
{String} type: (Optional) Resource type name.
{CKFinder.dataTypes.Folder} folder: (Optional) The current folder where the command will be executed.

{Undefined} sendCommandPost(command, paramsGetObj, paramsPostObj, callBackFunction, type, folder)

Since: 2.0

Sends a command to the server side connector.

api.connector.sendCommandPost( 'ResizeImage', { FileName : 'foo.jpg' }, { width : '400', height: '500' }, function( xml )
	{
		if ( xml.checkError() )
			return;
	} );

Parameters:
{String} command: The command name.
{Object} paramsGetObj: (Optional) An object from which elements will be added to the URL.
{Object} paramsPostObj: (Optional) An object from which elements will sent in the POST request.
{Function} callBackFunction: A callback function that will be executed when the xml response is received from the server (see CKFinder.xml).
{String} type: (Optional) Resource type name.
{CKFinder.dataTypes.Folder} folder: (Optional) The current folder where the command will be executed.

CKFinder 2 JavaScript API Documentation

Namespaces

Classes

Class CKFinder.dataTypes.Connector