Scriptable

https://docs.scriptable.app
Admin
Scriptable is an iOS app that allows users to automate tasks and extend system functionality on...
Tokens:71,731
Snippets:1,238
Trust Score:9
Update:3 months ago
Show doc for...
Tokens:
Raw
### static start(locale: string): Promise<string>

Source: https://docs.scriptable.app/dictation

Starts the dictation interface and returns a promise that resolves with the dictated text.

```APIDOC
## static start(locale: string)

### Description
Starts the dictation interface. The user must manually stop the dictation from the presented interface when finished.

### Parameters
- **locale** (string) - Optional - The language identifier for dictation (e.g., "en", "it", "da"). Defaults to the device locale.

### Return Value
- **Promise<string>** - A promise that resolves with the dictated text once the user finishes.
```

--------------------------------

### Importing and Using a Module

Source: https://docs.scriptable.app/importmodule

Example of importing a module named 'circle' and calling its exported functions.

```javascript
let circle = importModule('circle')
let r = 2
let area = circle.area(r)
log('Area of circle: ' + area)
```

--------------------------------

### static forOpeningScriptSettings()

Source: https://docs.scriptable.app/urlscheme

Gets the URL for opening the settings of the current script.

```APIDOC
## static forOpeningScriptSettings()

### Description
Gets the URL for opening the settings of the current script.

### Return Value
- **string** - URL for opening script settings.
```

--------------------------------

### Defining a Module

Source: https://docs.scriptable.app/importmodule

Example of a module file that exports functions using module.exports.

```javascript
module.exports.area = (r) => {
  return Math.PI * Math.pow(r, 2)
}

module.exports.circumference = (r) => {
  return 2 * Math.PI * r
}
```

--------------------------------

### static allParameters()

Source: https://docs.scriptable.app/urlscheme

Gets all parameters from the invocation of the URL scheme.

```APIDOC
## static allParameters()

### Description
Gets all the query parameters that were passed in the URL when running this script by invoking its URL scheme. Note: Deprecated in version 1.3.

### Return Value
- **{string: string}** - All query parameters.
```

--------------------------------

### static forOpeningScript()

Source: https://docs.scriptable.app/urlscheme

Gets the URL for opening the current script.

```APIDOC
## static forOpeningScript()

### Description
Gets the URL for opening the current script. When making a request to the returned URL from another app, the script will be opened.

### Return Value
- **string** - URL for opening script.
```

--------------------------------

### Define gradient start point

Source: https://docs.scriptable.app/lineargradient

Sets the normalized starting point of the gradient with X and Y components between 0 and 1.

```javascript
startPoint: Point
```

--------------------------------

### Event Start Date

Source: https://docs.scriptable.app/calendarevent

Access the start date of the calendar event.

```text
startDate: Date
```

--------------------------------

### static forRunningScript()

Source: https://docs.scriptable.app/urlscheme

Gets the URL for running the current script.

```APIDOC
## static forRunningScript()

### Description
Gets the URL for running the current script.

### Return Value
- **string** - URL for running script.
```

--------------------------------

### XMLParser Lifecycle Callbacks

Source: https://docs.scriptable.app/xmlparser

Callback function signatures for document start and end events.

```text
didStartDocument: fn()
```

```text
didEndDocument: fn()
```

--------------------------------

### new WebView()

Source: https://docs.scriptable.app/webview

Constructs a new instance of a WebView.

```APIDOC
## new WebView()

### Description
Constructs a new web view instance. Use this to evaluate JavaScript on websites.

### Signature
`new WebView()`
```

--------------------------------

### Get Callback URL String

Source: https://docs.scriptable.app/callbackurl

Generates the full URL string including the base URL and all added query parameters.

```javascript
getURL(): string
```

--------------------------------

### Example Response Object Structure

Source: https://docs.scriptable.app/request

The structure of the response object populated after a request completes.

```json
{
  "url": "https://example.com/",
  "statusCode": 200
  "mimeType": "application/json",
  "textEncodingName": "utf-8",
  "headers": {
    "Content-Type": "application/json;charset=utf-8",
    "Content-Length": "17671"
  },
  "cookies": [{
    "path": "/",
    "httpOnly": true,
    "domain": "www.example.com",
    "sessionOnly": true,
    "name": "JSESSIONID",
    "value": "7616271F4878CFD05182D20C45F4CEB3"
  }]
}
```

--------------------------------

### locale

Source: https://docs.scriptable.app/relativedatetimeformatter

Property to set or get the locale for the formatter.

```APIDOC
## locale

### Description
Locale to use when formatting. The locale should be specified using a string identifier, e.g. "en", "it" or "da". When no locale is set, the formatter will use the current locale of the device.

### Type
`string`
```

--------------------------------

### Construct and Send Mail

Source: https://docs.scriptable.app/mail

Initialize a new Mail instance and trigger the system send interface.

```javascript
new Mail()
```

```javascript
send(): Promise
```

--------------------------------

### static openInApp(url: string, fullscreen: bool)

Source: https://docs.scriptable.app/safari

Presents a website in-app without leaving the current application.

```APIDOC
## static openInApp(url: string, fullscreen: bool)

### Description
Presents a website in-app. This method displays the web content without leaving the current application.

### Parameters
- **url** (string) - Required - URL of website to present.
- **fullscreen** (bool) - Optional - Set to true to display the web view in fullscreen. Defaults to true.
```

--------------------------------

### static defaultForEvents()

Source: https://docs.scriptable.app/calendar

Gets the default calendar for events.

```APIDOC
## static defaultForEvents()

### Description
Returns the default calendar configured for events.
```

--------------------------------

### Get HTML Content

Source: https://docs.scriptable.app/webview

Retrieves the HTML source code from the currently loaded website.

```javascript
getHTML(): Promise<any>
```

--------------------------------

### Present an item using QuickLook

Source: https://docs.scriptable.app/quicklook

Displays a file, image, or text string. The promise resolves when the user dismisses the presentation.

```typescript
static present(item: any, fullscreen: bool): Promise
```

--------------------------------

### static defaultForReminders()

Source: https://docs.scriptable.app/calendar

Gets the default calendar for reminders.

```APIDOC
## static defaultForReminders()

### Description
Returns the default calendar configured for reminders.
```

--------------------------------

### static present(item: any, fullscreen: bool): Promise

Source: https://docs.scriptable.app/quicklook

Presents an item using the best suited presentation format. Returns a promise that resolves when the quick look is dismissed.

```APIDOC
## static present(item: any, fullscreen: bool): Promise

### Description
Chooses the best suited presentation of the item and performs the presentation if possible.

### Parameters
- **item** (any) - Required - Item to be present.
- **fullscreen** (bool) - Optional - Set to true to present the item in fullscreen. This only has an effect when used within the app. Defaults to false.

### Return value
- **Promise** - Promise that is fulfilled when the quick look is dismissed.
```

--------------------------------

### Get file creation date

Source: https://docs.scriptable.app/filemanager

Returns the creation date of a file at the specified path, or null if it cannot be read.

```typescript
creationDate(filePath: string): Date
```

--------------------------------

### presentMedium()

Source: https://docs.scriptable.app/listwidget

Presents a preview of the widget in its medium size.

```APIDOC
## presentMedium()

### Description
The widget is presented in its medium size. Returns a promise that is fulfilled when the preview is dismissed.
```

--------------------------------

### presentSmall()

Source: https://docs.scriptable.app/listwidget

Presents a preview of the widget in its small size.

```APIDOC
## presentSmall()

### Description
The widget is presented in its small size. Returns a promise that is fulfilled when the preview is dismissed.
```

--------------------------------

### Get bookmarked path

Source: https://docs.scriptable.app/filemanager

Retrieves the path for a specific file bookmark. Throws an error if the bookmark does not exist.

```javascript
bookmarkedPath(name: string): string
```

--------------------------------

### static fromLibrary(): Promise<Image>

Source: https://docs.scriptable.app/photos

Presents the photo library for picking an image.

```APIDOC
## static fromLibrary()

### Description
Presents the photo library for picking an image.

### Return Value
- **Promise<Image>** - Promise that provides the selected image when fulfilled.
```

--------------------------------

### Get nickname

Source: https://docs.scriptable.app/contact

Property representing the contact's nickname.

```text
nickname: string
```

--------------------------------

### Construct a new WebView

Source: https://docs.scriptable.app/webview

Initializes a new instance of the WebView class.

```javascript
new WebView()
```

--------------------------------

### Get Script Name

Source: https://docs.scriptable.app/script

Retrieves the name of the currently running script.

```javascript
static name(): string
```

--------------------------------

### Create a directory

Source: https://docs.scriptable.app/filemanager

Creates a directory at the specified path with an option to create intermediate directories.

```javascript
createDirectory(path: string, intermediateDirectories: bool)
```

--------------------------------

### Get URL for opening script settings

Source: https://docs.scriptable.app/urlscheme

Generates a URL that, when requested from another app, opens the settings for the current script.

```javascript
static forOpeningScriptSettings(): string
```

--------------------------------

### Create a local FileManager

Source: https://docs.scriptable.app/filemanager

Initializes a file manager for local disk operations.

```javascript
static local(): FileManager
```

--------------------------------

### Get name property

Source: https://docs.scriptable.app/contactscontainer

Access the display name of the contacts container.

```typescript
name: string
```

--------------------------------

### Get identifier property

Source: https://docs.scriptable.app/contactscontainer

Access the unique identifier of the contacts container.

```typescript
identifier: string
```

--------------------------------

### Draw text at a position

Source: https://docs.scriptable.app/drawcontext

Draws a text string starting at the specified point.

```javascript
drawText(text: string, pos: Point)
```

--------------------------------

### Construct System Colors

Source: https://docs.scriptable.app/color

Static methods to create predefined system colors.

```javascript
static black(): Color
```

```javascript
static darkGray(): Color
```

```javascript
static lightGray(): Color
```

```javascript
static white(): Color
```

```javascript
static gray(): Color
```

```javascript
static red(): Color
```

```javascript
static green(): Color
```

```javascript
static blue(): Color
```

```javascript
static cyan(): Color
```

```javascript
static yellow(): Color
```

```javascript
static magenta(): Color
```

```javascript
static orange(): Color
```

```javascript
static purple(): Color
```

```javascript
static brown(): Color
```

```javascript
static clear(): Color
```

--------------------------------

### Add a rectangle

Source: https://docs.scriptable.app/path

Adds a rectangle to the path, starting from the lower left corner.

```javascript
addRect(rect: Rect)
```

--------------------------------

### Construct New Alert

Source: https://docs.scriptable.app/alert

Initializes a new instance of the Alert class.

```text
new Alert()
```

--------------------------------

### Set HTTP Method

Source: https://docs.scriptable.app/request

Defines the HTTP method for the request, defaulting to GET.

```javascript
method: string
```

--------------------------------

### static presentCreate()

Source: https://docs.scriptable.app/calendarevent

Presents a UI for creating a new calendar event.

```APIDOC
## static presentCreate()

### Description
Presents a view for creating a new calendar event.

### Return Value
- **Promise<CalendarEvent>** - A promise that provides the created event when fulfilled.
```

--------------------------------

### static fromCamera(): Promise<Image>

Source: https://docs.scriptable.app/photos

Opens the camera for taking an image.

```APIDOC
## static fromCamera()

### Description
Opens the camera for taking an image.

### Return Value
- **Promise<Image>** - Promise that provides the captured image when fulfilled.
```

--------------------------------

### Get UUID string value

Source: https://docs.scriptable.app/uuid

Retrieves the string representation of a UUID instance.

```javascript
static string(): string
```

--------------------------------

### Get birthday

Source: https://docs.scriptable.app/contact

Property representing the contact's birthday as a Date object.

```text
birthday: Date
```

--------------------------------

### present(fullscreen)

Source: https://docs.scriptable.app/uitable

Presents the table to the user.

```APIDOC
## present(fullscreen)

### Description
Presents the table. Returns a promise that is fulfilled when the table is dismissed.

### Parameters
- **fullscreen** (bool) - Optional - Set to true to present the web view in fullscreen. Defaults to false.

### Return Value
- **Promise** - Promise that is fulfilled when the table is dismissed.
```

--------------------------------

### System Color Constructors

Source: https://docs.scriptable.app/color

Static methods to construct common system colors.

