Data

A generic bag of bytes. Mainly useful to be interpreted / converted to some other type.

Instance Properties

• length (Number or nil r/o) • Number of bytes in this data.

Instance Functions

Functions for converting instances of the Data class into instances of the String class:

• toString() → (String) • Convert to a String instance, assuming that this Data is encoded as UTF8 Unicode.

• toBase64() → (String) • Convert to a Base–64 encoded string.

Class Functions

Functions for converting instances of the String class into instances of the Data class:

• fromString(string:String) → (Data) • Convert from a String to the UTF8 encoding of that string as Data.

• fromBase64(string:String) → (Data) • No documentation available.

String to Base64 Encoded String
Copy

encodedString = Data.fromString("How Now Brown Cow").toBase64()
//--> "SG93IE5vdyBCcm93biBDb3c="

Examples

Here’s an Omni Automation script for creating a new task in OmniFocus with the current OmniOutliner document as an attachment. The script uses the integrated URL support in OmniFocus to create and run a URL link for creating tasks.

In this example, the processed Data object is the extracted value of the contents property of the created FileWrapper instance (line 5). Note that the toBase64() function of the Data class to convert the contents of the file wrapper into a format that can be used in a URL.

New OmniFocus Task with Outline Attachment
Copy

(async () => {
	try {
		taskName = document.name
		wrapper = await document.makeFileWrapper(taskName)
		attachmentName = encodeURIComponent(wrapper.preferredFilename)
		encodedData = wrapper.contents.toBase64()
		taskName = encodeURIComponent(taskName)
		urlStr = "omnifocus://localhost/add?name=" + taskName
		urlStr += "&attachment=" + encodedData
		urlStr += "&attachment-name=" + attachmentNam
		URL.fromString(urlStr).open()
	}
	catch(err){
		new Alert(err.name, err.message).show()
	}
})();

Here’s an example script that exports the current text on the Pasteboard (clipboard) to a file. The example uses the fromString() of the Data class to convert the passed text to a data object that can be written to file.

NOTE: Since the Pasteboard class is a class shared by all Omni applications, this script will work in any Omni application:

Save the Clipboard Text to Plain Text File
Copy

(async () => {
	try {
		if(Pasteboard.general.hasStrings){
			data = Data.fromString(Pasteboard.general.string)
			wrapper = FileWrapper.withContents('Pasteboard.txt',data)
			filesaver = new FileSaver()
			urlObj = await filesaver.show(wrapper)
			if(Device.current.mac){urlObj.open()}
		}
	}
	catch(err){
		new Alert(err.name, err.message).show()
	}
})();

Save Clipboard to RTF File
OmniFocusOmniGraffleOmniOutlinerOmniPlan  

/*{
	"type": "action",
	"targets": ["omnifocus","omnigraffle","omniplan","omnioutliner"],
	"author": "Otto Automator",
	"identifier": "com.omni-automation.all.clipboard-to-rtf-file",
	"version": "1.0",
	"description": "Plug-in will save the RTF content on the clipboard to file.",
	"label": "Clipboard to RTF File",
	"shortLabel": "Clipboard to RTF File",
	"paletteLabel": "Clipboard to RTF File",
	"image": "doc.richtext"
}*/
(() => {
	const action = new PlugIn.Action(async function(selection, sender){
		try {
			data = Pasteboard.general.dataForType(TypeIdentifier.rtf)
			wrapper = FileWrapper.withContents('clipboard-export.rtf', data)
			urlObj = await new FileSaver().show(wrapper)
			if(Device.current.mac){
				alertTitle = "File Created"
				alertMsg = "Open the file?"
				alert = new Alert(alertTitle, alertMsg)
				alert.addOption("Open")
				alert.addOption("Skip")
				alert.show(function(result){
					if (result == 0){urlObj.open()}
				})
			}
		}
		catch(err){
			if(!err.causedByUserCancelling){
				console.error(err.name, err.message)
				new Alert(err.name, err.message).show()
			}
		}
	});

	action.validate = function(selection, sender){
		return (Pasteboard.general.hasStrings)
	};
	
	return action;
})();