VCOF0119

OmniFocus: Append Link to Note

This voice command presents a form interface for entering the title and URL for a link object to be appended to the note of the selected project or task.

NOTE: if a URL has been copied previously to the clipboard, it will be used as the default value in the form fields.

Scope and Syntax

Language: English (United States 🇺🇸 · Great Britain 🇬🇧 · Australia 🇦🇺 · Canada 🇨🇦) • Scope: OmniFocus

Command phrase variations (words in [brackets] are optional):

• “Append Link to Note”

Requirements

• Application: OmniFocus 4
• System: macOS 12, iPadOS 15, iOS 15, visionOS 1.0

Video: Append Link to Note

Command presents a form interface for entering the title and URL for a link object to be appended to the note of the selected project or task.

PLAY (E) PAUSE BACK REWIND

Downloads

• ⇩ COMMANDS-FILE OmniFocus 4.0 (macOS)
• ⇩ SHORTCUT-LINK (“Append Link to Note”) (iOS · iPadOS · visionOS)

The voice command code:

Append Link to Note
Copy

(async () => {
	try {
		function createUtterance(textToSpeak){
			langCode = Speech.Voice.currentLanguageCode
			voiceObj = Speech.Voice.withLanguage(langCode)
			utterance = new Speech.Utterance(textToSpeak)
			utterance.voice = voiceObj
			utterance.rate = Speech.Utterance.defaultSpeechRate
			return utterance
		}
		synthesizer = new Speech.Synthesizer()

		sel = document.windows[0].selection
		var items = sel.databaseObjects.filter(
			item => (item instanceof Project || item instanceof Task)
		)
		if(items.length !== 1){
			throw {
				name: "Selection Issue",
				message: "Please select a single project or task."
			}
		} else {
			// IF CLIPBOARD CONTAINS URL
			if(Pasteboard.general.hasURLs){
				var aURLstr = Pasteboard.general.stringForType(TypeIdentifier.URL)
				url = URL.fromString(aURLstr)
				var aTITLE = url.host
				var vocalPrompt = "Title and URL for clipboard link have been entered."
			} else {
				var aURLstr = null
				var aTITLE = null
				var vocalPrompt = "Enter the link title and URL"
			}
		
			// CREATE TEXT FIELD OBJECT
			linkTitleField = new Form.Field.String(
				"linkTitle",
				"Title",
				aTITLE,
				null
			)
			
			linkURLField = new Form.Field.String(
				"linkURL",
				"URL",
				aURLstr,
				null
			)

			// CREATE NEW FORM AND ADD FIELD
			inputForm = new Form()
			inputForm.addField(linkTitleField)
			inputForm.addField(linkURLField)

			// VALIDATE USER INPUT
			inputForm.validate = function(formObject){
				linkTitle = formObject.values["linkTitle"]
				if (!linkTitle){return false}
				linkURLStr = formObject.values["linkURL"]
				if (!linkURLStr){return false}
				url = URL.fromString(linkURLStr)
				try {url.scheme.length;return true}
				catch(err){return false}
			}

			// DISPLAY THE FORM
			formPrompt = "Link title and URL:"
			buttonTitle = "Continue"
		
			utterance = createUtterance(vocalPrompt)
			synthesizer.speakUtterance(utterance)
		
			formObject = await inputForm.show(formPrompt, buttonTitle)
		
			// RETRIVE FORM INPUT
			linkTitle = formObject.values["linkTitle"]
			linkURLStr = formObject.values["linkURL"]
			linkURL = URL.fromString(linkURLStr)
			
			// CREATE THE LINK OBJECT
			noteObj = items[0].noteText
			linkObj = new Text(linkTitle, noteObj.style)
			newLineObj = new Text("\n", noteObj.style)
			style = linkObj.styleForRange(linkObj.range)
			style.set(Style.Attribute.Link, linkURL)
			if (noteObj.string.length > 0){noteObj.append(newLineObj)}
			noteObj.append(linkObj)
			node = document.windows[0].content.selectedNodes[0]
			node.expandNote(false)

			// CONFIRMATION 
			utterance = createUtterance("Link Appended!")
			synthesizer.speakUtterance(utterance)
		}
	}
	catch(err){
		if(!err.causedByUserCancelling){
			utterance = createUtterance(err.message)
			synthesizer.speakUtterance(utterance)
			//new Alert(err.name, err.message).show()
		}
	}
})();