```APIDOC
## Static Color Constructors

### Methods
- `Color.black()`: Returns a black color.
- `Color.darkGray()`: Returns a dark gray color.
- `Color.lightGray()`: Returns a light gray color.
- `Color.white()`: Returns a white color.
- `Color.gray()`: Returns a gray color.
- `Color.red()`: Returns a red color.
- `Color.green()`: Returns a green color.
- `Color.blue()`: Returns a blue color.
- `Color.cyan()`: Returns a cyan color.
- `Color.yellow()`: Returns a yellow color.
- `Color.magenta()`: Returns a magenta color.
- `Color.orange()`: Returns a orange color.
- `Color.purple()`: Returns a purple color.
- `Color.brown()`: Returns a brown color.
- `Color.clear()`: Returns a transparent color.
```

--------------------------------

### Get family name

Source: https://docs.scriptable.app/contact

Property representing the contact's family name.

```text
familyName: string
```

--------------------------------

### present(fullscreen: bool)

Source: https://docs.scriptable.app/webview

Presents the web view to the user, optionally in fullscreen mode.

```APIDOC
## present(fullscreen: bool)

### Description
Presents the web view with the content that has been loaded into it.

### Parameters
- **fullscreen** (bool) - Set to true to present the web view in fullscreen. Defaults to false.

### Return Value
- **Promise** - A promise that is fulfilled when the presented web view is dismissed.
```

--------------------------------

### Get middle name

Source: https://docs.scriptable.app/contact

Property representing the contact's middle name.

```text
middleName: string
```

--------------------------------

### presentAccessoryInline()

Source: https://docs.scriptable.app/listwidget

Presents a preview of the widget in its accessory inline size, suitable for the Lock Screen. Available on iPhones running iOS 16 and newer.

```APIDOC
## presentAccessoryInline()

### Description
Presents a preview of the widget in its accessory inline size, suitable for display above the clock on the Lock Screen. Note that this is an estimated representation.

### Signature
`presentAccessoryInline(): Promise`

### Return Value
- **Promise** - Fulfilled when the preview is dismissed.
```

--------------------------------

### Get given name

Source: https://docs.scriptable.app/contact

Property representing the contact's given name.

```text
givenName: string
```

--------------------------------

### Get name prefix

Source: https://docs.scriptable.app/contact

Property representing the contact's name prefix.

```text
namePrefix: string
```

--------------------------------

### Present widget previews

Source: https://docs.scriptable.app/listwidget

Presents a preview of the widget in specific sizes. Returns a promise that resolves when the preview is dismissed.

```javascript
presentSmall(): Promise
```

```javascript
presentMedium(): Promise
```

```javascript
presentLarge(): Promise
```

--------------------------------

### Get default calendar

Source: https://docs.scriptable.app/calendar

Retrieves the default calendar for either reminders or events.

```javascript
static defaultForReminders(): Promise<Calendar>
```

```javascript
static defaultForEvents(): Promise<Calendar>
```

--------------------------------

### Get Bytes from Data

Source: https://docs.scriptable.app/data

Retrieves the raw byte array from the Data object.

```typescript
getBytes(): [number]
```

--------------------------------

### new UITable()

Source: https://docs.scriptable.app/uitable

Constructs a new instance of a UITable.

```APIDOC
## new UITable()

### Description
Constructs a table.

### Signature
`new UITable()`
```

--------------------------------

### Open a folder

Source: https://docs.scriptable.app/documentpicker

Presents a picker for selecting a folder from the Files app.

```javascript
static openFolder(): Promise<string>
```

--------------------------------

### static open(url: string)

Source: https://docs.scriptable.app/safari

Presents a website in the Safari app, leaving the current application.

```APIDOC
## static open(url: string)

### Description
Presents a website in the Safari app, thus leaving the current app.

### Parameters
- **url** (string) - Required - URL of website to present.
```

--------------------------------

### new Alert()

Source: https://docs.scriptable.app/alert

Constructs a new alert instance.

```APIDOC
## new Alert()

### Description
Constructs a new alert instance that can be configured with titles, messages, actions, and text fields.
```

--------------------------------

### Close subpath

Source: https://docs.scriptable.app/path

Draws a line from the current point back to the start of the current subpath.

```javascript
closeSubpath()
```

--------------------------------

### presentEdit()

Source: https://docs.scriptable.app/calendarevent

Presents a UI for editing the calendar event.

```APIDOC
## presentEdit()

### Description
Presents a view for editing the calendar event, including title, location, dates, recurrence, and alerts.

### Return Value
- **Promise<CalendarEvent>** - A promise that provides the updated event when fulfilled.
```

--------------------------------

### Get file size

Source: https://docs.scriptable.app/filemanager

Returns the size of the file in kilobytes, or null if the size cannot be read.

```typescript
fileSize(filePath: string): number
```

--------------------------------

### static loadFile(fileURL: string, preferredSize: Size, fullscreen: bool): Promise

Source: https://docs.scriptable.app/webview

Loads a file and renders it in a web view.

```APIDOC
## static loadFile(fileURL: string, preferredSize: Size, fullscreen: bool): Promise

### Description
Loads a file and renders it. Files can be of various types, including HTML files and images. The optional preferredSize parameter is ignored unless the script is run in a Siri Shortcut.

### Parameters
- **fileURL** (string) - Required - URL of the file to load and render.
- **preferredSize** (Size) - Optional - Preferred size of the view. This size is not guaranteed to be respected and is only used when the script is run with Siri or in the Shortcuts app.
- **fullscreen** (bool) - Optional - Set to true to present the web view in fullscreen. This only has an effect when used within the app. Defaults to false.

### Return value
- **Promise** - Promise that carries no value. Once the web view has been closed, the promise will complete.
```

--------------------------------

### Construct a new Path

Source: https://docs.scriptable.app/path

Initializes a new instance of the Path class.

```javascript
new Path()
```

--------------------------------

### static parameter(name: string)

Source: https://docs.scriptable.app/urlscheme

Gets a specific parameter from the invocation of the URL scheme.

```APIDOC
## static parameter(name: string)

### Description
Gets the value of a query parameter that was passed in the URL when running this script by invoking its URL scheme. Note: Deprecated in version 1.3.

### Parameters
- **name** (string) - Required - Name of the query parameter to get the value for.

### Return Value
- **string** - Value of query parameter.
```

--------------------------------

### Construct a Message

Source: https://docs.scriptable.app/message

Initializes a new message instance.

```javascript
new Message()
```

--------------------------------

