

cozy-client / models / file

Namespace: file

models.file

Interfaces

• FileUploadOptions

Variables

ALBUMS_DOCTYPE

• Const ALBUMS_DOCTYPE: "io.cozy.photos.albums"

Defined in

packages/cozy-client/src/models/file.js:14

Functions

doMobileUpload

▸ doMobileUpload(client, fileURL, options): Promise<any>

Upload a file on a mobile

Parameters

Name	Type	Description
client	CozyClient	The CozyClient instance
fileURL	string	The local file path (file://)
options	FileUploadOptions	The upload options

Returns

Promise<any>

Defined in

packages/cozy-client/src/models/file.js:554

---

ensureFilePath

▸ ensureFilePath(file, parent): any

Ensure the file has a path attribute, or build it

Parameters

Name	Type	Description
file	any	object representing the file
parent	any	parent directory for the file

Returns

any

file object with path attribute

Defined in

packages/cozy-client/src/models/file.js:136

---

fetchBlobFileById

▸ fetchBlobFileById(client, fileId): Promise<Blob>

Parameters

Name	Type	Description
client	CozyClient	Instance of CozyClient
fileId	string	Id of io.cozy.files document

Returns

Promise<Blob>

Defined in

packages/cozy-client/src/models/file.js:600

---

fetchFilesByQualificationRules

▸ fetchFilesByQualificationRules(client, docRules): Promise<any>

Helper to query files based on qualification rules

Parameters

Name	Type	Description
client	any	The CozyClient instance
docRules	any	the rules containing the searched qualification and the count

Returns

Promise<any>

The files found by the rules

Defined in

packages/cozy-client/src/models/file.js:256

---

generateFileNameForRevision

▸ generateFileNameForRevision(file, revision, f): string

Generate a file name for a revision

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.files document
revision	any	The revision containing the updated_at
f	Function	A function taking a a date and a format as arguments to generate the name.

Returns

string

Defined in

packages/cozy-client/src/models/file.js:434

---

generateNewFileNameOnConflict

▸ generateNewFileNameOnConflict(filenameWithoutExtension, conflictOptions): string

Method to generate a new filename if there is a conflict

Parameters

Name	Type	Description
filenameWithoutExtension	string	A filename without the extension
conflictOptions	ConflictOptions	-

Returns

string

A filename with the right suffix

Defined in

packages/cozy-client/src/models/file.js:404

---

getFullpath

▸ getFullpath(client, dirId, name): Promise<string>

async getFullpath - Gets a file’s path

Parameters

Name	Type	Description
client	CozyClient	The CozyClient instance
dirId	string	The id of the parent directory
name	string	The file’s name

Returns

Promise<string>

The full path of the file in the cozy

Defined in

packages/cozy-client/src/models/file.js:291

---

getParentFolderId

▸ getParentFolderId(file): string

Get the id of the parent folder (null for the root folder)

Parameters

Name	Type	Description
file	any	io.cozy.files document

Returns

string

id of the parent folder, if any

Defined in

packages/cozy-client/src/models/file.js:150

---

getSharingShortcutStatus

▸ getSharingShortcutStatus(file): string

Returns the status of a sharing shortcut.

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.files document

Returns

string

A description of the status

Defined in

packages/cozy-client/src/models/file.js:162

---

getSharingShortcutTargetDoctype

▸ getSharingShortcutTargetDoctype(file): string

Returns the doctype of the target of the sharing shortcut.

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.files document

Returns

string

A doctype

Defined in

packages/cozy-client/src/models/file.js:182

---

getSharingShortcutTargetMime

▸ getSharingShortcutTargetMime(file): string

Returns the mime type of the target of the sharing shortcut, if it is a file.

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.files document

Returns

string

The mime-type of the target file, or an empty string is the target is not a file.

Defined in

packages/cozy-client/src/models/file.js:172

---

hasCertifications

▸ hasCertifications(file): boolean

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.files document

Returns

boolean

Defined in

packages/cozy-client/src/models/file.js:580

---

hasMetadataAttribute

▸ hasMetadataAttribute(params): boolean

Whether the file’s metadata attribute exists

Parameters

Name	Type	Description
params	Object	Param
params.attribute	string	Metadata attribute to check
params.file	IOCozyFile	An io.cozy.files document

Returns

boolean

Defined in

packages/cozy-client/src/models/file.js:280

---

hasQualifications

▸ hasQualifications(file): boolean

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.files document

Returns

boolean

Defined in

packages/cozy-client/src/models/file.js:572

---

isDirectory

▸ isDirectory(file): boolean

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.files

Returns

boolean

Defined in

packages/cozy-client/src/models/file.js:46

---

isEncrypted

▸ isEncrypted(file): boolean

Whether the file is client-side encrypted

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.files document

Returns

boolean

Defined in

packages/cozy-client/src/models/file.js:74

---

isFile

▸ isFile(file): boolean

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.files

Returns

boolean

Defined in

packages/cozy-client/src/models/file.js:40

---

isFromKonnector

▸ isFromKonnector(file): boolean

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.files document

Returns

boolean

Defined in

packages/cozy-client/src/models/file.js:591

---

isNote

▸ isNote(file): boolean

Is file param a correct note

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.files

Returns

boolean

Defined in

packages/cozy-client/src/models/file.js:54

---

isOnlyOfficeFile

▸ isOnlyOfficeFile(file): boolean

Whether the file is supported by Only Office

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.file document

Returns

boolean

Defined in

packages/cozy-client/src/models/file.js:84

---

isPlainText

▸ isPlainText(mimeType?, fileName?): boolean

Parameters

Name	Type	Default value
mimeType	string	''
fileName	string	''

Returns

boolean

Defined in

packages/cozy-client/src/models/file.js:564

---

isSharingShorcut

▸ isSharingShorcut(file): boolean

Returns whether the file is a shortcut to a sharing

deprecated Prefer to use isSharingShortcut.

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.files document

Returns

boolean

Defined in

packages/cozy-client/src/models/file.js:202

---

isSharingShorcutNew

▸ isSharingShorcutNew(file): boolean

Returns whether the sharing shortcut is new

deprecated Prefer to use isSharingShortcutNew.

Parameters

Name	Type	Description
file	any	io.cozy.files document

Returns

boolean

Defined in

packages/cozy-client/src/models/file.js:227

---

isSharingShortcut

▸ isSharingShortcut(file): boolean

Returns whether the file is a shortcut to a sharing

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.files document

Returns

boolean

Defined in

packages/cozy-client/src/models/file.js:192

---

isSharingShortcutNew

▸ isSharingShortcutNew(file): boolean

Returns whether the sharing shortcut is new

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.files document

Returns

boolean

Defined in

packages/cozy-client/src/models/file.js:216

---

isShortcut

▸ isShortcut(file): boolean

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.files document

Returns

boolean

true if the file is a shortcut

Defined in

packages/cozy-client/src/models/file.js:109

---

move

▸ move(client, fileId, destination, force?): Promise<any>

Move file to destination.

Parameters

Name	Type	Default value	Description
client	CozyClient	undefined	The CozyClient instance
fileId	string	undefined	The file’s id (required)
destination	Object	undefined	The destination object containing:
destination.folderId	string	undefined	The destination folder’s id (required)
destination.path	string	undefined	The file’s path after the move (optional, used to optimize performance in case of conflict)
force	boolean	false	Whether we should overwrite, i.e. put to trash, the destination in case of conflict (defaults to false).

Returns

Promise<any>

• A promise that returns the move action response and the deleted file id (if any) if resolved or an Error if rejected

Defined in

packages/cozy-client/src/models/file.js:315

---

normalize

▸ normalize(file): any

Normalizes an object representing a io.cozy.files object

Ensures existence of _id and _type

Parameters

Name	Type	Description
file	any	object representing the file

Returns

any

full normalized object

Defined in

packages/cozy-client/src/models/file.js:122

---

overrideFileForPath

▸ overrideFileForPath(client, dirPath, file, metadata): Promise<IOCozyFile>

Method to upload a file even if a file with the same name already exists.

Parameters

Name	Type	Description
client	CozyClient	The CozyClient instance
dirPath	string	Fullpath of directory to upload to ex: path/to/
file	any	HTML Object file
metadata	any	An object containing the wanted metadata to attach

Returns

Promise<IOCozyFile>

The overrided file

Defined in

packages/cozy-client/src/models/file.js:370

---

readMobileFile

▸ readMobileFile(fileURL): Promise<any>

Read a file on a mobile

Parameters

Name	Type	Description
fileURL	string	The local file path (file://)

Returns

Promise<any>

Defined in

packages/cozy-client/src/models/file.js:507

---

saveFileQualification

▸ saveFileQualification(client, file, qualification): Promise<IOCozyFile>

Save the file with the given qualification

Parameters

Name	Type	Description
client	CozyClient	The CozyClient instance
file	IOCozyFile	The file to qualify
qualification	any	The file qualification

Returns

Promise<IOCozyFile>

The saved file

Defined in

packages/cozy-client/src/models/file.js:242

---

shouldBeOpenedByOnlyOffice

▸ shouldBeOpenedByOnlyOffice(file): boolean

Whether the file should be opened by only office We want to be consistent with the stack so we check the class attributes But we want to exclude .txt and .md because the CozyUI Viewer can already show them

Parameters

Name	Type	Description
file	IOCozyFile	io.cozy.file document

Returns

boolean

Defined in

packages/cozy-client/src/models/file.js:99

---

splitFilename

▸ splitFilename(file): Object

Returns base filename and extension

Parameters

Name	Type	Description
file	IOCozyFile	An io.cozy.files

Returns

Object

Name	Type
extension	string
filename	string

Defined in

packages/cozy-client/src/models/file.js:24

---

uploadFileWithConflictStrategy

▸ uploadFileWithConflictStrategy(client, file, options): any

The goal of this method is to upload a file based on a conflict strategy. Be careful: We need to check if the file exists by doing a statByPath query before trying to upload the file since if we post and the stack return a 409 conflict, we will get a SPDY_ERROR_PROTOCOL on Chrome. This is the only viable workaround If there is no conflict, then we upload the file. If there is a conflict, then we apply the conflict strategy : erase or rename:

• The erase strategy means an upload with a new version
• The rename strategy means a new upload with a new name

Parameters

Name	Type	Description
client	CozyClient	The CozyClient instance
file	string	ArrayBuffer
options	FileUploadOptions	The upload options

Returns

any

Defined in

packages/cozy-client/src/models/file.js:467