Nextcloud PHP API (master)

ICloudFederationProviderManager

Class ICloudFederationProviderManager

Manage cloud federation providers

Tags
since
14.0.0

Table of Contents

Methods

addCloudFederationProvider()  : mixed
Registers an callback function which must return an cloud federation provider
getAllCloudFederationProviders()  : array<string|int, mixed>
get a list of all cloudFederationProviders
getCloudFederationProvider()  : ICloudFederationProvider
get a specific cloud federation provider
isReady()  : bool
check if the new cloud federation API is ready to be used
removeCloudFederationProvider()  : mixed
remove cloud federation provider
sendCloudNotification()  : IResponse
sendCloudShare()  : IResponse
sendNotification()  : array<string|int, mixed>|false
send notification about existing share
sendShare()  : mixed
send federated share

Methods

addCloudFederationProvider()

Registers an callback function which must return an cloud federation provider

public addCloudFederationProvider(string $resourceType, string $displayName, callable $callback) : mixed
Parameters
$resourceType : string

which resource type does the provider handles

$displayName : string

user facing name of the federated share provider

$callback : callable
Tags
throws
ProviderAlreadyExistsException
since
14.0.0

getAllCloudFederationProviders()

get a list of all cloudFederationProviders

public getAllCloudFederationProviders() : array<string|int, mixed>
Tags
since
14.0.0
Return values
array<string|int, mixed>

[resourceType => ['resourceType' => $resourceType, 'displayName' => $displayName, 'callback' => callback]]

removeCloudFederationProvider()

remove cloud federation provider

public removeCloudFederationProvider(string $resourceType) : mixed
Parameters
$resourceType : string
Tags
since
14.0.0

        
On this page

Search results