### Retrieve Text Field Value

Source: https://docs.scriptable.app/alert

Gets the input value from a text field by its index.

```text
textFieldValue(index: number): string
```

--------------------------------

### Get widget family

Source: https://docs.scriptable.app/config

Returns the size category of the widget, or null if not running in a widget.

```text
widgetFamily: string
```

--------------------------------

### createDirectory(path: string, intermediateDirectories: bool)

Source: https://docs.scriptable.app/filemanager

Creates a new directory at the specified path, with an option to create intermediate directories.

```APIDOC
## createDirectory(path: string, intermediateDirectories: bool)

### Description
Creates a directory at the specified path. You can optionally create all intermediate directories.

### Parameters
- **path** (string) - Required - Path of directory to create.
- **intermediateDirectories** (bool) - Optional - Whether to create all intermediate directories. Defaults to false.
```

--------------------------------

### send()

Source: https://docs.scriptable.app/message

Presents the system UI to send the configured message.

```APIDOC
## send()

### Description
Presents a screen from which the message can be sent. The message will not be sent until confirmed from the presented screen.

### Signature
`send(): Promise`

### Return Value
- **Promise** - Fulfilled when the message has been sent.
```

--------------------------------

### XMLParser Configuration and Execution

Source: https://docs.scriptable.app/xmlparser

Properties and methods for initializing and running the XML parser.

```text
string: string
```

```text
new XMLParser(string: string)
```

```text
parse(): bool
```

--------------------------------

### Get file UTI

Source: https://docs.scriptable.app/filemanager

Retrieves the Uniform Type Identifier string for a specified file path.

```typescript
getUTI(filePath: string): string
```

--------------------------------

### static loadURL(url: string, preferredSize: Size, fullscreen: bool): Promise

Source: https://docs.scriptable.app/webview

Loads a URL in a web view and presents the web view.

```APIDOC
## static loadURL(url: string, preferredSize: Size, fullscreen: bool): Promise

### Description
Loads a URL into the web view and presents it. The optional preferredSize parameter is ignored unless the script is run in a Siri Shortcut.

### Parameters
- **url** (string) - Required - URL to load into the web view.
- **preferredSize** (Size) - Optional - Preferred size of the view. This size is not guaranteed to be respected and is only used when the script is run with Siri or in the Shortcuts app.
- **fullscreen** (bool) - Optional - Set to true to present the web view in fullscreen. This only has an effect when used within the app. Defaults to false.

### Return value
- **Promise** - Promise that carries no value. Once the web view has been closed, the promise will complete.
```

--------------------------------

### Schedule a Timer via Convenience Method

Source: https://docs.scriptable.app/timer

Creates and schedules a timer in a single operation.

```text
static schedule(timeInterval: number, repeats: bool, callback: fn()): Timer
```

--------------------------------

### new Path()

Source: https://docs.scriptable.app/path

Constructs a new instance of a Path.

```APIDOC
## new Path()

### Description
Constructs a new path object that can be used to define complex shapes.
```

--------------------------------

### open(): Promise<{string: string}>

Source: https://docs.scriptable.app/callbackurl

Opens the callback URL and waits for a response from the target application.

```APIDOC
## open()

### Description
Opens the target app and waits for the target app to perform the action. The promise resolves with the query parameters supplied by the target app, or rejects if the action fails, is cancelled, or times out.

### Return Value
- **Promise<{string: string}>** - A promise that provides the query parameters supplied by the target app.
```

--------------------------------

### Get current notification

Source: https://docs.scriptable.app/notification

Retrieves the notification context in which the script is running. Note: This is deprecated in version 1.3.

```javascript
static current(): Notification
```

--------------------------------

### Fetch completed reminders by date range

Source: https://docs.scriptable.app/reminder

Retrieves reminders that were completed within the specified start and end dates.

```typescript
static completedBetween(startDate: Date, endDate: Date, calendars: [Calendar]): Promise<[Reminder]>
```

--------------------------------

### Open a document with specific types

Source: https://docs.scriptable.app/documentpicker

Opens a picker for selecting files based on provided UTIs.

```javascript
static open(types: [string]): Promise<[string]>
```

--------------------------------

### Fetch reminders due between dates

Source: https://docs.scriptable.app/reminder

Retrieves reminders due within a specified start and end date interval.

```typescript
static allDueBetween(startDate: Date, endDate: Date, calendars: [Calendar]): Promise<[Reminder]>
```

--------------------------------

### Configure initialDate

Source: https://docs.scriptable.app/datepicker

Sets the default date and time shown when the picker opens.

```javascript
initialDate: Date
```

--------------------------------

### Construct a Timer

Source: https://docs.scriptable.app/timer

Initializes a new instance of the Timer class.

```text
new Timer()
```

--------------------------------

### Fetch events between two dates

Source: https://docs.scriptable.app/calendarevent

Retrieves events occurring within a defined start and end date range.

```javascript
static between(startDate: Date, endDate: Date, calendars: [Calendar]): Promise<[CalendarEvent]>
```

--------------------------------

### new ListWidget()

Source: https://docs.scriptable.app/listwidget

Constructs a new instance of a ListWidget to be displayed on the Home Screen.

```APIDOC
## new ListWidget()

### Description
Constructs a new list widget. Pass the widget to Script.setWidget() to display it on your Home Screen.
```

--------------------------------

### Get file modification date

Source: https://docs.scriptable.app/filemanager

Returns the last modification date of a file at the specified path, or null if it cannot be read.

```typescript
modificationDate(filePath: string): Date
```

--------------------------------

### Get file name

Source: https://docs.scriptable.app/filemanager

Extracts the name of a file or directory from a path, with an optional toggle for including the file extension.

```typescript
fileName(filePath: string, includeFileExtension: bool): string
```

--------------------------------

### load()

Source: https://docs.scriptable.app/request

Sends the configured request and returns a promise that resolves with the raw response data.

```APIDOC
## load()

### Description
Sends the configured request to the specified URL. The raw response is provided when the returned promise is fulfilled.

### Return Value
- **Promise<Data>** - A promise that provides the response as data when fulfilled.
```

--------------------------------

### pickTime()

Source: https://docs.scriptable.app/datepicker

Presents the date picker to select hours and minutes.

```APIDOC
## pickTime()

### Description
Presents the date picker displaying hours and minutes. Returns a promise that resolves with the selected time as a Date object.

### Signature
`pickTime(): Promise<Date>`
```

