api.warpꓸfilesUpload

Methods

api.warpꓸfilesUpload.addFile(srcFilePath) → Result

api.warpꓸfilesUpload.filePath(fileName) → Result

api.warpꓸfilesUpload.filesToSend() → Result

api.warpꓸfilesUpload.isFileSent(fileName) → boolean

api.warpꓸfilesUpload.markFileToSend(fileNameOrPath) → Result

api.warpꓸfilesUpload.removeFile(fileNameOrPath) → Result

Methods description

addFile(srcFilePath) → Result

Добавить файл в справочник файлов для отправки. Чтобы файл отправился, следующим шагом необходимо пометить файл на отправку с помощью api.warp.filesUpload.markFileToSend.

Parameters:

Name	Type	Description
srcFilePath	string	Путь до файла

Return:

Result -

Результат. В поле value возвращается путь к файлу.

filePath(fileName) → Result

Вернуть путь до файла

Parameters:

Name	Type	Description
fileName	string	Имя файла

Return:

Result -

Результат. В поле value строка с путем до файла

filesToSend() → Result

Вернуть список файлов подготовленных для отправки

Return:

Result -

Результат. В поле value объект типа SendFilesList

isFileSent(fileName) → boolean

Вернуть признак отправки файла

Parameters:

Name	Type	Description
fileName	string	Имя файла

Return:

boolean

markFileToSend(fileNameOrPath) → Result

Пометить файл на отправку. Чтобы файл отправился, необходимо предварительно добавить его в справочник файлов с помощью api.warp.filesUpload.addFile.

Parameters:

Name	Type	Description
fileNameOrPath	string	Имя файла или путь

Return:

Result -

Результат выполнения операции

removeFile(fileNameOrPath) → Result

Удалить файл из списка для отправки

Parameters:

Name	Type	Description
fileNameOrPath	string	Имя файла или путь

Return:

Result -

Результат выполнения операции