Jelly

https://docs.jellycuts.com/
Admin
Jelly is a text-based programming language designed for creating Siri Shortcuts with a simpler, more...
Tokens:211,012
Snippets:4,094
Trust Score:7.4
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example Usage of Take Video Shortcut

Source: https://docs.jellycuts.com/Documentation/Shortcuts/takeVideo.html

Demonstrates how to call the takeVideo shortcut with specific parameters for camera, quality, and immediate start. This example shows a common configuration for capturing video.

```swift
takeVideo(camera: Back, quality: Medium, start: Imediately)
```

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

### Start Workout Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/startWorkout.html

An example of how to use the startWorkout shortcut. Note that the 'workout' parameter is left blank in this specific example, and 'value' is set to 'false' which might indicate an error or a specific use case.

```swift
startWorkout(workout: \, open: , value: "false", unit: 200)
```

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

### Get Bookmark Example

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/bookmarkFile.html

This example demonstrates how to retrieve a file using its bookmark. Ensure the 'User File' is correctly set in your workflow.

```applescript
bookmarkFile(mode: Get, file: , setName: "", getName: User File, deleteName: , overwriteDupes: , bookmarkName: "")
```

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

### Example Usage of Show Definition

Source: https://docs.jellycuts.com/Documentation/Shortcuts/showDefinition.html

An example demonstrating how to use the showDefinition shortcut to get the definition of the word 'Cat'.

```swift
showDefinition(text: "Cat")
```

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

### Get Article Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getArticle.html

An example of how to use the getArticle shortcut with a specific URL.

```swift
getArticle(url: "https://jellycuts.com")
```

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

### Get Workouts Example

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/getWorkouts.html

An example demonstrating how to call the getWorkouts function to retrieve up to 15 workouts, sorted by start date from oldest to newest, with specific unit and order preferences. Note that date parameters are left blank when useDateRange is false.

```swift
getWorkouts(workoutType: "All", useDateRange: false, afterDate: , beforeDate: , units: metric, tempUnits: Farenheit, sort: StartDate, dateOrder: OldestFirst, distanceOrder: FurthestFirst, energyOrder: MostEnergyFirst, durationOrder: LongestFirst, limit: 15)
```

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

### Get File Icon Example

Source: https://docs.jellycuts.com/Documentation/Actions/getFileIcon.html

An example demonstrating how to use the getFileIcon action with ShortcutInput.

```javascript
getFileIcon(files: [ShortcutInput])
```

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

### Example: Get Tracker Value

Source: https://docs.jellycuts.com/Documentation/Progress/getNumberTrackerValue.html

An example demonstrating how to get the value of a tracker. Ensure the tracker identifier and display string are correctly provided.

```swift
getNumberTrackerValue(tracker: Tracker(identifier: "abcde-f", displayString: "Hello World"))
```

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

### Get Podcast Episodes Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getPodcastEpisodes.html

An example of how to use the getPodcastEpisodes shortcut with a 'Podcast' input variable.

```swift
getPodcastEpisodes(input: Podcast)
```

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

### Example Usage of Get URLs From Input

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getURLSFromInput.html

Demonstrates how to use the getURLSFromInput shortcut with a sample text string containing a URL.

```shortcut
getURLSFromInput(text: "My favorite site is https://blacklivesmatter.com")
```

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

### File Shortcut Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/file.html

An example demonstrating how to use the file shortcut with 'ShortcutInput' as the file variable.

```shortcut
file(file: ShortcutInput)
```

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

### Get Playlist Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getPlaylist.html

An example of how to use the getPlaylist shortcut to retrieve the 'Recently Played' playlist.

```swift
getPlaylist(name: Recently Played)
```

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

### Play Sound Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/playSound.html

An example demonstrating how to use the playSound shortcut to play the sound from the clipboard.

```shortcut
playSound(file: Clipboard)
```

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

### Get Name Shortcut Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getName.html

An example demonstrating how to use the getName shortcut with ShortcutInput.

```swift
getName(input: ShortcutInput)
```

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

### Trim Video Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/trimVideo.html

An example of how to use the trimVideo shortcut with the Clipboard as the video input.

```swift
trimVideo(video: Clipboard)
```

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

### Example: Search Podcasts

Source: https://docs.jellycuts.com/Documentation/Shortcuts/searchPodcasts.html

An example demonstrating how to use the searchPodcasts shortcut to find a specific podcast. This example searches for 'ATP' podcasts in the US, returning one item.

```swift
searchPodcasts(query: "ATP", by: All, results: iPhone, country: United States, items: 1)
```

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

