LocalOCMDiscoveryEvent
extends Event
in package
Use this event to register additional resources before the API returns them in the OCM provider list and capability
Tags
Attributes
- #[Listenable]
- $since: '33.0.0'
Table of Contents
Properties
Methods
- __construct() : mixed
- Compatibility constructor
- addCapability() : void
- Add a new OCM capability to the discovery data of local instance
- getProvider() : IOCMProvider
- Returns the ocm provider.
- isPropagationStopped() : bool
- {@inheritDoc}
- registerResourceType() : void
- removePublicKey() : void
- Remove the non-standard publicKey field from OCM discovery
- removeVersion() : void
- Remove the non-standard version field from OCM discovery
- setApiVersion() : void
- Set the apiVersion
- stopPropagation() : void
- Stops the propagation of the event to further event listeners
Properties
$provider read-only
private
IOCMProvider
$provider
Methods
__construct()
Compatibility constructor
public
__construct(IOCMProvider $provider) : mixed
Parameters
- $provider : IOCMProvider
Tags
addCapability()
Add a new OCM capability to the discovery data of local instance
public
addCapability(string $capability) : void
Parameters
- $capability : string
Tags
getProvider()
Returns the ocm provider.
public
getProvider() : IOCMProvider
Tags
Return values
IOCMProviderisPropagationStopped()
{@inheritDoc}
public
isPropagationStopped() : bool
Tags
Attributes
- #[Override]
Return values
boolregisterResourceType()
public
registerResourceType(string $name, array<int, string> $shareTypes, array<string, string> $protocols) : void
Parameters
- $name : string
- $shareTypes : array<int, string>
-
List of supported share recipients, e.g. 'user', 'group', …
- $protocols : array<string, string>
-
List of supported protocols and their location, e.g. ['webdav' => '/remote.php/webdav/']
Tags
removePublicKey()
Remove the non-standard publicKey field from OCM discovery
public
removePublicKey() : void
Tags
removeVersion()
Remove the non-standard version field from OCM discovery
public
removeVersion() : void
Tags
setApiVersion()
Set the apiVersion
public
setApiVersion(string $version) : void
Parameters
- $version : string
Tags
stopPropagation()
Stops the propagation of the event to further event listeners
public
stopPropagation() : void