Список версий МТ

Главная

api.photo

Работа с фотографиями

Methods

api.photo.defectStatus(fileNameOrPath) → Result
api.photo.falsifiedStatus(fileNameOrPath) → Result
api.photo.folder() → String
api.photo.isAllowed() → Boolean
api.photo.isAvailable() → Boolean
api.photo.photoPathDataByName(fileName) → PhotoInfo
api.photo.photoPathDataListByPacket(packetId) → Array.<PhotoInfo>
api.photo.photoPathDataListByPacketOrName(packetId, photoName) → Array.<PhotoInfo>
api.photo.processPhoto(filePath, context) → Boolean
api.photo.readExif(path) → Object
api.photo.resize(srcPath, maxSize) → Boolean
api.photo.resizeAndCopy(srcPath, dstPath, maxSize, overwrite) → Boolean
api.photo.resolvedPathThumb(fileName) → PhotoInfo
api.photo.takePhotos(maxCount, context) → Array.<String>
api.photo.takePhotosFromCamera(maxCount, isFromCameraMT, context) → Array.<String>
api.photo.takePhotosFromGallery(maxCount, context) → Array.<String>
api.photo.takePicture(context) → String

Methods description

defectStatus(fileNameOrPath) → Result

Получить качество фото из регистра файлов

Parameters:
Name Type Description
fileNameOrPath String

Путь или имя файла
Return:
Result -

Результат выполнения операции.
В поле value - статус качества фотографии (type DefectStatusEnum)
Throws:

Если фото не было зарегистрировано в регистре файлов, то вернется ошибка c кодом = 2020, и с текстом = “В регистре файлов не найдены необходимые файлы: имя файла”.

falsifiedStatus(fileNameOrPath) → Result

Получить статус фальсификации фотографии по следующим правилам:
• Если аттачмент (фото) отправлено, то результат берется из регистра файлов
• Если в сохранённых результатах статус "плохой", то результат берется из регистра файлов
• Проверять статус из “exif” файла. Если статус "плохой", то результат будет записан в регистре файлов

Parameters:
Name Type Description
fileNameOrPath String

Путь или имя файла
Return:
Result -

Результат выполнения операции.
В поле value - статус фальсификации фотографии (type FalsifiedStatusEnum)
Throws:

Если фото не было зарегистрировано в регистре файлов, то вернется ошибка c кодом = 2020, и с текстом = “В регистре файлов не найдены необходимые файлы: имя файла”.

folder() → String

Получить путь до папки с фотографиями

Return:
String

isAllowed() → Boolean

Получить признак разрешения использовать фотокамеру

Return:
Boolean

isAvailable() → Boolean

Получить признак возможности использовать фотокамеру

Return:
Boolean

photoPathDataByName(fileName) → PhotoInfo

Получить полный путь до фотографии по имени файла. Для незагруженных файлов начинается загрузка и возвращается путь до изображения-заглушки

Parameters:
Name Type Description
fileName String

Имя файла
Return:
PhotoInfo -

путь до фотографии

photoPathDataListByPacket(packetId) → Array.<PhotoInfo>

Получить полные пути до фотографий по идентификатору пакета. Для незагруженных файлов начинается загрузка и возвращается путь до изображения-заглушки

Parameters:
Name Type Description
packetId String

Идентификатор пакета
Return:
Array.<PhotoInfo> -

список путей до фотографий

photoPathDataListByPacketOrName(packetId, photoName) → Array.<PhotoInfo>

Получить пути до фотографий либо по идентификатору пакета, либо по имени файла. Если передан верный идентификатор пакета, используется он, иначе - имя файла. Для незагруженных файлов начинается загрузка и возвращается путь до изображения-заглушки. Если файл найти в регистре fileregister.db3 не удалось, пробует найти его в файловой системе: среди аттачментов (папка attachments) и фотографий (папка photos, задается из настроек).

Parameters:
Name Type Description
packetId ID