### Get Relative Date Example

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/getRelativeDate.html

Demonstrates how to use the getRelativeDate function with specific parameters for context, units style, and starting date.

```swift
getRelativeDate(date: CurrentDate, context: StartOfSentence, unitsStyle: Abbreviated, startingDate: AdjustedDate)
```

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

### Example Output Shortcut

Source: https://docs.jellycuts.com/Documentation/Shortcuts/output.html

Demonstrates how to use the output shortcut to display 'ShortcutInput' and use the 'Respond' behavior for output.

```shortcuts
output(notes: "ShortcutInput", folder: Respond)
```

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

### Markup Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/markup.html

Provides a practical example of using the markup shortcut with ShortcutInput.

```swift
markup(input: ShortcutInput)
```

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

### Example Usage of Get Email From Input

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getEmailFrom.html

Demonstrates how to use the getEmailFrom shortcut with a sample input string containing an email address.

```swift
getEmailFrom(input: "Contact support@jellycuts.com")
```

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

### Analyse Image Example

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/analyseImage.html

An example of how to use the analyseImage action with ShortcutInput and a MLModel.

```swift
analyseImage(image: ShortcutInput, coremlModel: MLModel)
```

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

### Get Music Detail Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/musicDetail.html

An example of how to use the musicDetail shortcut to get the title of a favorite song.

```shortcuts
musicDetail(detail: Title, music: Favorite Song)
```

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

### Run x-Callback URL Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/xCallbackURL.html

This example demonstrates how to run a shortcut using an x-callback URL, specifying custom success, cancel, and error URLs.

```Shortcuts
xCallbackURL(url: "shortcuts://x-callback-url/run-shortcut?name=Calculate%20Tip&input=text&text=24.99.", custom: true, success: "x-success", cancel: "x-cancel", error: "x-error", customXSuccess: false, xSuccess: "shortcuts://callback")
```

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

### Open Subreddit Example

Source: https://docs.jellycuts.com/Documentation/Apollo/openSubreddit.html

This example demonstrates how to open the 'ApolloApp' subreddit using the openSubreddit action.

```javascript
openSubreddit(subreddit: "ApolloApp")
```

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

### Get File Path Example

Source: https://docs.jellycuts.com/Documentation/Actions/getFilePath.html

An example demonstrating how to get the file path of the ShortcutInput using the 'path' type.

```javascript
getFilePath(file: ShortcutInput, type: path)
```

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

### Example Usage of Create Playlist Shortcut

Source: https://docs.jellycuts.com/Documentation/Shortcuts/createPlaylist.html

Provides an example of how to use the createPlaylist shortcut with variables for name, author, and description.

```swift
createPlaylist(name: "${Name}'s Playlist", music: New Music, author: "${Name}", description: "${Name}'s favorite songs from 2021")
```

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

### Example: Get Attendee Name

Source: https://docs.jellycuts.com/Documentation/Shortcuts/attendeeDetail.html

An example of how to use the attendeeDetail shortcut to get the 'Name' detail of the attendee provided as input.

```swift
attendeeDetail(detail: Name, attendee: ShortcutInput)
```

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

### Example: Get Podcast Episode Store ID

Source: https://docs.jellycuts.com/Documentation/Shortcuts/podcastEpisodeDetail.html

An example demonstrating how to get the 'Store ID' for the podcast episode 'ATP #96'.

```shortcut
podcastEpisodeDetail(detail: Store ID, episode: ATP #96)
```

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

### Quicklook Shortcut Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/quicklook.html

An example demonstrating how to use the Quicklook shortcut with 'ShortcutInput'. This is useful for previewing data passed between shortcuts.

```shortcut
quicklook(input: ShortcutInput)
```

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

### Download URL Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/downloadURL.html

An example demonstrating how to use the downloadURL shortcut with a POST method, JSON request type, and an empty JSON payload. Note the syntax for the requestJSON and requestVar parameters.

```shortcut
downloadURL(url: "https://jellycuts.com", method: POST, headers: {}, requestType: Json, requestJSON: {},
requestVar: : )
```

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

### Play Podcast Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/playPodcast.html

An example demonstrating how to use the playPodcast shortcut to subscribe to a specific podcast. Ensure the podcast variable is correctly defined.

```swift
playPodcast(podcast: Launched #2)
```

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

### Get Article Title Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/articleDetail.html

An example demonstrating how to get the title of an article using the articleDetail shortcut. Pass 'Title' as the detail and 'ShortcutInput' as the article.

```swift
articleDetail(detail: Title, article: ShortcutInput)
```

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

