Photos & files

Count and clear the photos and videos in the library, save images or videos into it, and download files into the app. The first call asks for photo library access.

Кратко о модуле

·Saving and deleting return true / false only after the system has finished
·Deleting taps through the system confirmation for you

getPicCount#

The number of images in the photo library (videos excluded).

typescript

getPicCount(): number;

Возвращаемое значение

Тип	Описание
`number`	The image count, or 0 without photo access (a log line says so).

Пример

javascript

logi('photos: ' + getPicCount());

См. также getVideoCount

getVideoCount#

The number of videos in the photo library.

typescript

getVideoCount(): number;

Возвращаемое значение

Тип	Описание
`number`	The video count, or 0 without photo access.

Пример

javascript

logi('videos: ' + getVideoCount());

См. также getPicCount

deleteAllPic#

Delete every image in the photo library.

typescript

deleteAllPic(): boolean;

Возвращаемое значение

Тип	Описание
`boolean`	Returns once deletion has finished: true on success (or when there was nothing to delete), false on failure (no photo access, the prompt was declined, …) with the reason in the error log.

Исключения

Исключение	Когда возникает
`WDAError`FEATURE_UNAVAILABLE	The app on the device is too old to have this feature; update the app.

Примечания

iOS always asks for confirmation before deleting from the photo library; the script taps Delete for you, switching to the Photos app and back in the process.
Deleted items go to Recently Deleted first and can be recovered for 30 days; iOS offers no public way to empty Recently Deleted.

Пример

javascript

if (!deleteAllPic()) {
  return false;
}

См. также deleteAllVideo、deleteAllPicAndVideo

deleteAllVideo#

Delete every video in the photo library. Works like deleteAllPic.

typescript

deleteAllVideo(): boolean;

Возвращаемое значение

Тип	Описание
`boolean`	Returns once deletion has finished: true on success (or when there was nothing to delete), false on failure (no photo access, the prompt was declined, …) with the reason in the error log.

Исключения

Исключение	Когда возникает
`WDAError`FEATURE_UNAVAILABLE	The app on the device is too old to have this feature; update the app.

Примечания

iOS always asks for confirmation before deleting from the photo library; the script taps Delete for you, switching to the Photos app and back in the process.
Deleted items go to Recently Deleted first and can be recovered for 30 days; iOS offers no public way to empty Recently Deleted.

Пример

javascript

deleteAllVideo();

См. также deleteAllPic

deleteAllPicAndVideo#

Delete every image and video in the photo library. Works like deleteAllPic.

typescript

deleteAllPicAndVideo(): boolean;

Возвращаемое значение

Тип	Описание
`boolean`	Returns once deletion has finished: true on success (or when there was nothing to delete), false on failure (no photo access, the prompt was declined, …) with the reason in the error log.

Исключения

Исключение	Когда возникает
`WDAError`FEATURE_UNAVAILABLE	The app on the device is too old to have this feature; update the app.

Примечания

iOS always asks for confirmation before deleting from the photo library; the script taps Delete for you, switching to the Photos app and back in the process.
Deleted items go to Recently Deleted first and can be recovered for 30 days; iOS offers no public way to empty Recently Deleted.

Пример

javascript

deleteAllPicAndVideo();

См. также deleteAllPic

savePicVideo#

Save an image or a video into the photo library; the file extension decides which.

typescript

savePicVideo(pathOrBase64: string, filename?: string): boolean;

Параметры

Параметр	Тип	Обязательный	По умолчанию	Описание
`pathOrBase64`	`string`	Да	—	A file path inside the app (relative to its Documents folder; files from downloadAndSaveFile live under sync/), or base64 data (a data: prefix is accepted).
`filename`	`string`	Нет	—	With base64 data, its extension decides image or video — for example cover.jpg or intro.mp4.

Возвращаемое значение

Тип	Описание
`boolean`	Returns once the system has actually written the item: true on success, false on failure with the reason in the error log.

Исключения

Исключение	Когда возникает
`WDAError`FEATURE_UNAVAILABLE	The app on the device is too old to have this feature; update the app.

Пример

javascript

savePicVideo('sync/intro.mp4');
savePicVideo(client.screenshot(), 'screen.png');

См. также downloadAndSaveFile、downloadAndSavePicVideo

downloadAndSavePicVideo#

Download an image or a video and save it into the photo library; the downloaded content decides which.

typescript

downloadAndSavePicVideo(url: string): boolean;

Параметры

Параметр	Тип	Обязательный	По умолчанию	Описание
`url`	`string`	Да	—	The download address. An address starting with / is resolved against the server (for example a File Sync file).

Возвращаемое значение

Тип	Описание
`boolean`	Returns once the system has actually written the item: true on success, false on failure with the reason in the error log.

Исключения

Исключение	Когда возникает
`WDAError`FEATURE_UNAVAILABLE	The app on the device is too old to have this feature; update the app.

Пример

javascript

downloadAndSavePicVideo('https://example.com/a.mp4');

См. также savePicVideo

downloadAndSaveFile#

Download any file into the app's sync/ folder (visible in the Files app under On My iPhone → WTScript → sync), named after the last segment of the address.

typescript

downloadAndSaveFile(url: string): boolean;

Параметры

Параметр	Тип	Обязательный	По умолчанию	Описание
`url`	`string`	Да	—	The full download address (starting with http:// or https://).

Возвращаемое значение

Тип	Описание
`boolean`	True when the file was downloaded and saved. Waits 120 seconds at most.

Пример

javascript

if (downloadAndSaveFile('https://example.com/intro.mp4')) {
  savePicVideo('sync/intro.mp4');
}

См. также savePicVideo