Идентификатор пакета
photoName String

Имя файла
Return:
Array.<PhotoInfo> -

список путей до фотографий
Throws:

Возвращает пустой массив в случае если файл заглушки не найден или нет информации о пути до заглушки, при этом в лог пишутся соответствующие сообщения.

processPhoto(filePath, context) → Boolean

Обработать фото с параметрами по умолчанию (EXIF информацией и размером)

Parameters:
Name Type Argument Description
filePath String

Путь до файла
context Object optional 

Объект с информацией о контексте создания фотографии (аналогично api.context)
Return:
Boolean -

Признак успешности

readExif(path) → Object

Получить EXIF-метаданные фотографии

Parameters:
Name Type Description
path String

Путь до файла
Return:
Object -

Объект, содержащий EXIF-метаданные
Example
// Пример возвращаемого объекта
{
  "Exif.Image.DateTime": "2017:01:16 09:24:21",
  "Exif.Image.ExifTag": "136",
  "Exif.Image.ImageDescription": "c63adbec-21b9-4987-b326-e7a0c297e1bb",
  "Exif.Image.Software": "MT V:4.1.6.6609",
  "Exif.Photo.DateTimeDigitized": "2017:01:16 09:24:21",
  "Exif.Photo.DateTimeOriginal": "2017:01:16 09:24:21",
  "Exif.Photo.ImageUniqueID": "578521030 ... 89b4e252c735"
}

resize(srcPath, maxSize) → Boolean

Изменить размер фотографии

Parameters:
Name Type Description
srcPath String

Путь до файла
maxSize Number

Максимальный размер любой стороны в px
Return:
Boolean -

Признак успешности

resizeAndCopy(srcPath, dstPath, maxSize, overwrite) → Boolean

Изменить размер и скопировать фотографию

Parameters:
Name Type Description
srcPath String

Путь до исходного файла
dstPath String

Путь до файла назначения
maxSize Number

Максимальный размер любой стороны в px
overwrite Boolean

Флаг, переписать файл если существует
Return:
Boolean -

Признак успешности

resolvedPathThumb(fileName) → PhotoInfo

Получить полный путь к уменьшенному превью фотографии по её имени. Если превью фото отсутствует на ФС, то будет начата загрузка его с фотохостинга. Размер превью определяется настройками МТ

Parameters:
Name Type Description
fileName String

имя файла фото
Return:
PhotoInfo -

путь до фотографии

takePhotos(maxCount, context) → Array.<String>

Получить фотографии. Источник фотографий выбирается согласно настройке МТ

Parameters:
Name Type Argument Default Description
maxCount Number optional  -1

Ограничение количества фотографий. Любые числа меньше 1 игнорируются.
context Object optional 

Объект с информацией о контексте создания фотографии (аналогично api.context)
Return:
Array.<String> -

Список путей до полученных фотографий

takePhotosFromCamera(maxCount, isFromCameraMT, context) → Array.<String>

Сделать фотографии

Parameters:
Name Type Argument Default Description
maxCount Number optional  -1

Ограничение количества фотографий. Любые числа меньше 1 игнорируются.
isFromCameraMT Boolean optional  true

Признак использования камеры МТ
context Object optional 

Объект с информацией о контексте создания фотографии (аналогично api.context)
Return:
Array.<String> -

Список путей до полученных фотографий

takePhotosFromGallery(maxCount, context) → Array.<String>

Получить фотографии из галереи

Parameters:
Name Type Argument Default Description
maxCount Number optional  -1

Ограничение количества фотографий. Любые числа меньше 1 игнорируются.
context Object optional 

Объект с информацией о контексте создания фотографии (аналогично api.context)
Return:
Array.<String> -

Список путей до полученных фотографий

takePicture(context) → String

Сделать фотографию

Parameters:
Name Type Argument Description
context Object optional 

Объект с информацией о контексте создания фотографии (аналогично api.context)
Return:
String -

Путь до полученной фотографии