### Get Location Shortcut Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getLocation.html

An example of how to use the getLocation shortcut with ShortcutInput.

```swift
getLocation(input: ShortcutInput)
```

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

### URL Shortcut Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/url.html

Provides an example of how to use the URL shortcut to link to a specific website.

```jellycuts
url(url: "https://jellycut.com")
```

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

### Change Wallpaper Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/changeWallpaper.html

An example of how to call the changeWallpaper shortcut, passing ShortcutInput as the image.

```swift
changeWallpaper(image: ShortcutInput, location: , preview: )
```

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

### Example of Running Apple Script

Source: https://docs.jellycuts.com/Documentation/Shortcuts/runAppleScript.html

This example demonstrates how to use the runAppleScript action. Ensure your AppleScript code is correctly formatted within the 'script' parameter. The provided example logs a message.

```applescript
runAppleScript(input: ShortcutInput, script: "log \"")
```

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

### Convert Image Finder Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/convertImageFinder.html

An example of how to use the convertImageFinder action, passing ShortcutInput as the image.

```jellycuts
convertImageFinder(image: ShortcutInput)
```

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

### Example Usage of Get Match Group

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getMatchGroup.html

An example demonstrating how to get a specific group by index from regex matches. Ensure the 'matches' variable contains the result of a regex operation.

```shortcut
getMatchGroup(type: Group At Index, matches: ShortcutInput, index: "2")
```

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

### Get Item From List - Example Usage

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getItemFromList.html

This example demonstrates how to get the item at a specific index from a list. Ensure the 'list' variable is defined and the 'type' is set to 'Item at Index'.

```applescript
getItemFromList(list: options, type: Item at Index, index: "3", startIndex: "", endIndex: "")
```

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

### Build URL Example

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/buildURL.html

An example demonstrating how to use the buildURL function with common parameters like scheme, host, and path. This can be adapted for various URL construction needs.

```swift
buildURL(scheme: "https", host: "blog.actuallyzach.com", path: "", queryItems: , user: "", password: "", fragment: "", addPort: , port: )
```

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

### Quick Match Text Example

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/quickMatchText.html

An example demonstrating how to use quickMatchText to find text between two specific patterns. This example extracts content between parentheses, ignoring case and matching newlines.

```swift
quickMatchText(sourceText: "ShortcutInput", matchType: TextBetween, afterPattern: "(", beforePattern: ")", patternRangeStart: "", patternRangeEnd: "", caseSensitive: true, inclusiveMatch: true, matchNewLines: true, matchOutput: AllMatches)
```

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

### Add to Playlist Shortcut Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/addToPlaylist.html

Provides an example of how to use the addToPlaylist shortcut with specific inputs.

```swift
addToPlaylist(music: ShortcutInput, playlist: My Music Library)
```

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

### Speak Text Shortcut Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/speakText.html

An example demonstrating how to use the speakText shortcut to say 'Hello World!' with specific parameters.

```swift
speakText(text: "Hello World!", wait: false, rate: 1, pitch: 1, language: en-US)
```

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

### Get Type Shortcut Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getType.html

Provides an example of how to use the getType shortcut with ShortcutInput.

```shortcut
getType(input: ShortcutInput)
```

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

### Get Parent Directory Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getParentDirectory.html

Provides an example of how to use the getParentDirectory shortcut with ShortcutInput.

```applescript
getParentDirectory(file: ShortcutInput)
```

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

### Example: Create File Bookmark

Source: https://docs.jellycuts.com/Documentation/Scriptable/createFileBookmark.html

An example demonstrating how to create a file bookmark named 'Awesome File' using the content from the clipboard as the location.

```javascript
createFileBookmark(name: "Awesome File", location: Clipboard)
```

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

### Eject Disk Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/ejectDisk.html

An example of how to use the ejectDisk shortcut, specifying ShortcutInput as the disk to eject.

```swift
ejectDisk(disk: ShortcutInput)
```

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

### Example Usage of Create PDF Shortcut

Source: https://docs.jellycuts.com/Documentation/Shortcuts/createPDF.html

Demonstrates how to call the createPDF shortcut with common parameters. This example includes images and sets all pages to be included.

```swift
createPDF(input: images, margins: true, pages: All Pages, singlePageNumb: "", pageStart: "", pageEnd: "")
```

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

### Overlay Image Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/overlayImage.html

Demonstrates how to use the overlayImage shortcut with specific parameters. This example overlays a profile image onto a background.

```swift
overlayImage(image1: Profile Image, image2: Background, editor: false, height: "512", width: "512", position: Center, opacity: "1.0", rotation: "180")
```

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

