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.
At a glance
- ·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;Returns
| Type | Description |
|---|---|
number | The image count, or 0 without photo access (a log line says so). |
Example
javascript
logi('photos: ' + getPicCount());See also getVideoCount
getVideoCount#
The number of videos in the photo library.
typescript
getVideoCount(): number;Returns
| Type | Description |
|---|---|
number | The video count, or 0 without photo access. |
Example
javascript
logi('videos: ' + getVideoCount());See also getPicCount
deleteAllPic#
Delete every image in the photo library.
typescript
deleteAllPic(): boolean;Returns
| Type | Description |
|---|---|
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. |
Throws
| Error | Raised when |
|---|---|
WDAErrorFEATURE_UNAVAILABLE | The app on the device is too old to have this feature; update the app. |
Notes
- 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.
Example
javascript
if (!deleteAllPic()) {
return false;
}See also deleteAllVideo、deleteAllPicAndVideo
deleteAllVideo#
Delete every video in the photo library. Works like deleteAllPic.
typescript
deleteAllVideo(): boolean;Returns
| Type | Description |
|---|---|
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. |
Throws
| Error | Raised when |
|---|---|
WDAErrorFEATURE_UNAVAILABLE | The app on the device is too old to have this feature; update the app. |
Notes
- 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.
Example
javascript
deleteAllVideo();See also deleteAllPic
deleteAllPicAndVideo#
Delete every image and video in the photo library. Works like deleteAllPic.
typescript
deleteAllPicAndVideo(): boolean;Returns
| Type | Description |
|---|---|
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. |
Throws
| Error | Raised when |
|---|---|
WDAErrorFEATURE_UNAVAILABLE | The app on the device is too old to have this feature; update the app. |
Notes
- 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.
Example
javascript
deleteAllPicAndVideo();See also deleteAllPic
savePicVideo#
Save an image or a video into the photo library; the file extension decides which.
typescript
savePicVideo(pathOrBase64: string, filename?: string): boolean;Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
pathOrBase64 | string | Yes | — | 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 | No | — | With base64 data, its extension decides image or video — for example cover.jpg or intro.mp4. |
Returns
| Type | Description |
|---|---|
boolean | Returns once the system has actually written the item: true on success, false on failure with the reason in the error log. |
Throws
| Error | Raised when |
|---|---|
WDAErrorFEATURE_UNAVAILABLE | The app on the device is too old to have this feature; update the app. |
Example
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;Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
url | string | Yes | — | The download address. An address starting with / is resolved against the server (for example a File Sync file). |
Returns
| Type | Description |
|---|---|
boolean | Returns once the system has actually written the item: true on success, false on failure with the reason in the error log. |
Throws
| Error | Raised when |
|---|---|
WDAErrorFEATURE_UNAVAILABLE | The app on the device is too old to have this feature; update the app. |
Example
javascript
downloadAndSavePicVideo('https://example.com/a.mp4');See also 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;Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
url | string | Yes | — | The full download address (starting with http:// or https://). |
Returns
| Type | Description |
|---|---|
boolean | True when the file was downloaded and saved. Waits 120 seconds at most. |
Example
javascript
if (downloadAndSaveFile('https://example.com/intro.mp4')) {
savePicVideo('sync/intro.mp4');
}See also savePicVideo