IManager

interface OCP\DirectEditing\IManager
Interface IManager
Implemented by:OC\DirectEditing\Manager
Source:lib/public/DirectEditing/IManager.php#38

Methods

public OCP\DirectEditing\IManager::registerDirectEditor($directEditor)
Register a new editor
Source:

lib/public/DirectEditing/IManager.php#46

Parameters:
Since:

18.0.0

public OCP\DirectEditing\IManager::edit($token)
Open the editing page for a provided token
Source:

lib/public/DirectEditing/IManager.php#55

Parameters:
  • $token (string)
Since:

18.0.0

Returns:

\OCP\AppFramework\Http\Response

public OCP\DirectEditing\IManager::create($path, $editorId, $creatorId, $templateId=null)
Create a new token based on the file path and editor details
Source:

lib/public/DirectEditing/IManager.php#69

Parameters:
  • $path (string)
  • $editorId (string)
  • $creatorId (string)
  • $templateId (null)
Since:

18.0.0

Returns:

string

Throws:

\OCP\Files\NotPermittedException

Throws:

\RuntimeException

Throws:

\OCP\Files\NotPermittedException

Throws:

\RuntimeException

public OCP\DirectEditing\IManager::getToken($token)
Get the token details for a given token
Source:

lib/public/DirectEditing/IManager.php#78

Parameters:
  • $token (string)
Since:

18.0.0

Returns:

\OCP\DirectEditing\IToken

public OCP\DirectEditing\IManager::cleanup()
Cleanup expired tokens
Source:lib/public/DirectEditing/IManager.php#86
Since:18.0.0
Returns:int number of deleted tokens
public OCP\DirectEditing\IManager::isEnabled()
Check if direct editing is enabled
Source:lib/public/DirectEditing/IManager.php#94
Since:20.0.0
Returns:bool