--------------------------------

### Get URL for running the current script

Source: https://docs.scriptable.app/urlscheme

Generates a URL that, when requested from another app, executes the current script.

```javascript
static forRunningScript(): string
```

--------------------------------

### Get URL for opening the current script

Source: https://docs.scriptable.app/urlscheme

Generates a URL that, when requested from another app, opens the current script.

```javascript
static forOpeningScript(): string
```

--------------------------------

### scriptable:///open/{scriptName}

Source: https://docs.scriptable.app/urlscheme

Opens an existing script by name.

```APIDOC
## GET scriptable:///open/{scriptName}

### Description
Opens an existing script. The scriptName must be URL encoded.

### Parameters
#### Path Parameters
- **scriptName** (string) - Required - The name of the script to open.

#### Query Parameters
- **openSettings** (boolean) - Optional - Set to true to automatically open the script settings.
```

--------------------------------

### Fetch incomplete reminders by date range

Source: https://docs.scriptable.app/reminder

Retrieves reminders that are incomplete and due within the specified start and end dates.

```typescript
static incompleteDueBetween(startDate: Date, endDate: Date, calendars: [Calendar]): Promise<[Reminder]>
```

--------------------------------

### Present Create View

Source: https://docs.scriptable.app/calendarevent

Opens the native UI for creating a new calendar event.

```javascript
static presentCreate(): Promise<CalendarEvent>
```

--------------------------------

### Get file extension

Source: https://docs.scriptable.app/filemanager

Extracts the extension from a given file path. Returns an empty string if the path points to a directory.

```javascript
fileExtension(filePath: string): string
```

--------------------------------

### Load HTML content

Source: https://docs.scriptable.app/webview

Renders provided HTML string with optional base URL, size, and fullscreen settings.

```javascript
static loadHTML(html: string, baseURL: string, preferredSize: Size, fullscreen: bool): Promise
```

--------------------------------

### Open any file

Source: https://docs.scriptable.app/documentpicker

Presents a picker allowing the selection of any file type.

```javascript
static openFile(): Promise<string>
```

--------------------------------

### presentLarge()

Source: https://docs.scriptable.app/listwidget

Presents a preview of the widget in its large size.

```APIDOC
## presentLarge()

### Description
The widget is presented in its large size. Returns a promise that is fulfilled when the preview is dismissed.
```

--------------------------------

### Get cache directory path

Source: https://docs.scriptable.app/filemanager

Retrieves the path to a cache directory. Data here persists longer than in the temporary directory but should not be used for long-term storage.

```javascript
cacheDirectory(): string
```

--------------------------------

### Device Information Methods

Source: https://docs.scriptable.app/device

Methods to retrieve static information about the device hardware and operating system.

```APIDOC
## static name()
Returns the name identifying the device.

## static systemName()
Returns the name of the operating system.

## static systemVersion()
Returns the version of the operating system.

## static model()
Returns the model of the device (e.g., "iPhone").
```

--------------------------------

### new Timer()

Source: https://docs.scriptable.app/timer

Constructs a new Timer instance.

```APIDOC
## new Timer()

### Description
Constructs a new timer instance.

### Signature
`new Timer()`
```

--------------------------------

### Get temporary directory path

Source: https://docs.scriptable.app/filemanager

Retrieves the path to a temporary directory. Data stored here is subject to deletion by the OS and is not suitable for long-term storage.

```javascript
temporaryDirectory(): string
```

--------------------------------

### ShareSheet.present

Source: https://docs.scriptable.app/sharesheet

Presents the system activity picker with a provided array of items to share.

```APIDOC
## static present(activityItems: [any])

### Description
Presents a share sheet with an array of items to share. The activities included in the presented sheet will vary based on the type of item.

### Parameters
- **activityItems** ([any]) - Required - Items to perform activity on.

### Return value
- **Promise<{string: any}>** - Promise carrying a value that tells which activity that was performed, if any. The promise is fulfilled when the sheet is dismissed.
```

--------------------------------

### Get all URL parameters

Source: https://docs.scriptable.app/urlscheme

Retrieves all query parameters passed during script invocation. This method is deprecated since version 1.3; use args.queryParameters instead.

```javascript
static allParameters(): {string: string}
```

--------------------------------

### Get a specific URL parameter

Source: https://docs.scriptable.app/urlscheme

Retrieves the value of a specific query parameter by name. This method is deprecated since version 1.3; use args.queryParameters instead.

```javascript
static parameter(name: string): string
```

--------------------------------

### loadString()

Source: https://docs.scriptable.app/request

Sends the configured request and parses the response as a string.

```APIDOC
## loadString()

### Description
Sends the configured request to the specified URL and parses the response as a string.

### Return Value
- **Promise<string>** - A promise that resolves with the response body as a string.
```

--------------------------------

### new Contact()

Source: https://docs.scriptable.app/contact

Constructs a new contact instance. Note that the contact must be queued for insertion using Contact.add() and persisted via Contact.persistChanges().

```APIDOC
## new Contact()

### Description
Constructs a contact. In order to add the contact to your address book, you must queue it for insertion using `Contact.add()`. When you're done making changes to the address book you should call `Contact.persistChanges()` to persist the changes.
```

--------------------------------

### useFullDateStyle

Source: https://docs.scriptable.app/dateformatter

Configures the date formatter to use a full style for the date, including all details.

```APIDOC
## useFullDateStyle()

### Description
Sets the date style to full. Example output: "Friday, August 23, 2019 AD".
```

--------------------------------

### Construct a new ListWidget

Source: https://docs.scriptable.app/listwidget

Initializes a new instance of a list widget.

```javascript
new ListWidget()
```

--------------------------------

### new Size(width, height)

Source: https://docs.scriptable.app/size

Constructs a new Size instance with the specified width and height.

```APIDOC
## new Size(width: number, height: number)

### Description
Creates a new instance of the Size structure with the provided dimensions.

### Parameters
- **width** (number) - Required - The width value.
- **height** (number) - Required - The height value.
```

--------------------------------

### Construct a new DatePicker

Source: https://docs.scriptable.app/datepicker

Initializes a new instance of the DatePicker.

```javascript
new DatePicker()
```

--------------------------------

### Open website in-app

Source: https://docs.scriptable.app/safari