### Import Audio Files Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/importAudioFiles.html

An example of how to call the importAudioFiles shortcut function with empty optional parameters.

```swift
importAudioFiles(files: , encode: , enoder: )
```

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

### Example Usage of videoFromGif

Source: https://docs.jellycuts.com/Documentation/Shortcuts/videoFromGif.html

Demonstrates how to use the videoFromGif shortcut to create a video from a GIF with a specified loop count.

```javascript
videoFromGif(gif: newGIF, loop: 1)
```

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

### Find Books Example

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/findBooks.html

An example of how to use the findBooks action to search for 'Harry Potter' books. This specific example filters for downloadable books, includes preorders, sorts by newest, and requests 5 results with thumbnails.

```swift
findBooks(query: "Harry Potter", onlyDownloadable: true, availability: all, type: all, includePreorders: true, orderBy: newest, languageCode: "en_us", resultCount: 5, renderThumbnails: true)
```

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

### Example of Sending Feedback

Source: https://docs.jellycuts.com/Documentation/Actions/sendFeedback.html

An example demonstrating how to use the sendFeedback action with a message and an email address.

```swift
sendFeedback(message: "Cool Actions!", email: "jellycuts@gmail.com")
```

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

### Get Uniform Type Identifier Example

Source: https://docs.jellycuts.com/Documentation/Actions/getUniformTypeIdentifier.html

This example demonstrates how to use the getUniformTypeIdentifier action with ShortcutInput to get the UTI of the current shortcut's input file. This action is available on iOS 15 and later.

```jellycuts
getUniformTypeIdentifier(file: ShortcutInput)
```

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

### Get Movie Details Example

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/getMovieDetails.html

An example demonstrating how to use getMovieDetails with a sample movie object and locale.

```swift
getMovieDetails(movie: Movie(identifier: "Movie1", displayString: "Star Wars", tmbd_id: "a32jsaf", title: "Star Wars", posterThumbURL: ", posterURL: "", voteAverage: 0.4, voteCount: 3, releaseData: January 1st 1999, popularity: 0.9, overview: "Space", genres: "Sci-Fi"), providersLocale: "en_us")
```

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

### Example of executeCommand Usage

Source: https://docs.jellycuts.com/Documentation/aShell/executeCommand.html

Provides a practical example of calling executeCommand to run the 'help' command, with default window behavior and keeping the process going.

```javascript
executeCommand(command: help, openWindow: default, keepGoing: true)
```

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

### Example Usage of pageDetail Shortcut

Source: https://docs.jellycuts.com/Documentation/Shortcuts/pageDetail.html

An example demonstrating how to use the pageDetail shortcut to get page contents.

```shortcut
pageDetail(detail: pageDetail, webpage: Page Contents)
```

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

### Create URL Example

Source: https://docs.jellycuts.com/Documentation/Actions/createURL.html

Use this action to build a URL by specifying its scheme, host, path, query items, fragment, user, password, and port. Ensure all components are correctly formatted.

```jellycuts
createURL(scheme: "https", host: "blog.actuallyzach.com", path: "/", queryItems: [], fragment: "", user: "", password: "", useCustomPort: true, port: 42)
```

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

### Get Last Video Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getLastVideo.html

Example of using the getLastVideo shortcut to retrieve the single most recent video.

```shortcut
getLastVideo(count: 1)
```

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

### Complete 'Hello World!' Script

Source: https://docs.jellycuts.com/Getting_Started/writing_first_script.html

The complete 'Hello World!' script, combining import, metadata, text creation, and alert display. This script can be exported to Shortcuts.

```jelly
import Shortcuts
#Color: red, #Icon: shortcuts

text(text: "Hello World!") >> introduction
alert(alert: "${introduction}")
```

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

### Take Photo Shortcut Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/takePhoto.html

An example demonstrating how to use the takePhoto shortcut to capture 5 photos from the back camera without a preview.

```workflow
takePhoto(camera: Back, preview: false, count: 5)
```

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

### Pick Colour Action Example

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/pickColour.html

Use this action to open the colour selection interface. Provide an optional reference image and a starting hex code. The chosen hex code is copied to the clipboard. Add 'Wait To Return' and 'Get Clipboard' actions afterwards to use the selected colour.

```ToolboxPro
pickColour(image: ShortcutInput, startingHex: ""FFFFFF"", postURL: ""shortcuts://""
)
```

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

### Get Last Bursts Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getLastBurst.html

An example demonstrating how to retrieve the last 1 burst using the getLastBurst shortcut.

```swift
getLastBurst(count: 1)
```

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

