mirror of
https://github.com/nextcloud/server.git
synced 2025-02-07 09:59:46 +00:00
44 lines
1.5 KiB
PHP
44 lines
1.5 KiB
PHP
<?php
|
|
/**
|
|
* SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-License-Identifier: AGPL-3.0-or-later
|
|
*/
|
|
namespace OCP\Federation;
|
|
|
|
/**
|
|
* Interface ICloudFederationFactory
|
|
*
|
|
*
|
|
* @since 14.0.0
|
|
*/
|
|
interface ICloudFederationFactory {
|
|
/**
|
|
* get a CloudFederationShare Object to prepare a share you want to send
|
|
*
|
|
* @param string $shareWith
|
|
* @param string $name resource name (e.g. document.odt)
|
|
* @param string $description share description (optional)
|
|
* @param string $providerId resource UID on the provider side
|
|
* @param string $owner provider specific UID of the user who owns the resource
|
|
* @param string $ownerDisplayName display name of the user who shared the item
|
|
* @param string $sharedBy provider specific UID of the user who shared the resource
|
|
* @param string $sharedByDisplayName display name of the user who shared the resource
|
|
* @param string $sharedSecret used to authenticate requests across servers
|
|
* @param string $shareType ('group' or 'user' share)
|
|
* @param $resourceType ('file', 'calendar',...)
|
|
* @return ICloudFederationShare
|
|
*
|
|
* @since 14.0.0
|
|
*/
|
|
public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $sharedSecret, $shareType, $resourceType);
|
|
|
|
/**
|
|
* get a Cloud FederationNotification object to prepare a notification you
|
|
* want to send
|
|
*
|
|
* @return ICloudFederationNotification
|
|
*
|
|
* @since 14.0.0
|
|
*/
|
|
public function getCloudFederationNotification();
|
|
}
|