Presents a website within the current application interface.

```typescript
static openInApp(url: string, fullscreen: bool): Promise
```

--------------------------------

### new DatePicker()

Source: https://docs.scriptable.app/datepicker

Constructs a new instance of the DatePicker class.

```APIDOC
## new DatePicker()

### Description
Constructs a new date picker instance.

### Signature
`new DatePicker()`
```

--------------------------------

### static speak(text: string)

Source: https://docs.scriptable.app/speech

Speaks the provided text string. If the script is triggered by a Siri Shortcut, Siri will perform the speech.

```APIDOC
## static speak(text: string)

### Description
Speaks a provided text string. If used in a script triggered by a Siri Shortcut, Siri will speak the text.

### Parameters
- **text** (string) - Required - The text to be spoken.
```

--------------------------------

### scriptable:///run/{scriptName}

Source: https://docs.scriptable.app/urlscheme

Runs an existing script by name.

```APIDOC
## GET scriptable:///run/{scriptName}

### Description
Runs an existing script. The scriptName must be URL encoded.

### Parameters
#### Path Parameters
- **scriptName** (string) - Required - The name of the script to run.

#### Query Parameters
- **openEditor** (boolean) - Optional - If true, the script will run with the editor shown.
```

--------------------------------

### Present UITable

Source: https://docs.scriptable.app/uitable

Displays the table. Returns a promise that resolves when the table is dismissed.

```javascript
present(fullscreen: bool): Promise
```

--------------------------------

### Construct CallbackURL

Source: https://docs.scriptable.app/callbackurl

Initializes a new CallbackURL instance with the specified base URL.

```javascript
new CallbackURL(baseURL: string)
```

--------------------------------

### parse()

Source: https://docs.scriptable.app/xmlparser

Initiates the parsing process for the configured XML string.

```APIDOC
## parse()

### Description
Starts parsing the XML string. Ensure all necessary callback functions are configured before calling this method.

### Return Value
- **bool** - Returns true if parsing was successfully started.
```

--------------------------------

### Font.lightSystemFont(size)

Source: https://docs.scriptable.app/font

Creates a light system font with the specified size.

```APIDOC
## Font.lightSystemFont(size)

### Description
Creates a light weight system font.

### Parameters
- **size** (number) - Required - The size of the text.

### Return Value
- **Font** - The created font.
```

--------------------------------

### pickDate()

Source: https://docs.scriptable.app/datepicker

Presents the date picker to select day, month, and year.

```APIDOC
## pickDate()

### Description
Presents the date picker displaying day, month, and year. Returns a promise that resolves with the selected date.

### Signature
`pickDate(): Promise<Date>`
```

--------------------------------

### DocumentPicker.open

Source: https://docs.scriptable.app/documentpicker

Presents a document picker for opening documents from the Files app based on specified UTIs.

```APIDOC
## static open(types: [string]): Promise<[string]>

### Description
Presents a document picker for opening a document from the Files app. It is up to the user to specify which types of files can be opened using UTIs.

### Parameters
- **types** ([string]) - Optional - Types of files to select. Specified using UTIs. Defaults to all files.

### Return value
- **Promise<[string]>** - Promise that provides paths for the selected documents when fulfilled.
```

--------------------------------

### new Notification()

Source: https://docs.scriptable.app/notification

Constructs a new notification instance.

```APIDOC
## new Notification()

### Description
Constructs a new notification instance.

### Method
Constructor

### Syntax
`new Notification()`
```

--------------------------------

### Retrieve file bookmarks

Source: https://docs.scriptable.app/filemanager

Fetches all file bookmarks configured in settings, returning an array of objects containing name and source.

```typescript
allFileBookmarks(): [{string: string}]
```

```json
{
  "name": "My Bookmark",
  "source": "host"
}
```

--------------------------------

### Construct a new notification

Source: https://docs.scriptable.app/notification

Initializes a new instance of the Notification class.

```javascript
new Notification()
```

--------------------------------

### Date Style Configuration Methods

Source: https://docs.scriptable.app/dateformatter

Methods to configure the date style for the formatter.

```APIDOC
## Date Style Configuration

### useNoDateStyle()
Removes the date from the formatted string.

### useShortDateStyle()
Sets the date style to short (typically numeric, e.g., "08/23/19").

### useMediumDateStyle()
Sets the date style to medium (typically includes abbreviations, e.g., "Aug 23, 2019").
```

--------------------------------

### new Point(x, y)

Source: https://docs.scriptable.app/point

Constructs a new Point instance with specified x and y coordinates.

```APIDOC
## new Point(x: number, y: number)

### Description
Constructs a new point object representing a coordinate in a two-dimensional system.

### Parameters
- **x** (number) - Required - X value.
- **y** (number) - Required - Y value.
```

--------------------------------

### new Font(name, size)

Source: https://docs.scriptable.app/font

Constructs a new font instance with a specified name and size.

```APIDOC
## new Font(name: string, size: number)

### Description
Constructs a new font instance. Refer to iosfonts.com for a list of available fonts.

### Parameters
- **name** (string) - Required - Name of the font.
- **size** (number) - Required - Size of the font.
```

--------------------------------

### FileManager.local()

Source: https://docs.scriptable.app/filemanager

Creates a file manager for operating with files stored locally.

```APIDOC
## static local()

### Description
Creates a local FileManager.

### Return value
- **FileManager** - Local FileManager.
```

--------------------------------

### Font.systemFont(size)

Source: https://docs.scriptable.app/font

Creates a system font with the specified size.

```APIDOC
## Font.systemFont(size)

### Description
Creates a standard system font.

### Parameters
- **size** (number) - Required - The size of the text.

### Return Value
- **Font** - The created system font.
```

--------------------------------

### Configure date styles

Source: https://docs.scriptable.app/dateformatter

Methods to set the visual style of the date output.

```javascript
useNoDateStyle()

```

```javascript
useShortDateStyle()

```

```javascript
useMediumDateStyle()

```

--------------------------------

### static schedule(timeInterval: number, repeats: bool, callback: fn())

Source: https://docs.scriptable.app/timer

Convenience method to create and schedule a timer instantly.

