IRoute¶

interface OCP\Route\IRoute¶

Interface IRoute

Implemented by:	`OC\Route\Route`
Source:	lib/public/Route/IRoute.php#34

Methods¶

public OCP\Route\IRoute::patch()¶

Specify PATCH as the method to use with this route

public OCP\Route\IRoute::method($method)¶

Specify the method when this route is to be used

Source:	lib/public/Route/IRoute.php#49
Parameters:	$method (string) HTTP method (uppercase)
Returns:	`\OCP\Route\IRoute`
Since:	7.0.0

public OCP\Route\IRoute::actionInclude($file)¶

The action to execute when this route matches, includes a file like

it is called directly

public OCP\Route\IRoute::get()¶

Specify GET as the method to use with this route

public OCP\Route\IRoute::post()¶

Specify POST as the method to use with this route

public OCP\Route\IRoute::delete()¶

Specify DELETE as the method to use with this route

public OCP\Route\IRoute::action($class, $function=null)¶

The action to execute when this route matches

Source:	lib/public/Route/IRoute.php#93
Parameters:	$class (string \| callable) the class or a callable $function (string) the function to use with the class
Returns:	`\OCP\Route\IRoute` This function is called with $class set to a callable or to the class with $function
Since:	7.0.0

public OCP\Route\IRoute::defaults($defaults)¶

Defaults to use for this route

public OCP\Route\IRoute::requirements($requirements)¶

Requirements for this route

Source:	lib/public/Route/IRoute.php#111
Parameters:	$requirements (array) The requirements
Returns:	`\OCP\Route\IRoute`
Since:	7.0.0

public OCP\Route\IRoute::put()¶

Specify PUT as the method to use with this route