IEditor¶

interface OCP\DirectEditing\IEditor¶

Source:	lib/public/DirectEditing/IEditor.php#34

Methods¶

public OCP\DirectEditing\IEditor::getId()¶

Return a unique identifier for the editor

e.g. richdocuments

Source:	lib/public/DirectEditing/IEditor.php#44
Since:	18.0.0
Returns:	string

public OCP\DirectEditing\IEditor::getName()¶

Return a readable name for the editor

e.g. Collabora Online

Source:	lib/public/DirectEditing/IEditor.php#54
Since:	18.0.0
Returns:	string

public OCP\DirectEditing\IEditor::getMimetypes()¶

A list of mimetypes that should open the editor by default

Source:	lib/public/DirectEditing/IEditor.php#62
Since:	18.0.0
Returns:	string[]

public OCP\DirectEditing\IEditor::getMimetypesOptional()¶

A list of mimetypes that can be opened in the editor optionally

Source:	lib/public/DirectEditing/IEditor.php#70
Since:	18.0.0
Returns:	string[]

public OCP\DirectEditing\IEditor::getCreators()¶

Return a list of file creation options to be presented to the user

Source:	lib/public/DirectEditing/IEditor.php#78
Since:	18.0.0
Returns:	`\OCP\DirectEditing\ACreateFromTemplate[]` \| `\OCP\DirectEditing\ACreateEmpty[]`

public OCP\DirectEditing\IEditor::isSecure()¶

Return if the view is able to securely view a file without downloading it to the browser

Source:	lib/public/DirectEditing/IEditor.php#86
Since:	18.0.0
Returns:	bool

public OCP\DirectEditing\IEditor::open($token)¶

Return a template response for displaying the editor

open can only be called once when the client requests the editor with a one-time-use token
For handling editing and later requests, editors need to impelement their own token handling and take care of invalidation

This behavior is similar to the current direct editing implementation in collabora where we generate a one-time token and switch over to the regular wopi token for the actual editing/saving process

Source:	lib/public/DirectEditing/IEditor.php#99
Since:	18.0.0
Returns:	`\OCP\AppFramework\Http\Response`