```APIDOC
## static schedule(timeInterval: number, repeats: bool, callback: fn())

### Description
A convenience function for creating and instantly scheduling a new timer.

### Parameters
- **timeInterval** (number) - Required - The time interval in milliseconds.
- **repeats** (bool) - Required - Whether the timer should repeat.
- **callback** (fn()) - Required - The function to be called when the timer fires.

### Return Value
- **Timer** - The constructed timer instance.
```

--------------------------------

### presentAccessoryRectangular()

Source: https://docs.scriptable.app/listwidget

Presents a preview of the widget in its rectangular accessory size, suitable for the Lock Screen.

```APIDOC
## presentAccessoryRectangular()

### Description
Presents a preview of the widget in its rectangular accessory size, which is suitable for display above the clock on the Lock Screen. Note that this is an estimated representation and may not be perfectly accurate due to Lock Screen wallpaper and tinting.

### Signature
`presentAccessoryRectangular(): Promise`

### Return Value
- **Promise** - A promise that is fulfilled when the preview is dismissed.
```

--------------------------------

### Present Sheet

Source: https://docs.scriptable.app/alert

Presents the alert as a sheet and returns a promise with the selected action index.

```text
presentSheet(): Promise<number>
```

--------------------------------

### Construct a New Request

Source: https://docs.scriptable.app/request

Initializes a new request instance for a specific URL.

```typescript
new Request(url: string)
```

--------------------------------

### new CallbackURL(baseURL: string)

Source: https://docs.scriptable.app/callbackurl

Constructs a new CallbackURL instance with the specified base URL.

```APIDOC
## new CallbackURL(baseURL: string)

### Description
Constructs an object that opens x-callback-url requests and waits for a response from the target app.

### Parameters
- **baseURL** (string) - Required - Base URL of the request, typically in the format my-app://x-callback-url/action.
```

--------------------------------

### new XMLParser(string)

Source: https://docs.scriptable.app/xmlparser

Constructs a new instance of the XMLParser with the provided XML string.

```APIDOC
## new XMLParser(string)

### Description
Constructs an event-driven XML parser. Callback functions must be set before starting the parse process.

### Parameters
- **string** (string) - Required - The XML string to be parsed.
```

--------------------------------

### static dynamic(lightColor, darkColor)

Source: https://docs.scriptable.app/color

Creates a dynamic color that switches between light and dark variants based on system appearance.

```APIDOC
## static dynamic(lightColor, darkColor)

### Description
Creates a dynamic color that will use either its light or dark variant depending on the appearance of the system. Note: Dynamic colors are not supported when used with DrawContext.

### Parameters
- **lightColor** (Color) - Required - Color used in light appearance.
- **darkColor** (Color) - Required - Color used in dark appearance.
```

--------------------------------

### Screen Information Methods

Source: https://docs.scriptable.app/device

Methods to retrieve information about the device screen resolution, scale, and brightness.

```APIDOC
## static screenSize()
Returns the size of the screen in points, accounting for device rotation.

## static screenResolution()
Returns the resolution of the screen in pixels.

## static screenScale()
Returns the scale factor of the screen.

## static screenBrightness()
Returns the current screen brightness as a number between 0 and 1.
```

--------------------------------

### module.filename

Source: https://docs.scriptable.app/module

The absolute path to the file containing the module.

```APIDOC
## module.filename

### Description
Returns the absolute path to the file containing the module. This property is read-only.

### Type
string
```

--------------------------------

### WidgetImage Content Mode Methods

Source: https://docs.scriptable.app/widgetimage

Methods to define how the image fills the available space.

```text
applyFittingContentMode()
```

```text
applyFillingContentMode()
```

--------------------------------

### Load response as string

Source: https://docs.scriptable.app/request

Sends the configured request and returns the response as a string.

```typescript
loadString(): Promise<string>
```

--------------------------------

### Present Alert

Source: https://docs.scriptable.app/alert

Presents the alert modally and returns a promise with the selected action index.

```text
presentAlert(): Promise<number>
```

--------------------------------

### allFileBookmarks()

Source: https://docs.scriptable.app/filemanager

Reads all file bookmarks created in settings.

```APIDOC
## allFileBookmarks()

### Description
Reads all file bookmarks created in settings. Returns an array of objects containing bookmark names and sources.

### Return value
- **Array** - An array of objects with the form: {"name": string, "source": string}. The source is either 'host' or 'siri_shortcuts'.
```

--------------------------------

### Construct a new UITable

Source: https://docs.scriptable.app/uitable

Initializes a new instance of the UITable class.

```javascript
new UITable()
```

--------------------------------

### Access file URL arguments

Source: https://docs.scriptable.app/args

Returns an array of file URL strings. Enable 'Run in App' if processing large files to avoid memory termination.

```text
fileURLs: [string]
```

--------------------------------

### static presentPicker(allowMultiple: bool)

Source: https://docs.scriptable.app/calendar

Presents a UI for the user to pick calendars.

```APIDOC
## static presentPicker(allowMultiple: bool)

### Description
Displays a calendar picker view to the user.

### Parameters
- **allowMultiple** (bool) - Optional - Whether to allow selecting multiple calendars.
```

--------------------------------

### applyDateStyle()

Source: https://docs.scriptable.app/widgetdate

Displays the entire date. This is the default style.

```APIDOC
## applyDateStyle()

### Description
Display entire date. Example output: June 3, 2019
```

--------------------------------

### Construct a new Contact

Source: https://docs.scriptable.app/contact

Creates a new contact instance. Use Contact.add() and Contact.persistChanges() to save to the address book.

```javascript
new Contact()
```

--------------------------------

### static add(contact: Contact, containerIdentifier: string)

Source: https://docs.scriptable.app/contact

Queues a contact to be added to the address book. Changes must be persisted using Contact.persistChanges().

```APIDOC
## static add(contact: Contact, containerIdentifier: string)

### Description
Queues a contact to be added to the address book. After queuing, you must invoke Contact.persistChanges() to apply the changes.

### Parameters
- **contact** (Contact) - Required - The contact to queue for addition.
- **containerIdentifier** (string) - Optional - The identifier of the container to add the contact to. If null, the default container is used.
```

--------------------------------

### pickDateAndTime()

Source: https://docs.scriptable.app/datepicker

Presents the date picker to select both date and time.

```APIDOC
## pickDateAndTime()

### Description
Presents the date picker displaying day, month, year, hour, and minutes. Returns a promise that resolves with the selected date and time.

### Signature
`pickDateAndTime(): Promise<Date>`
```

