file.downloadЗагружает файл по указанной интернет-ссылке и возвращает идентификатор загруженного файла.
Сигнатура: file.download(url: string) -> string
Аргументы: url — строка, содержащая URL-адрес файла, который необходимо загрузить.
Возвращаемое значение: Строка, представляющая идентификатор файла, загруженного в систему TWIN.
Примечания:
Убедитесь, что указанный URL корректен и доступен для загрузки. Если загрузка не удалась (например, из-за недоступности ресурса), функция может вернуть ошибку или пустой идентификатор.
Пример использования:
$fileId = file.download("http://some.file.url")
// $fileId будет содержать идентификатор загруженного файла
В приведенном примере файл скачивается с указанного URL, а его идентификатор сохраняется в переменной $fileId. Этот идентификатор может быть использован для дальнейшей обработки файла в системе.
file.infoФункция file.info используется для получения данных о файле, который был загружен ранее. Она возвращает подробную информацию о файле в виде ассоциативного массива (map), включая идентификатор, имя, тип содержимого и другие метаданные.
Сигнатура: file.info(fileId: string) -> Map
Назначение: Предоставление информации о загруженном в систему файле.
Аргументы: fileId — уникальный идентификатор файла, информация о котором требуется.
Возвращаемое значение: Ассоциативный массив (map) со следующей структурой:
{
"id": "ec8822eb-4055-4190-9c32-9f482aeadecf", // Уникальный идентификатор файла
"createdAt": "2024-12-16T09:07:15+00:00", // Время создания файла в ISO 8601
"contentType": "image/jpeg", // Тип содержимого файла
"name": "images.jpg", // Полное имя файла
"baseName": "images", // Имя файла без расширения
"extension": "jpg", // Оригинальное расширение файла
"suggestedExtension": "jpg", // Рекомендуемое расширение (определено на основе типа содержимого)
"size": 11638 // Размер файла в байтах
}
Пример использования:
Загрузка файла. Сначала файл загружается в систему, например, с указанного URL:
$fileId = file.download("https://example.com/somefile.jpg");
Получение информации о файле. После загрузки информация о файле может быть получена по его идентификатору:
$info = file.info($fileId);
Результат работы функции, который будет содержать метаданные загруженного файла:
{
"id": "ec8822eb-4055-4190-9c32-9f482aeadecf",
"createdAt": "2024-12-16T09:07:15+00:00",
"contentType": "image/jpeg",
"name": "images.jpg",
"baseName": "images",
"extension": "jpg",
"suggestedExtension": "jpg",
"size": 11638
}