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#

The number of videos in the photo library.

typescript

getVideoCount(): number;

戻り値

型	説明
`number`	The video count, or 0 without photo access.

例

javascript

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

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();

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();

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');

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');

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');
}