Главная

api.photo

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

Methods

api.photo.folder() → String
api.photo.isAllowed() → Boolean
api.photo.isAvailable() → Boolean
api.photo.processPhoto(filePath) → Boolean
api.photo.resize(srcPath, maxSize) → Boolean
api.photo.resizeAndCopy(srcPath, dstPath, maxSize, overwrite) → Boolean
api.photo.resolvedPathFullsize(fileName)PhotoInfo
api.photo.resolvedPathThumb(fileName)PhotoInfo
api.photo.takePicture() → String

Methods description

folder() → String

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

Return:
String

isAllowed() → Boolean

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

Return:
Boolean

isAvailable() → Boolean

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

Return:
Boolean

processPhoto(filePath) → Boolean

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

Parameters:
Name Type Description
filePath String

Путь до файла

Return:
Boolean -

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

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 -

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

resolvedPathFullsize(fileName)PhotoInfo

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

Parameters:
Name Type Description
fileName String

имя файла фото

Return:

resolvedPathThumb(fileName)PhotoInfo

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

Parameters:
Name Type Description
fileName String

имя файла фото

Return:

takePicture() → String

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

Return:
String -

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