### Get File Link Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getFileLink.html

An example of using the getFileLink shortcut with ShortcutInput. This obtains the iCloud link for the input file.

```swift
getFileLink(file: ShortcutInput)
```

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

### Encode Media Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/encodeMedia.html

An example demonstrating how to use the encodeMedia shortcut with specific parameters. This includes setting the media input, resolution, speed, and metadata.

```applescript
encodeMedia(media: ShortcutInput, size: 1920x1080, speed: Normal, customSpeed: "0", title: "Awesome Video", artist: "Zachary", album: "Videos", genre: "Indie", year: 2021, artwork: Image)
```

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

### Quick Look Extended Example

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/quickLookExtended.html

An example demonstrating how to use the quickLookExtended function to display content. This includes setting a title, body, URL, and various visual properties.

```swift
quickLookExtended(title: "This shortcut's input", body: ShortcutInput, openURL: true, postURL: "shortcuts://", theme: Midnight, imageSize: fullWidth, imageAlignment: Central, imageShadows: true, textAlignment: central, buttonStyle: textOnly, buttonRadius: 15, imageMask: default, imageRadius: 100, mapPin: false, mapZoom: 0.0, mapInteractivity: false, mapSize: Short)
```

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

### Mount Disk Image Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/mountDiskImage.html

An example of how to use the mountDiskImage shortcut to mount a disk image. The 'Ask' parameter prompts the user to select a disk image.

```applescript
mountDiskImage(diskImage: Ask)
```

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

### Get Address From Input Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getAddressFrom.html

Example of using getAddressFrom with an email address as input. This function is available on iOS 14 and later.

```swift
getAddressFrom(input: Contact support@jellycuts.com)
```

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

### RoutineHub Offer Card Example

Source: https://docs.jellycuts.com/Documentation/RoutineHubAds/routineHubOffer.html

Provides a practical example of how to import the necessary libraries and call the `routineHubOffer` function with specific offer details.

```swift
import Shortcuts
import RoutineHubAds

routineHubOffer(url: "https://wildfire.co/aff/abc123", title: "Spring Sale", description: "50% off all widgets this week")
```

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

### Get Time Between Dates Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getTimeBetween.html

An example demonstrating how to use the getTimeBetween shortcut to calculate the time in minutes between the current date and an adjusted date.

```applescript
getTimeBetween(first: CurrentDate, second: AdjustedDate, interval: Minutes)
```

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

### Get Draft Example

Source: https://docs.jellycuts.com/Documentation/Drafts/getDraft.html

Example demonstrating how to call getDraft with a specific Draft object. Ensure the Draft object is correctly initialized with its properties.

```swift
getDraft(draft: Draft(identifier: "F5BD82B1BA4", displayString: "Default Draft", uuid: "F5BD82B1BA4", link: "drafts://open?uuid=F5BD82B1BA4", content: "Some really cool content", title: "Default Draft", tags: ["Default Draft"], folder: inbox, isFlagged: false, grammarType: GrammarType(displayString: "Markdown", identifier: "Markdown")))
```

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

### Quick Menu Legacy Example

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/quickMenuLegacy.html

An example demonstrating how to use the legacy Quick Menu tool to create a simple menu with a single text entry. For image display, a 'Choose From List' action with input type 'Contact' is required due to a workaround. This legacy tool will be removed in a future version.

```swift
quickMenuLegacy(text: "A really quick menu")
```

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

### CARROT Weather currentForecast Example

Source: https://docs.jellycuts.com/Documentation/CARROT/currentForecast.html

An example demonstrating how to call the `currentForecast` action with specific location and region details to get the current weather.

```swift
currentForecast(location: Placemark(addressDictionary: AddressDictionary(City: "", Country: "", CountryCode: "", FormattedAddressLines: ["", ""], Name: "", State: "", Street: ""), SubAdministrativeArea: "", SubThoroughfare: "", Thoroughfare: "", ZIP: ""), location: Location(altitude: 0, course: 1, horizontalAccuracy: 0.0, latitude: 0, longitude: 0, speed: 1, timestamp: 2022-02-22t22:22:22Z, verticalAccuracy: 1), region: Region(center: Center(latitude: 0.0, longitude: 0.0), identifier: "", radius: 100.0)), forecastType: current, dataType: , timeThreshold: )
```

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

### Show Note Shortcut Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/showNote.html

Provides an example of how to use the showNote shortcut with a specific note, 'Journal'.

```swift
showNote(note: Journal)
```

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

### Progress View Example

Source: https://docs.jellycuts.com/Documentation/WidgetPack/progressView.html

