Hey! These docs are for version 1.0, which is no longer officially supported. Click here for the latest version, 3.0!

❗️

API is still in development

This API is under active development. If you are interested in early access, please drop us a note at [email protected] and we will be happy to let you in and show around.

File is opened for editing using rollMyFile.editFile().

rollMyFile.editFile("https://www.example.com/case/123/attachments/overview.docx", "1a2b3c4d5e6f");

With this call application will open in a separate window with the file loaded into it. User will then be able to save his changes using File->Save or similar function of the application.

🚧

Pop-up Blocker

To prevent pop-up blocker from interfering with application launch this method has to be called from an event handler for click or key press.

More about pop-up blocker from Mozilla developers.

Parameters

ParameterDescription
file_endpoint_urlURL for File Access Endpoint, which is used for downloading file for editing and uploading after it was saved by the user.
access_token
optional
Access token that is passed back to File Access Endpoint as X-Access-Token header.

This access token can be used for authorizing access to the file, tracking user's activities for the file, etc.
filename
optional
Name of the file to be edited. It is used to determine the application, which will be launched for editing the file. This name will also be used by the application for opening the file.

If filename is not given, we try to infer it from the file_endpoint_url.
dirname
optional
Name of the directory, where the file will be available to the application. User will not usually see this, unless the application shows it somewhere in it's UI.

If dirname is not given, domain name from file_endpoint_url will be used.