ICloudFederationProviderManager
in
Class ICloudFederationProviderManager
Manage cloud federation providers
Tags
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
getAllCloudFederationProviders()
get a list of all cloudFederationProviders
public
getAllCloudFederationProviders() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —[resourceType => ['resourceType' => $resourceType, 'displayName' => $displayName, 'callback' => callback]]
getCloudFederationProvider()
get a specific cloud federation provider
public
getCloudFederationProvider(string $resourceType) : ICloudFederationProvider
Parameters
- $resourceType : string
Tags
Return values
ICloudFederationProviderisReady()
check if the new cloud federation API is ready to be used
public
isReady() : bool
Tags
Return values
boolremoveCloudFederationProvider()
remove cloud federation provider
public
removeCloudFederationProvider(string $resourceType) : mixed
Parameters
- $resourceType : string
Tags
sendCloudNotification()
public
sendCloudNotification(string $url, ICloudFederationNotification $notification) : IResponse
Parameters
- $url : string
- $notification : ICloudFederationNotification
Tags
Return values
IResponsesendCloudShare()
public
sendCloudShare(ICloudFederationShare $share) : IResponse
Parameters
- $share : ICloudFederationShare
Tags
Return values
IResponsesendNotification()
send notification about existing share
public
sendNotification(string $url, ICloudFederationNotification $notification) : array<string|int, mixed>|false
- Use sendCloudNotification() instead and handle errors manually
Parameters
- $url : string
- $notification : ICloudFederationNotification
Tags
Return values
array<string|int, mixed>|falsesendShare()
send federated share
public
sendShare(ICloudFederationShare $share) : mixed
- Use sendCloudShare() instead and handle errors manually
Parameters
- $share : ICloudFederationShare