VCOF0107

OmniFocus: About This Task

This command will vocalize information regarding the selected task.

Scope and Syntax

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

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

• “About This Task”

Requirements

• Application: OmniFocus 4
• System: macOS 12, iOS 15, iPadOS 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 (“About This Task”) (iOS · iPadOS · visionOS)

Script Code

Here is the script code:

About This Task
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.tasks
		if(sel.length !== 1){
			throw {
				name: "Selection Error",
				message: "Please select a single task."
			}
		} else {
			var isTagged = false
			var isFlagged = false
			var hasDueDate = false
			var hasDeferDate = false
			var everyOtherOne = true
			var tagOrTags
			
			var signOff = "That is all!"
			
			var fmtr = Formatter.Date.withFormat('h:mma, EEEE, LLLL d, yyyy')
			//--> "12:07AM, Wednesday, March 2, 2023"
			
			var utteranceStrings = new Array()

		
			objRef = sel[0]
			var objectType = objRef.constructor.name
			var taskTitle = objRef.name
			if(taskTitle === ""){
				string = `The selected ${objectType} is not named.`
			} else {
				string = `The selected ${objectType} is named “${taskTitle}”`
			}
			utteranceStrings.push(string)
			
			var referenceOption1 = `The ${objectType}`
			var referenceOption2 = `And it`
			console.log("objectType", objectType)
			
			var status
			switch(objRef.taskStatus) {
			  case Task.Status.Available:
				status = "available"
				break;
			  case Task.Status.Blocked:
				status = "blocked"
				break;
			  case Task.Status.Completed:
				status = "completed"
				break;
			  case Task.Status.Dropped:
				status = "dropped"
				break;
			  case Task.Status.DueSoon:
				status = "due soon"
				break;
			  case Task.Status.Next:
				status = "next"
				break;
			  case Task.Status.Overdue:
				status = "overdue"
				break;
			}			
			string = `and its status is “${status}.”`
			utteranceStrings.push(string)
			
			if(objRef.containingProject){
				console.log("TASK IS IN PROJECT")
				projectName = objRef.containingProject.name
				itemReference = (everyOtherOne) ? referenceOption1:referenceOption2
				everyOtherOne = !everyOtherOne
				string = `${itemReference} is contained in the ${projectName} project.`
				utteranceStrings.push(string)
			}
			
			if(objRef.children.length > 0){
				console.log("TASK IS A TASK GROUP")
				childCount = objRef.children.length
				countPhrase = (childCount === 1)?"one task":String(childCount) + " tasks"
				itemReference = (everyOtherOne) ? referenceOption1:referenceOption2
				everyOtherOne = !everyOtherOne
				if(objRef.completedByChildren){
					string = `${itemReference} is a task group, containing ${countPhrase}, and is completed when its last task is finished.`
				} else {
					string = `${itemReference} is a task group, containing ${countPhrase}.`
				}
				utteranceStrings.push(string)
			}
			
			if(objRef.flagged){
				console.log("TASK IS FLAGGED")
				isFlagged = true
				itemReference = (everyOtherOne) ? referenceOption1:referenceOption2
				everyOtherOne = !everyOtherOne
				string = `${itemReference} has been flagged.`
				utteranceStrings.push(string)
			}
			
			if(objRef.tags.length > 0){
				console.log("TASK HAS ASSIGNED TAGS")
				isTagged = true
				tagCount = objRef.tags.length
				tagTitles = objRef.tags.map(tag => tag.name)
				if (tagCount > 1){
					lastTag = tagTitles.pop()
					var tagTitleString = tagTitles.join(", ") + `, and ${lastTag}`
					var tagOrTags = "tags"
				} else {
					var tagTitleString = tagTitles[0]
					var tagOrTags = "tag"
				}
				itemReference = (everyOtherOne) ? referenceOption1:referenceOption2
				everyOtherOne = !everyOtherOne
				string = `${itemReference} is assigned ${tagCount} ${tagOrTags}: ${tagTitleString}`
				utteranceStrings.push(string)
			}
			
			if(objRef.dueDate !== null){
				console.log("TASK HAS DUE DATE")
				hasDueDate = true
				var dueDateString = fmtr.stringFromDate(objRef.dueDate)
			}
			
			if(objRef.deferDate !== null){
				console.log("TASK HAS DEFER DATE")
				hasDeferDate = true
				var deferDateString = fmtr.stringFromDate(objRef.deferDate)
			}
			
			itemReference = (everyOtherOne) ? referenceOption1:referenceOption2
			everyOtherOne = !everyOtherOne
			if (hasDueDate && !hasDeferDate){
				string = `${itemReference} is due on ${dueDateString}`
				utteranceStrings.push(string)		
			} else if (hasDueDate && hasDeferDate){
				string = `${itemReference} is due on ${dueDateString}, but has been deferred until ${deferDateString}`
				utteranceStrings.push(string)		
			} else if (!hasDueDate && hasDeferDate){
				string = `${itemReference} is deferred until ${deferDateString}`
				utteranceStrings.push(string)		
			}
			
			if(objRef.estimatedMinutes){
				console.log("TASK HAS ESTIMATED DURATION")
				fmtr = new Formatter.Duration()
				fmtr.hoursPerDay = 24
				fmtr.hoursPerWeek = 168
				fmtr.useVerboseFormat = true 
				dVal = Decimal.fromString(String(objRef.estimatedMinutes / 60))
				durationString = fmtr.stringFromDecimal(dVal)
				itemReference = (everyOtherOne) ? referenceOption1:referenceOption2
				everyOtherOne = !everyOtherOne
				string = `${itemReference} has an estimated duration of ${durationString}`
				utteranceStrings.push(string)		
			}
			
			if(objRef.repetitionRule){
				console.log("TASK IS SET TO REPEAT")
				ruleString = objRef.repetitionRule.ruleString
				repetitionIncrement = ruleString.split(";")[0].split("=")[1]
				itemReference = (everyOtherOne) ? referenceOption1:referenceOption2
				everyOtherOne = !everyOtherOne
				string = `${itemReference} is set to repeat ${repetitionIncrement}`
				utteranceStrings.push(string)		
			}
			
			utterances = new Array()
			utteranceStrings.forEach(str => {
				utteranceAppendedPause = createUtterance(str)
				utteranceAppendedPause.postUtteranceDelay = 0.5
				utterances.push(utteranceAppendedPause)
			})
			
			signOffUtterance = createUtterance(signOff)
			signOffUtterance.preUtteranceDelay = 0.5
			utterances.push(signOffUtterance)
			
			
			// DISPLAY CANCELING ALERT AND SPEAK THE UTTERANCE
			alert = new Alert(`${taskTitle}`, "Click “Done” to Stop.")
			alert.addOption("Done")
			//synthesizer.speakUtterance(utterance)
			utterances.forEach(utt => {
				synthesizer.speakUtterance(utt)
			})
			index = await alert.show()
			synthesizer.stopSpeaking(Speech.Boundary.Word)
		}
	}
	catch(err){
		utterance = createUtterance(err.message)
		synthesizer.speakUtterance(utterance)
		//new Alert(err.name, err.message).show()
	}
})();