JSDoc: Class: Client

Constructor

new Client(options)

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Attributes	Description
`host`	String		host name
`port`	int	<optional>	port
`useHTTPS`	boolean	<optional>	whether to use https
`root`	String	<optional>	root path
`userName`	String	<optional>	user name
`password`	String	<optional>	password

Since:

Source:

core/js/files/client.js, line 14

Members

_client :dav.Client

Client from the library

Type:

dav.Client

Source:

core/js/files/client.js, line 155

_fileInfoParsers :Array.<OC.Files.Client~parseFileInfo>

Array of file info parsing functions.

Type:

Array.<OC.Files.Client~parseFileInfo>

Source:

core/js/files/client.js, line 162

_root :string

Root path of the Webdav endpoint

Type:

string

Source:

core/js/files/client.js, line 148

Methods

_buildPath(…path) → {String}

Append the path to the root and also encode path sections

Parameters:

Name	Type	Attributes	Description
`path`	String	<repeatable>	sections

Source:

core/js/files/client.js, line 213

Returns:

joined path, any leading or trailing slash will be kept

Type: String

_buildUrl(…path) → {String}

Prepends the base url to the given path sections

Parameters:

Name	Type	Attributes	Description
`path`	String	<repeatable>	sections

Source:

core/js/files/client.js, line 193

Returns:

base url + joined path, any leading or trailing slash will be kept

Type: String

_getSabreException(response) → {Object}

Parse the Sabre exception out of the given response, if any

Parameters:

Name	Type	Description
`response`	Object	object

Source:

core/js/files/client.js, line 427

Returns:

array of parsed message and exception (only the first one)

Type: Object

_isSuccessStatus(status)

Returns whether the given status code means success

Parameters:

Name	Type	Description
`status`	int	status code

Source:

core/js/files/client.js, line 417

Returns:

true if status code is between 200 and 299 included

_parseEtag(etag) → {string}

Parses the etag response which is in double quotes.

Parameters:

Name	Type	Description
`etag`	string	etag value in double quotes

Source:

core/js/files/client.js, line 260

Returns:

etag without double quotes

Type: string

_parseFileInfo(response) → {Array.<FileInfo>}

Parse Webdav result

Parameters:

Name	Type	Description
`response`	Object	XML object

Source:

core/js/files/client.js, line 274

Returns:

array of file info

Type: Array.<FileInfo>

_parseHeaders(headersString) → {Object.<String, Array>}

Parse headers string into a map

Parameters:

Name	Type	Description
`headersString`	string	headers list as string

Source:

core/js/files/client.js, line 231

Returns:

map of header name to header contents

Type: Object.<String, Array>

_parseResult(responses)

Parse Webdav multistatus

Parameters:

Name	Type	Description
`responses`	Array

Source:

core/js/files/client.js, line 403

_xhrProvider() → {XMLHttpRequest}

Returns the configured XHR provider for davclient

Source:

core/js/files/client.js, line 168

Returns:

Type: XMLHttpRequest

addFileInfoParser(parserFunction)

Add a file info parser function

Parameters:

Name	Type	Description
`parserFunction`	OC.Files.Client~parseFileInfo

Source:

core/js/files/client.js, line 842

copy(path, destinationPath, allowOverwriteopt) → {Promise}

Copies path to another path

Parameters:

Name	Type	Attributes	Default	Description
`path`	String			path to copy
`destinationPath`	String			destination path
`allowOverwrite`	boolean	<optional>	false	true to allow overwriting, false otherwise

Source:

core/js/files/client.js, line 802

Returns:

promise

Type: Promise

createDirectory(path) → {Promise}

Creates a directory

Parameters:

Name	Type	Description
`path`	String	path to create

Source:

core/js/files/client.js, line 730

Returns:

Type: Promise

getBaseUrl() → {String}

Returns the base URL

Since:

11.0.0

Source:

core/js/files/client.js, line 882

Returns:

base URL

Type: String

getClient() → {dav.Client}

Returns the dav.Client instance used internally

Since:

11.0.0

Source:

core/js/files/client.js, line 852

Returns:

Type: dav.Client

getFileContents(path) → {Promise}

Returns the contents of the given file.

Parameters:

Name	Type	Description
`path`	String	path to file

Source:

core/js/files/client.js, line 624

Returns:

Type: Promise

getFileInfo(path) → {Promise}

Returns the file info of a given path.

Parameters:

Name	Type	Attributes	Description
`path`	String		path
`options.properties`	Array	<optional>	list of Webdav properties to retrieve

Source:

core/js/files/client.js, line 584

Returns:

promise

Type: Promise

getFilteredFiles(filter, optionsopt) → {Promise}

Fetches a flat list of files filtered by a given filter criteria. (currently only system tags is supported)

Parameters:

Name Type Attributes Description

filter

Object

filter criteria

Properties

Name	Type	Attributes	Description
`systemTagIds`	Object	<optional>	list of system tag ids to filter by
`favorite`	bool	<optional>	set it to filter by favorites

options

Object

options

Properties

Name	Type	Attributes	Description
`properties`	Array	<optional>	list of Webdav properties to retrieve

Source:

core/js/files/client.js, line 513

Returns:

promise

Type: Promise

getFolderContents(path, optionsopt) → {Promise}

Lists the contents of a directory

Parameters:

Name Type Attributes Description

path String path to retrieve

options

Object

options

Properties

Name	Type	Attributes	Default	Description
`includeParent`	boolean	<optional>	false	set to true to keep the parent folder in the result list
`properties`	Array	<optional>		list of Webdav properties to retrieve

Source:

core/js/files/client.js, line 466

Returns:

promise

Type: Promise

getHost() → {String}

Returns the host

Since:

13.0.0

Source:

core/js/files/client.js, line 892

Returns:

base URL

Type: String

getPassword() → {String}

Returns the password

Since:

11.0.0

Source:

core/js/files/client.js, line 872

Returns:

password

Type: String

getPropfindProperties() → {Array.<Object>}

Returns the default PROPFIND properties to use during a call.

Source:

core/js/files/client.js, line 446

Returns:

array of properties

Type: Array.<Object>

getUserName() → {String}

Returns the user name

Since:

11.0.0

Source:

core/js/files/client.js, line 862

Returns:

userName

Type: String

move(path, destinationPath, allowOverwriteopt, headersopt) → {Promise}

Moves path to another path

Parameters:

Name	Type	Attributes	Default	Description
`path`	String			path to move
`destinationPath`	String			destination path
`allowOverwrite`	boolean	<optional>	false	true to allow overwriting, false otherwise
`headers`	Object	<optional>	null	additional headers

Source:

core/js/files/client.js, line 756

Returns:

promise

Type: Promise

putFileContents(path, body, optionsopt) → {Promise}

Puts the given data into the given file.

Parameters:

Name Type Attributes Description

path String path to file

body String file body

options

Object

Properties

Name	Type	Attributes	Default	Description
`contentType`	String	<optional>	'text/plain'	content type
`overwrite`	bool	<optional>	true	whether to overwrite an existing file

Source:

core/js/files/client.js, line 659

Returns:

Type: Promise

remove(path) → {Promise}

Deletes a file or directory

Parameters:

Name	Type	Description
`path`	String	path to delete

Source:

core/js/files/client.js, line 741

Returns:

Type: Promise

Type Definitions

parseFileInfo(XML) → {Array}

File info parser function This function receives a list of Webdav properties as input and should return a hash array of parsed properties, if applicable.

Parameters:

Name	Type	Description
`XML`	Object	Webdav properties

Source:

core/js/files/client.js, line 897

Returns:

array of parsed property values

Type: Array