@nextcloud/files
Preparing search index...
dav
<internal>
WebDAVClient
Interface WebDAVClient
interface
WebDAVClient
{
copyFile
:
(
filename
:
string
,
destination
:
string
,
options
?:
CopyFileOptions
,
)
=>
Promise
<
void
>
;
createDirectory
:
(
path
:
string
,
options
?:
CreateDirectoryOptions
,
)
=>
Promise
<
void
>
;
createReadStream
:
(
filename
:
string
,
options
?:
CreateReadStreamOptions
,
)
=>
Readable
;
createWriteStream
:
(
filename
:
string
,
options
?:
CreateWriteStreamOptions
,
callback
?:
CreateWriteStreamCallback
,
)
=>
Writable
;
customRequest
:
(
path
:
string
,
requestOptions
:
RequestOptionsCustom
,
)
=>
Promise
<
Response
>
;
deleteFile
:
(
filename
:
string
)
=>
Promise
<
void
>
;
exists
:
(
path
:
string
)
=>
Promise
<
boolean
>
;
getDAVCompliance
:
(
path
:
string
)
=>
Promise
<
DAVCompliance
>
;
getDirectoryContents
:
(
path
:
string
,
options
?:
GetDirectoryContentsOptions
,
)
=>
Promise
<
FileStat
[]
|
ResponseDataDetailed
<
FileStat
[]
>
>
;
getFileContents
:
(
filename
:
string
,
options
?:
GetFileContentsOptions
,
)
=>
Promise
<
string
|
BufferLike
|
ResponseDataDetailed
<
(string | BufferLike)
>
,
>
;
getFileDownloadLink
:
(
filename
:
string
)
=>
string
;
getFileUploadLink
:
(
filename
:
string
)
=>
string
;
getHeaders
:
()
=>
Headers
;
getQuota
:
(
options
?:
GetQuotaOptions
,
)
=>
Promise
<
null
|
DiskQuota
|
ResponseDataDetailed
<
null
|
DiskQuota
>
>
;
lock
:
(
path
:
string
,
options
?:
LockOptions
)
=>
Promise
<
LockResponse
>
;
moveFile
:
(
filename
:
string
,
destinationFilename
:
string
,
options
?:
MoveFileOptions
,
)
=>
Promise
<
void
>
;
partialUpdateFileContents
:
(
filePath
:
string
,
start
:
number
,
end
:
number
,
data
:
string
|
Readable
|
BufferLike
,
options
?:
WebDAVMethodOptions
,
)
=>
Promise
<
void
>
;
putFileContents
:
(
filename
:
string
,
data
:
string
|
Readable
|
BufferLike
,
options
?:
PutFileContentsOptions
,
)
=>
Promise
<
boolean
>
;
search
:
(
path
:
string
,
options
?:
SearchOptions
,
)
=>
Promise
<
SearchResult
|
ResponseDataDetailed
<
SearchResult
>
>
;
setHeaders
:
(
headers
:
Headers
)
=>
void
;
stat
:
(
path
:
string
,
options
?:
StatOptions
,
)
=>
Promise
<
FileStat
|
ResponseDataDetailed
<
FileStat
>
>
;
unlock
:
(
path
:
string
,
token
:
string
,
options
?:
WebDAVMethodOptions
,
)
=>
Promise
<
void
>
;
}
Index
Properties
copy
File
create
Directory
create
Read
Stream
create
Write
Stream
custom
Request
delete
File
exists
get
DAV
Compliance
get
Directory
Contents
get
File
Contents
get
File
Download
Link
get
File
Upload
Link
get
Headers
get
Quota
lock
move
File
partial
Update
File
Contents
put
File
Contents
search
set
Headers
stat
unlock
Properties
copy
File
copyFile
:
(
filename
:
string
,
destination
:
string
,
options
?:
CopyFileOptions
,
)
=>
Promise
<
void
>
create
Directory
createDirectory
:
(
path
:
string
,
options
?:
CreateDirectoryOptions
,
)
=>
Promise
<
void
>
create
Read
Stream
createReadStream
:
(
filename
:
string
,
options
?:
CreateReadStreamOptions
,
)
=>
Readable
create
Write
Stream
createWriteStream
:
(
filename
:
string
,
options
?:
CreateWriteStreamOptions
,
callback
?:
CreateWriteStreamCallback
,
)
=>
Writable
custom
Request
customRequest
:
(
path
:
string
,
requestOptions
:
RequestOptionsCustom
,
)
=>
Promise
<
Response
>
delete
File
deleteFile
:
(
filename
:
string
)
=>
Promise
<
void
>
exists
exists
:
(
path
:
string
)
=>
Promise
<
boolean
>
get
DAV
Compliance
getDAVCompliance
:
(
path
:
string
)
=>
Promise
<
DAVCompliance
>
get
Directory
Contents
getDirectoryContents
:
(
path
:
string
,
options
?:
GetDirectoryContentsOptions
,
)
=>
Promise
<
FileStat
[]
|
ResponseDataDetailed
<
FileStat
[]
>
>
get
File
Contents
getFileContents
:
(
filename
:
string
,
options
?:
GetFileContentsOptions
,
)
=>
Promise
<
string
|
BufferLike
|
ResponseDataDetailed
<
(string | BufferLike)
>
,
>
get
File
Download
Link
getFileDownloadLink
:
(
filename
:
string
)
=>
string
get
File
Upload
Link
getFileUploadLink
:
(
filename
:
string
)
=>
string
get
Headers
getHeaders
:
()
=>
Headers
get
Quota
getQuota
:
(
options
?:
GetQuotaOptions
,
)
=>
Promise
<
null
|
DiskQuota
|
ResponseDataDetailed
<
null
|
DiskQuota
>
>
lock
lock
:
(
path
:
string
,
options
?:
LockOptions
)
=>
Promise
<
LockResponse
>
move
File
moveFile
:
(
filename
:
string
,
destinationFilename
:
string
,
options
?:
MoveFileOptions
,
)
=>
Promise
<
void
>
partial
Update
File
Contents
partialUpdateFileContents
:
(
filePath
:
string
,
start
:
number
,
end
:
number
,
data
:
string
|
Readable
|
BufferLike
,
options
?:
WebDAVMethodOptions
,
)
=>
Promise
<
void
>
put
File
Contents
putFileContents
:
(
filename
:
string
,
data
:
string
|
Readable
|
BufferLike
,
options
?:
PutFileContentsOptions
,
)
=>
Promise
<
boolean
>
search
search
:
(
path
:
string
,
options
?:
SearchOptions
,
)
=>
Promise
<
SearchResult
|
ResponseDataDetailed
<
SearchResult
>
>
set
Headers
setHeaders
:
(
headers
:
Headers
)
=>
void
stat
stat
:
(
path
:
string
,
options
?:
StatOptions
,
)
=>
Promise
<
FileStat
|
ResponseDataDetailed
<
FileStat
>
>
unlock
unlock
:
(
path
:
string
,
token
:
string
,
options
?:
WebDAVMethodOptions
,
)
=>
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
copy
File
create
Directory
create
Read
Stream
create
Write
Stream
custom
Request
delete
File
exists
get
DAV
Compliance
get
Directory
Contents
get
File
Contents
get
File
Download
Link
get
File
Upload
Link
get
Headers
get
Quota
lock
move
File
partial
Update
File
Contents
put
File
Contents
search
set
Headers
stat
unlock
@nextcloud/files
Loading...