--------------------------------

### Construct a New Reminder

Source: https://docs.scriptable.app/reminder

Creates a new reminder instance. Call save() to persist it to a calendar.

```text
new Reminder()
```

--------------------------------

### SFSymbol Weight Configuration Methods

Source: https://docs.scriptable.app/sfsymbol

Methods to configure the weight of the SF symbol.

```APIDOC
## Weight Configuration Methods

### Methods
- **applyUltraLightWeight()**: Configures the symbol to use an ultra light weight.
- **applyThinWeight()**: Configures the symbol to use a thin weight.
- **applyLightWeight()**: Configures the symbol to use a light weight.
- **applyRegularWeight()**: Configures the symbol to use a regular weight.
- **applyMediumWeight()**: Configures the symbol to use a medium weight.
- **applySemiboldWeight()**: Configures the symbol to use a semibold weight.
- **applyBoldWeight()**: Configures the symbol to use a bold weight.
- **applyHeavyWeight()**: Configures the symbol to use a heavy weight.
- **applyBlackWeight()**: Configures the symbol to use a black weight.
```

--------------------------------

### static loadHTML()

Source: https://docs.scriptable.app/webview

Loads and renders HTML content.

```APIDOC
## static loadHTML(html, baseURL, preferredSize, fullscreen)

### Description
Loads HTML and renders it. Returns a promise that completes once the web view is closed.

### Parameters
- **html** (string) - Required - HTML to load and render.
- **baseURL** (string) - Optional - Base URL used to resolve relative URLs in the HTML.
- **preferredSize** (Size) - Optional - Preferred size of the view (used in Siri or Shortcuts).
- **fullscreen** (bool) - Optional - Set to true to present in fullscreen (in-app only). Defaults to false.

### Return Value
- **Promise** - A promise that carries no value and completes when the web view is closed.
```

--------------------------------

### Font.regularSystemFont(size)

Source: https://docs.scriptable.app/font

Creates a regular system font with the specified size.

```APIDOC
## Font.regularSystemFont(size)

### Description
Creates a regular weight system font.

### Parameters
- **size** (number) - Required - The size of the text.

### Return Value
- **Font** - The created font.
```

--------------------------------

### new Mail()

Source: https://docs.scriptable.app/mail

Constructs a new instance of the Mail class.

```APIDOC
## new Mail()

### Description
Constructs a new mail object.
```

--------------------------------

### loadImage()

Source: https://docs.scriptable.app/request

Sends the configured request and parses the response as an image.

```APIDOC
## loadImage()

### Description
Sends the configured request to the specified URL. The response is expected to be an image.

### Return Value
- **Promise<Image>** - A promise that resolves with the response as an Image object.
```

--------------------------------

### new Message()

Source: https://docs.scriptable.app/message

Constructs a new instance of a Message.

```APIDOC
## new Message()

### Description
Constructs a message to be sent either as a text message or an iMessage.

### Signature
`new Message()`
```

--------------------------------

### Present the activity picker

Source: https://docs.scriptable.app/sharesheet

Displays a share sheet for the provided items and returns a promise that resolves when the sheet is dismissed.

```javascript
static present(activityItems: [any]): Promise<{string: any}>
```

--------------------------------

### Export a file

Source: https://docs.scriptable.app/documentpicker

Exports an existing file at the specified path to a destination chosen by the user.

```javascript
static export(path: string): Promise<[string]>
```

--------------------------------

### Construct a new Point

Source: https://docs.scriptable.app/point

Initializes a new Point instance with specified x and y coordinates.

```javascript
new Point(x: number, y: number)
```

--------------------------------

### Date display style methods

Source: https://docs.scriptable.app/widgetdate

Methods to configure how the date component is formatted and displayed.

```javascript
applyTimeStyle()
```

```javascript
applyDateStyle()
```

```javascript
applyRelativeStyle()
```

```javascript
applyOffsetStyle()
```

```javascript
applyTimerStyle()
```

--------------------------------

### Create or find calendar for reminders

Source: https://docs.scriptable.app/calendar

Creates a new reminder list or finds an existing one by title.

```javascript
static createForReminders(title: string): Promise<Calendar>
```

```javascript
static findOrCreateForReminders(title: string): Promise<Calendar>
```

--------------------------------

### TextField keyboard configuration methods

Source: https://docs.scriptable.app/textfield

Methods to set specific keyboard layouts for the text field.

```text
setDefaultKeyboard()
```

```text
setNumberPadKeyboard()
```

```text
setDecimalPadKeyboard()
```

```text
setNumbersAndPunctuationKeyboard()
```

```text
setPhonePadKeyboard()
```

```text
setWebSearchKeyboard()
```

```text
setEmailAddressKeyboard()
```

```text
setURLKeyboard()
```

```text
setTwitterKeyboard()
```

--------------------------------

### Set Full Time Style

Source: https://docs.scriptable.app/dateformatter

Configures the time formatter to include all available time details.

```javascript
useFullTimeStyle()
```

--------------------------------

### listContents(directoryPath: string)

Source: https://docs.scriptable.app/filemanager

Lists the contents of a specified directory.

```APIDOC
## listContents(directoryPath: string)

### Description
Lists all the contents in the specified directory. The returned array contains filenames to all files and directories in the specified directory.

### Parameters
- **directoryPath** (string) - Required - Path to directory.

### Return value
- **[string]** - Names of all the files and directories in the specified directory.
```

--------------------------------

### Keychain.get(key: string)

Source: https://docs.scriptable.app/keychain

Retrieves a value from the keychain for a given key.

```APIDOC
## static get(key: string)

### Description
Reads the value for the specified key. If the key does not exist, the method will throw an error.

### Parameters
- **key** (string) - Required - Key to read value for.

### Return value
- **string** - Value assigned to the specified key.
```

--------------------------------

### presentSheet()

Source: https://docs.scriptable.app/alert

Presents the alert as a sheet.

```APIDOC
## presentSheet()

### Description
Presents the alert as a sheet.

### Return value
- **Promise<number>** - A promise that resolves with the index of the selected action.
```

--------------------------------

### scriptable:///add

Source: https://docs.scriptable.app/urlscheme

Adds a new script to the app.

```APIDOC
## GET scriptable:///add

### Description
Adds a new script to the Scriptable app.
```
Tokens:
Raw