An example demonstrating how to instantiate a linear progress view with specified tints, value, total, and label.

```swift
progressView(kind: linear, circularTint: View(identifier: "View1", displayString: "View One"), linearTint: View(identifier: "View1", displayString: "View One"), value: 42, total: 100, label: View(identifier: "View1", displayString: "View One"))
```

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

### Get Emojis Action Example

Source: https://docs.jellycuts.com/Documentation/Actions/getEmojis.html

This example demonstrates how to use the getEmojis action to extract emojis from a string. Ensure you are using iOS 15 or later.

```jellycuts
getEmojis(text: "Hello World 👋")
```

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

### Example Usage of Preview Widget

Source: https://docs.jellycuts.com/Documentation/WidgetPack/previewWidget.html

Demonstrates how to use the previewWidget function with a specific view and size. Requires the view and size parameters.

```swift
previewWidget(view: View(identifier: "View1", displayString: "View One"), size: medium)
```

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

### Get User Details

Source: https://docs.jellycuts.com/Documentation/Actions/getUserDetails.html

Gets details about the current user. For example, username, name, language, idle time, etc. Requires iOS 15+.

```APIDOC
## Get User Details

### Description
Gets details about the current user. For example, username, name, language, idle time, etc.

### Syntax
```
getUserDetails(type: <#Enumeration (UserDetailsType)#>)
```

### Parameters
#### Path Parameters
- **type** (UserDetailsType) - Required - Specifies the type of user detail to retrieve (e.g., username, name, language).
```

```APIDOC
### Example
```
getUserDetails(type: username)
```
```

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

### Jellycuts Example Menu

Source: https://docs.jellycuts.com/Language_Guide/menus.html

An example demonstrating how to create a menu with two options: 'Log Water' and 'Workout'. Selecting an option executes the corresponding 'runShortcut' command.

```jellycuts
menu("Select an action", ["Log Water", "Workout"]) {
  case("Log Water"):
    runShortcut(Log Water)
  case("Workout"):
    runShortcut(Workout)
}
```

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

### Get Details Of Location (Extended) Example

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/getDetailsOfLocation.html

An example demonstrating how to use getDetailsOfLocation with a Placemark and Location object. Ensure all parameters are correctly populated for accurate results.

```swift
getDetailsOfLocation(location: Placemark(addressDictionary: AddressDictionary(City: "", Country: "", CountryCode: "", FormattedAddressLines: ["", ""], Name: "", State: "", Street: ""), SubAdministrativeArea: "", SubThoroughfare: "", Thoroughfare: "", ZIP: ""), location: Location(altitude: 0, course: 1, horizontalAccuracy: 0.0, latitude: 0, longitude: 0, speed: 1, timestamp: 2022-02-22t22:22:22Z, verticalAccuracy: 1), region: Region(center: Center(latitude: 0.0, longitude: 0.0), identifier: "", radius: 100.0))
```

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

### Make Archive Shortcut Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/makeArchive.html

This example demonstrates how to use the makeArchive shortcut to create a ZIP archive of the current shortcut input.

```Swift
makeArchive(input: ShortcutInput, type: .zip)
```

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

### Generate MD5 Hash Example

Source: https://docs.jellycuts.com/Documentation/GizmoPack/hashData.html

Example demonstrating how to generate an MD5 hash of the ShortcutInput. This requires GizmoPack Pro and specifies binary output encoding.

```javascript
hashData(input: ShortcutInput, algorithm: md5, hmacMd5Key: Q348WQAYDUNBQ3RRisd, hmacSha1Key: "", hmacSha224Key: "", hmacSha256Key: "", hmacSha384Key: "", hmacSha512Key: "", outputEncoding: binary)
```

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

### Get Detail From Text - Example Usage

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/getDetailFromText.html

This example demonstrates how to use the getDetailFromText function to extract the language from a given text, including the original text in the result.

```swift
getDetailFromText(text: "", detailType: language, includeOriginal: true)
```

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

### Get Symbol Name Example

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/getSymbolName.html

Use this tool to get a symbol name for use in other actions. Specify the category, symbol name type, and the name of the symbol.

```swift
getSymbolName(category: "Media", symbolNameType: All, name: "play")
```

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

### Open Draft Example

Source: https://docs.jellycuts.com/Documentation/Drafts/openDraft.html

An example demonstrating how to open a specific draft with all its properties defined. This includes draft details, visibility settings for lists, and specific workspace/action group loading.

```swift
openDraft(draft: Draft(identifier: "F5BD82B1BA4", displayString: "Default Draft", uuid: "F5BD82B1BA4", link: "drafts://open?uuid=F5BD82B1BA4", content: "Some really cool content", title: "Default Draft", tags: ["Default Draft"], folder: inbox, isFlagged: false, grammarType: GrammarType(displayString: "Markdown", identifier: "Markdown")), draftList: show, actionList: show, loadWorkspace: Workspace(identifier: "Default", displayString: "Default", name: "Default"), loadActionGroup: ActionGroup(identifier: "132123-213213", displayString: "Editing", name: "Editing"), loadActionBarGroup: ActionGroup(identifier: "qiue9313", displayString: "Tools", name: "Tools"))
```

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

### Example: Upload Photos from Clipboard

Source: https://docs.jellycuts.com/Documentation/Shortcuts/uploadPhotos.html

Demonstrates how to use the uploadPhotos shortcut with the Clipboard variable to upload photos.

```swift
uploadPhotos(photos: Clipboard)
```

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

### Get Uniform Type Identifier

Source: https://docs.jellycuts.com/Documentation/Actions/getUniformTypeIdentifier.html

Gets the Uniform Type Identifier (UTI) of the input file. For example, a JPEG file would return “public.jpeg”. Requires iOS 15+.

```APIDOC
## Get Uniform Type Identifier

### Description
Gets the Uniform Type Identifier (UTI) of the input file. For example, a JPEG file would return “public.jpeg”.

### Syntax
```
getUniformTypeIdentifier(file: <#Variable#>)
```

### Example
```
getUniformTypeIdentifier(file: ShortcutInput)
```
```

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

### Example: Spoken Audio from Text

Source: https://docs.jellycuts.com/Documentation/Shortcuts/spokenAudioFromText.html

An example demonstrating how to use the spokenAudioFromText shortcut with specific text, language, pitch, rate, and voice settings.

```swift
spokenAudioFromText(text: "Hello World!", language: en-US, pitch: 1.0, rate: 0.5, voice: Alex)
```

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

### Get Event UUID

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/getEventID.html

Retrieves the UUID of a calendar event based on its title, start date, and calendar name.

```APIDOC
## Get Event UUID

### Description
Get the UUID (unique identifier) of a event in your calendar.

### Syntax
```
getEventID(title: <#String (Allows Variables)#>, startDate: <#Date#>, calendar: <#String (Allows Variables)#>)

```

### Example
```
getEventID(title: "1.0 Release Date", startDate: , calendar: "c-Events")

```
```

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

### Adjust Date Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/adjustDate.html

Adds 10 minutes to the date '10:30 pm'. No duration is needed for get operations.

```Workflow
adjustDate(operation: Add, duration: 10 min, date: "10:30 pm")
```

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

### Split PDF Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/splitPDF.html

An example demonstrating how to use the splitPDF shortcut with the 'Ask' input to prompt the user for a document.

```swift
splitPDF(document: Ask)
```

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

### Get Event Detail

Source: https://docs.jellycuts.com/Documentation/Shortcuts/eventDetail.html

Retrieves a specific detail (like start date) from an event. Requires iOS 14 or later.

```applescript
eventDetail(detail: Start Date, event: Jellycuts Release Date)
```

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

### Decode URL Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/decodeURL.html

This example demonstrates how to use the decodeURL shortcut to convert a URL-encoded string like "Hello%20World" into "Hello World".

```swift
decodeURL(url: "Hello%20World")
```

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

### Example Usage of Get Last Photo

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getLastPhoto.html

Demonstrates how to use the getLastPhoto shortcut to retrieve 10 photos, excluding screenshots.

```shortcut
getLastPhoto(count: 10, screenshots: false)
```

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

### Example of Running a Shell Script

Source: https://docs.jellycuts.com/Documentation/Shortcuts/runShellScript.html

Demonstrates how to use the runShellScript shortcut to execute a simple echo command using the zsh shell.

```swift
runShellScript(input: ShortcutInput, script: "echo ", shell: /bin/zsh, inputMode: )
```

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

### Get Event UUID

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/getEventID.html

Retrieve the UUID of a calendar event by its title, start date, and calendar name. Requires iOS 14+.

```swift
getEventID(title: "1.0 Release Date", startDate: , calendar: "c-Events")
```

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

### Play Music Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/playMusic.html

An example of how to use the playMusic shortcut to play music from ShortcutInput with shuffle and repeat set to 'One'.

```shortcut
playMusic(music: ShortcutInput, shuffle: Songs, repeat: One)
```

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

### GizmoPack queryRecords Example

Source: https://docs.jellycuts.com/Documentation/GizmoPack/queryRecords.html

Provides a basic example of the queryRecords action, demonstrating its usage with default or empty values for most parameters, suitable for simple queries.

```applescript
queryRecords(fields: [""], input: ShortcutInput, outputType: automatic, hasWhere: false, whereClause: "", hasGroupBy: false, groupByClause: "", hasOrderBy: false, orderByClause: "", hasLimit: false, limitClause: "")
```

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

### Example Usage of noteDetail Shortcut

Source: https://docs.jellycuts.com/Documentation/Shortcuts/noteDetail.html

Demonstrates how to use the noteDetail shortcut to get the body of a specific note named 'School Note'.

```applescript
noteDetail(property: Body, note: School Note)
```

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

### Format Date Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/formatDate.html

Demonstrates how to use the formatDate shortcut with specified date and time styles, custom format, and ISO time option.

```javascript
formatDate(date: "10/20/30", dStyle: Short, tStyle: None, custom: "", isoTime: false)
```

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

### Get Relative Date Syntax

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/getRelativeDate.html

Defines the syntax for the getRelativeDate function, specifying parameters for date, context, units style, and a starting date.

```swift
getRelativeDate(date: <#Date#>, context: <#Enumeration (DateContext)#>, unitsStyle: <#Enumeration (DateUnitsStyle)#>, startingDate: <#Date#>)
```

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

### Example of Running a Ruby File

Source: https://docs.jellycuts.com/Documentation/Rubyist/runFile.html

Demonstrates how to use the `runFile` action to execute a Ruby file named 'inputFile' without any arguments and not within the app.

```ruby
runFile(file: inputFile, arguments: [], runInApp: false)
```

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

### RoutineHub Link Example

Source: https://docs.jellycuts.com/Documentation/RoutineHubAds/routineHubLink.html

Demonstrates how to import the RoutineHubAds module and use the `routineHubLink` function with a sample affiliate URL and call-to-action text.

```swift
import Shortcuts
import RoutineHubAds

routineHubLink(url: "https://wildfire.co/aff/abc123", text: "Visit our store")
```

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

### Get Photo Albums Example

Source: https://docs.jellycuts.com/Documentation/ToolboxPro/getPhotoAlbums.html

Demonstrates how to call the getPhotoAlbums function to retrieve up to 10 user-created albums, sorted by title in ascending order.

```swift
getPhotoAlbums(type: User, subType: All, sortBy: Title, sortOrder: Ascending, limit: true, limitCount: 10)
```

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

### Get File Of Type Example

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getFileOfType.html

Retrieves a file of the provided type from the given input. Use this when you need to filter files by their MIME type.

```applescript
getFileOfType(input: ShortcutInput, type: "public.rtf")
```

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

### Example Usage of Make Disk Image

Source: https://docs.jellycuts.com/Documentation/Shortcuts/makeDiskImage.html

An example demonstrating how to create a disk image named 'New Volume' with encryption enabled, not set to fit to size, and a specific size of 16 GB.

```swift
makeDiskImage(files: Ask, name: "New Volume", encrypt: true, sizetofit: false, size: 16 GB)
```

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

### Example: Ask for User's Age

Source: https://docs.jellycuts.com/Documentation/Shortcuts/askForInput.html

Demonstrates how to use the askForInput shortcut to get a numerical input from the user, specifying that decimals are allowed.

```swift
askForInput(prompt: "How old are you?", type: Number, default: 12, allowDecimal: true, allowNegative: false)
```

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

### Example: Get 5 Upcoming Reminders

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getUpcomingReminders.html

Demonstrates how to use the getUpcomingReminders shortcut to retrieve the 5 most upcoming reminders from the 'Reminders' list. This is useful for displaying a quick overview of tasks.

```shortcut
getUpcomingReminders(count: 5, list: Reminders)
```

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

### Example Usage of Select Photo Shortcut

Source: https://docs.jellycuts.com/Documentation/Shortcuts/selectPhoto.html

An example demonstrating how to call the selectPhoto shortcut without specifying types or multiple selection.

```swift
selectPhoto(types: , multiple: )
```

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

### Example Usage of Get Text From PDF Shortcut

Source: https://docs.jellycuts.com/Documentation/Shortcuts/getTextFromPDF.html

Demonstrates how to use the getTextFromPDF shortcut to extract text from a PDF, specifying 'Text' as the type and using 'ShortcutInput' as the PDF source.

```swift
getTextFromPDF(textType: Text, pdf: ShortcutInput)
```
Tokens:
Raw