VCOF0113

OmniFocus: Add Item to Agenda

This plug-in creates a new Agenda note using the title, note, and due date of the selected project or task.

A link-back to the created Agenda item is prepended to the OmniFocus item’s note. And a link-back to the source OmniFocus item is prepended to the created Agenda item’s note. In addition, if the project or task has a due date, it is transfered to Agenda as well.

TIP: The note field for projects and tasks in OmniFocus 4 supports RTF (Rich Text Format) which is used by Agenda when the “Copy As… Note Text” option is selected. So… you can copy and paste your Agenda note into the OmniFocus note field and retain its look and formatting!

Scope and Syntax

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

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

• “Add Item to Agenda”

Requirements

(OmniFocus 4 TestFlight only)

• Applications: OmniFocus 4, Agenda (v15.0.1)
• System: macOS 12, iPadOS 15, iOS 15, visionOS 1.0

PLAY PAUSE BACK REWIND

Installing Voice Control commands on iOS · iPadOS · visionOS While Apple’s mobile operating systems currently do not support the Open URL action used in the voice commands files provided on this website, you can still create and use customized Omni Automation voice commands for iPhones and iPads! To create your voice commands, we’ll use specialized Shorcuts workflows that you can “tap-to-install” from the various example pages. Simply follow these steps or view the illustrated instructions here: First, install an Omni Automation shortcut from one of the provided links. (below) Next, in the mobile Settings app, tap Accessibility ▸ Voice Control ▸ Customize Commands ▸ Custom ▸ Create New Command… and in the forthcoming New Command interface select the installed shortcut as the value for the “Action” parameter. Enter one of the command phrases from the example’s documentation page (above) for the value of the “Phrase” property, and… Finally, set the value of the “Application” parameter to either “Any” for global access or choose the Omni app to target from the provided list of installed applications. You can then activate Voice Control and use your voice command to trigger the shortcut to run the Omni Automation script! Installing Siri commands on iOS · iPadOS · visionOS To use this voice command with Siri, simply install the provided Shortcuts workflow. To trigger the command, summon Siri and say: “Hey Siri, [Name of installed Shortcuts workflow]” NOTE: After installation of the shortcut, you can rename it to whatever phrase fits your needs.

Downloads

• ⇩ COMMANDS-FILE OmniFocus 4.0 (macOS)
• ⇩ SHORTCUT-LINK (“Add Item to Agenda”)

Script Code

Here is the script code for the command:

Add Item to Agenda
Copy

(async () => {
	try {
		function createUtterance(textToSpeak){
			AlexID = (
				(app.platformName === "macOS") ? 
				"com.apple.speech.synthesis.voice.Alex" : 
				"com.apple.speech.voice.Alex"
			)
			voiceObj = Speech.Voice.withIdentifier(AlexID)
			voiceRate = 0.4
			utterance = new Speech.Utterance(textToSpeak)
			utterance.voice = voiceObj
			utterance.rate = voiceRate
			return utterance
		}
		var synthesizer = new Speech.Synthesizer()

		sel = document.windows[0].selection
		items = sel.databaseObjects.filter(
			item => (item instanceof Project || item instanceof Task)
		)
		if(items.length === 1){
			var item = sel.databaseObjects[0]

			// create the callback-url using data from selected project or task
			encodedTitle = encodeURIComponent(item.name)
			encodedNote = encodeURIComponent(item.note)
			itemLink = `[OmniFocus](omnifocus:///task/${item.id.primaryKey})`
			encodedLink = encodeURIComponent(itemLink)
			urlStr = "agenda://x-callback-url/create-note"
			urlStr += `?title=${encodedTitle}`
			urlStr += `&text=${encodedLink}%0A`
			urlStr += `${encodedNote}`
			
			// add due date if used
			if(item.dueDate){
				fmtr = Formatter.Date.withFormat('yyyy-MM-dd')
				dateStr = fmtr.stringFromDate(item.dueDate)
				urlStr += `&date=${dateStr}`
			}
			
			// convert url string to URL object
			callingURL = URL.fromString(urlStr)
			
			// WRAP IN EXPLICIT PROMISE TO GIVE CALL TIME TO COMPLETE
			var result = new Promise((resolve, reject) => {
				// call the URL and use the response
				callingURL.call(function(noteID){
					console.log("noteID:", noteID)
					// use the returned note identifier to create link
					linkStr = `agenda://x-callback-url/open-note`
					linkStr += `?identifier=${noteID}`
					console.log(linkStr)
					linkURL = URL.fromString(linkStr)
		
					// prepend the link object to the item note
					noteObj = item.noteText
					linkURL = URL.fromString(linkStr)
					linkObj = new Text("(Agenda Link)", noteObj.style)
					newLineObj = new Text("\n", noteObj.style)
					style = linkObj.styleForRange(linkObj.range)
					style.set(Style.Attribute.Link, linkURL)
					noteObj.insert(noteObj.start, linkObj)
					noteObj.insert(linkObj.range.end, newLineObj)
	
					// reveal the note
					node = document.windows[0].content.selectedNodes[0]
					node.expandNote(false)
				
					// completion announcement
					utterance = createUtterance("Done!")
					synthesizer.speakUtterance(utterance)
				}, function(err){
					throw {
						name: "Script Error",
						message: err.errorMessage
					}
				})
			})
			await result
		} else {
			throw {
				name: "Selection Issue",
				message: "Please select a single project or task."
			}
		}
	}
	catch(err){
		utterance = createUtterance(err.message)
		synthesizer.speakUtterance(utterance)
		//new Alert(err.name, err.message).show()	
	}
})();