![]() On Mac: iA Writer → Preferences → General → URL Commands → Manage.This Auth token is synced across all your devices using iCloud. Auth Learn more about why some commands require an Auth-token.įor privacy and security, commands that modify or return data using x-callback-url require the auth-token parameter. □ You can tap and hold items in Library to copy paths on iOS. → /Tester%27s%20Folder □ You can use the right-click menu in Library and Organizer to copy paths on macOS. Example: Path to Tester's Folder, found within the default iCloud folder. Locations/Name/ can be used to filter files from custom locations on macOS. Locations/From Other Apps/ is available on iOS. this leading slash refers to the default location (iCloud or local). This must be percent encoded to work in your URL. Limits: 4,000 characters max before encoding Path Points to the location of the file to be created, opened or edited. ![]() Example: Alice's Diary becomes Alice%27s%20Diary where the invalid characters (apostrophe and space) are replaced with %27 and %20. To work within a URL, these must be “URL or percent encoded”. String A string is any series of letters, numbers or symbols. App version.ĭata Types Learn more and see examples of the various data types your URL-scheme may call for. Return parameters on x-success scheme-version String. Returns iA Writer app version and URL scheme version. File contents after writing.ĮXAMPLE: ia-writer://write?auth-token=r4nd0m5tr1n9&path=/Locations/iCloud/Journal/entry123.txt&text=%2A%2ALOG+COMPLETE%2A%2A&mode=append&append-location=end&append-padding=trueĪppends the term " LOG COMPLETE" in a new paragraph at the end of document entry123.txt found in iCloud → Journal Path to the file that was created or modified. Return parameters on x-success path Path. beginning Append text at the beginning of a file. append Appends the given text to an existing file. Adjusts last path component to avoid replacing an existing file. Path to (file) entryXYZ.md found in iCloud → Journal (folder)Ĭreates or modifies an existing file and returns file contents.File text.ĮXAMPLE: ia-writer://read?auth-token=y0uRt0K3Nh3r3&path=/Locations/iCloud/Journal/entryXYZ.md Handy for: external apps interacting with iA Writer. Silently read and write data to/from iA Writer. Note: # symbol needs to be percent encoded → %23 Opens a Quick Search window for terms "#unfinishedtask" Return parameters on x-successĮXAMPLE: ia-writer://quick-search?query=%23unfinishedtask Return parameters on x-successĮXAMPLE: ia-writer://new?path=/Locations/iCloud/Journal/entry123.txtĬreates a new file titled entry123.txt in iCloud → Journal (folder) If true, keyboard will be shown on compatible iOS devices. The proposed filename will be used, but adjusted to avoid overwriting an existing file. If the path points to a file, it must have a plain text file extension, or the path will be ignored. If the path points to a directory, the file will be automatically named. ![]() If omitted the file will be created at the root of the default location. Opens EXAMPLES.txt (file) which is saved in iCloud → Website → URL-Schemes (folder) Return parameters on x-successĮXAMPLE: ia-writer://open?path=/Locations/iCloud/Website/URL-Schemes/EXAMPLES.txt Must point to a file and not a folder edit Boolean. Select Details tab to see more details and an example of each command. Some commands will return parameters on x-success.Ĭommands that allow you to interact with iA Writer. The structure for a url including x-callback: ia-writer://x-callback-url/command?x-parameter1=x-value1¶meter1=value1¶meter2=value2 ![]() This comes in handy when you want to send or receive information to/from another app. The general structure of a special URL will resemble: ia-writer://command?parameter1=value1¶meter2=value2Īll commands can support x-callback-url. The following workflow should work for novice and seasoned users alike:Ĭhoose Command → Add Parameters → Add Valuesīy selecting the appropriate command from the list below, you can quickly get a feel for what parameters and values will be necessary for your own URL. Starting from scratch you can put together a URL-scheme with 3 key building blocks. Registered URL scheme: iawriter:// Overview IA Writer for iOS: version 5.1+ *iOS 12+ for iOS Shortcuts On iOS, these URL schemes can be leveraged with the iOS Shortcuts app. URL schemes can also be used to change some of iA Writer’s defaults. For example, you can turn a text snippet into a new iA Writer document. URL schemes allow you to open iA Writer from other applications on both macOS and iOS, and perform specific actions on opening. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |