Skip to content

OpenDocument

Enable the app user to open a file at a specified location with a selected third party application.

The properties defined in Action are also applicable to this action.

OpenDocument Properties

Property Type Required
Path string Required
_Type const Required

Path

Path to the location of the file. Value can be: Prefixed with res:// (file is embedded in the main bundle); A full path (file is located in the application's sandbox system); Https url (http not supported)

  • type: string

_Type

  • type: const

The value of this property must be equal to:

"Action.Type.OpenDocument"

Action Result

The ActionResult of this action is an empty string on success or an error message on failure.


Examples

// OpenDocument.action
{
    "Path": "/path/to/document.pdf",
    "_Type": "Action.Type.OpenDocument"
}

{
    "Path": "res://document.pdf",
    "_Type": "Action.Type.OpenDocument"
}

{
    "Path" : "https://some.externalserver.xyz/images/someimage.jpg",
    "_Type" : "Action.Type.OpenDocument"
}