/**
* Returns the dav.Client instance used internally
*
- * @since 9.2
+ * @since 11.0.0
* @return {dav.Client}
*/
getClient: function() {
/**
* Returns the user name
*
- * @since 9.2
+ * @since 11.0.0
* @return {String} userName
*/
getUserName: function() {
/**
* Returns the password
*
- * @since 9.2
+ * @since 11.0.0
* @return {String} password
*/
getPassword: function() {
/**
* Returns the base URL
*
- * @since 9.2
+ * @since 11.0.0
* @return {String} base URL
*/
getBaseUrl: function() {
/**
* @namespace
- * @since 9.2.0
+ * @since 11.0.0
*/
OCP.AppConfig = {
/**
/**
* @param {Object} [options]
* @param {function} [options.success]
- * @since 9.2.0
+ * @since 11.0.0
*/
getApps: function(options) {
this._call('get', '', options);
* @param {Object} [options]
* @param {function} [options.success]
* @param {function} [options.error]
- * @since 9.2.0
+ * @since 11.0.0
*/
getKeys: function(app, options) {
this._call('get', '/' + app, options);
* @param {Object} [options]
* @param {function} [options.success]
* @param {function} [options.error]
- * @since 9.2.0
+ * @since 11.0.0
*/
getValue: function(app, key, defaultValue, options) {
options = options || {};
* @param {Object} [options]
* @param {function} [options.success]
* @param {function} [options.error]
- * @since 9.2.0
+ * @since 11.0.0
*/
setValue: function(app, key, value, options) {
options = options || {};
* @param {Object} [options]
* @param {function} [options.success]
* @param {function} [options.error]
- * @since 9.2.0
+ * @since 11.0.0
*/
deleteKey: function(app, key, options) {
this._call('delete', '/' + app + '/' + key, options);
* Check whether or not the current database support 4byte wide unicode
*
* @return bool
- * @since 9.2.0
+ * @since 11.0.0
*/
public function supports4ByteText() {
return $this->connection->supports4ByteText();
* returns an array containing mentions that are included in the comment
*
* @return array each mention provides a 'type' and an 'id', see example below
- * @since 9.2.0
+ * @since 11.0.0
*
* The return array looks like:
* [
* @param string $type
* @param \Closure $closure
* @throws \OutOfBoundsException
- * @since 9.2.0
+ * @since 11.0.0
*
* Only one resolver shall be registered per type. Otherwise a
* \OutOfBoundsException has to thrown.
* @param string $id
* @return string
* @throws \OutOfBoundsException
- * @since 9.2.0
+ * @since 11.0.0
*
* If a provided type was not registered, an \OutOfBoundsException shall
* be thrown. It is upon the resolver discretion what to return of the
* Check whether or not the current database support 4byte wide unicode
*
* @return bool
- * @since 9.2.0
+ * @since 11.0.0
*/
public function supports4ByteText() {
return ! ($this->getDatabasePlatform() instanceof MySqlPlatform && $this->getParams()['charset'] !== 'utf8mb4');
* @param array $parameters
* @return $this
* @throws \InvalidArgumentException if the subject or parameters are invalid
- * @since 9.2.0
+ * @since 11.0.0
*/
public function setRichSubject($subject, array $parameters = []) {
if (!is_string($subject) || $subject === '') {
/**
* @return string
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getRichSubject() {
return $this->subjectRich;
/**
* @return array[]
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getRichSubjectParameters() {
return $this->subjectRichParameters;
* @param array $parameters
* @return $this
* @throws \InvalidArgumentException if the message or parameters are invalid
- * @since 9.2.0
+ * @since 11.0.0
*/
public function setRichMessage($message, array $parameters = []) {
if (!is_string($message) || $message === '') {
/**
* @return string
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getRichMessage() {
return $this->messageRich;
/**
* @return array[]
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getRichMessageParameters() {
return $this->messageRichParameters;
* @param string $icon
* @return $this
* @throws \InvalidArgumentException if the icon is invalid
- * @since 9.2.0
+ * @since 11.0.0
*/
public function setIcon($icon) {
if (!is_string($icon) || $icon === '' || isset($icon[4000])) {
/**
* @return string
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getIcon() {
return $this->icon;
* @param string $mimeType
* @return ISimpleFile
* @throws NotFoundException
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null) {
if ($this->generator === null) {
* Class Validator
*
* @package OCP\RichObjectStrings
- * @since 9.2.0
+ * @since 11.0.0
*/
class Validator implements IValidator {
* @param string $subject
* @param array[] $parameters
* @throws InvalidObjectExeption
- * @since 9.2.0
+ * @since 11.0.0
*/
public function validate($subject, array $parameters) {
$matches = [];
* returns how many users have logged in once
*
* @return int
- * @since 9.2.0
+ * @since 11.0.0
*/
public function countSeenUsers() {
$queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
/**
* @param \Closure $callback
- * @since 9.2.0
+ * @since 11.0.0
*/
public function callForSeenUsers(\Closure $callback) {
$limit = 1000;
*
* @param string $nonce
* @return $this
- * @since 9.2.0
+ * @since 11.0.0
*/
public function useJsNonce($nonce) {
$this->useJsNonce = $nonce;
* Class FileDisplayResponse
*
* @package OCP\AppFramework\Http
- * @since 9.2.0
+ * @since 11.0.0
*/
class FileDisplayResponse extends Response implements ICallbackResponse {
* @param \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile $file
* @param int $statusCode
* @param array $headers
- * @since 9.2.0
+ * @since 11.0.0
*/
public function __construct($file, $statusCode=Http::STATUS_OK,
$headers=[]) {
/**
* @param IOutput $output
- * @since 9.2.0
+ * @since 11.0.0
*/
public function callback(IOutput $output) {
if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) {
/**
* @param int $version
- * @since 9.2.0
+ * @since 11.0.0
* @internal
*/
public function setOCSVersion($version) {
* returns an array containing mentions that are included in the comment
*
* @return array each mention provides a 'type' and an 'id', see example below
- * @since 9.2.0
+ * @since 11.0.0
*
* The return array looks like:
* [
* Interface ICommentsEventHandler
*
* @package OCP\Comments
- * @since 9.2.0
+ * @since 11.0.0
*/
interface ICommentsEventHandler {
/**
* @param CommentsEvent $event
- * @since 9.2.0
+ * @since 11.0.0
*/
public function handle(CommentsEvent $event);
}
* to consumers of the comments infrastructure
*
* @param \Closure $closure
- * @since 9.2.0
+ * @since 11.0.0
*/
public function registerEventHandler(\Closure $closure);
* @param string $type
* @param \Closure $closure
* @throws \OutOfBoundsException
- * @since 9.2.0
+ * @since 11.0.0
*
* Only one resolver shall be registered per type. Otherwise a
* \OutOfBoundsException has to thrown.
* @param string $id
* @return string
* @throws \OutOfBoundsException
- * @since 9.2.0
+ * @since 11.0.0
*
* If a provided type was not registered, an \OutOfBoundsException shall
* be thrown. It is upon the resolver discretion what to return of the
/**
* @return float
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getStartTime();
/**
* @return array
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getStacktrace();
}
* Get the internal path (within the storage) of the root of the mount
*
* @return string
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getRootInternalPath();
}
* Interface IAppData
*
* @package OCP\Files
- * @since 9.2.0
+ * @since 11.0.0
* @internal This interface is experimental and might change for NC12
*/
interface IAppData extends ISimpleRoot {
* Interface ISimpleFile
*
* @package OCP\Files\SimpleFS
- * @since 9.2.0
+ * @since 11.0.0
* @internal This interface is experimental and might change for NC12
*/
interface ISimpleFile {
* Get the name
*
* @return string
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getName();
* Get the size in bytes
*
* @return int
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getSize();
* Get the ETag
*
* @return string
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getETag();
* Get the last modification time
*
* @return int
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getMTime();
* Get the content
*
* @return string
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getContent();
*
* @param string $data
* @throws NotPermittedException
- * @since 9.2.0
+ * @since 11.0.0
*/
public function putContent($data);
* Delete the file
*
* @throws NotPermittedException
- * @since 9.2.0
+ * @since 11.0.0
*/
public function delete();
* Get the MimeType
*
* @return string
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getMimeType();
}
* Interface ISimpleFolder
*
* @package OCP\Files\SimpleFS
- * @since 9.2.0
+ * @since 11.0.0
* @internal This interface is experimental and might change for NC12
*/
interface ISimpleFolder {
* Get all the files in a folder
*
* @return ISimpleFile[]
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getDirectoryListing();
*
* @param string $name
* @return bool
- * @since 9.2.0
+ * @since 11.0.0
*/
public function fileExists($name);
* @param string $name
* @return ISimpleFile
* @throws NotFoundException
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getFile($name);
* @param string $name
* @return ISimpleFile
* @throws NotPermittedException
- * @since 9.2.0
+ * @since 11.0.0
*/
public function newFile($name);
* Remove the folder and all the files in it
*
* @throws NotPermittedException
- * @since 9.2.0
+ * @since 11.0.0
*/
public function delete();
* Get the folder name
*
* @return string
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getName();
}
* Interface ISimpleRoot
*
* @package OCP\Files\SimpleFS
- * @since 9.2.0
+ * @since 11.0.0
* @internal This interface is experimental and might change for NC12
*/
interface ISimpleRoot {
* @return ISimpleFolder
* @throws NotFoundException
* @throws \RuntimeException
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getFolder($name);
* @return ISimpleFolder[]
* @throws NotFoundException
* @throws \RuntimeException
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getDirectoryListing();
* @return ISimpleFolder
* @throws NotPermittedException
* @throws \RuntimeException
- * @since 9.2.0
+ * @since 11.0.0
*/
public function newFolder($name);
}
* Check whether or not the current database support 4byte wide unicode
*
* @return bool
- * @since 9.2.0
+ * @since 11.0.0
*/
public function supports4ByteText();
}
* @param string $mimeType To force a given mimetype for the file (files_versions needs this)
* @return ISimpleFile
* @throws NotFoundException
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null);
* returns how many users have logged in once
*
* @return int
- * @since 9.2.0
+ * @since 11.0.0
*/
public function countSeenUsers();
/**
* @param \Closure $callback
- * @since 9.2.0
+ * @since 11.0.0
*/
public function callForSeenUsers(\Closure $callback);
* Interface IDeletionFlagSupport
*
* @package OCP\LDAP
- * @since 9.2.0
+ * @since 11.0.0
*/
interface IDeletionFlagSupport {
/**
* Flag record for deletion.
* @param string $uid user id
- * @since 9.2.0
+ * @since 11.0.0
*/
public function flagRecord($uid);
/**
* Unflag record for deletion.
* @param string $uid user id
- * @since 9.2.0
+ * @since 11.0.0
*/
public function unflagRecord($uid);
}
* Interface ILDAPProvider
*
* @package OCP\LDAP
- * @since 9.2.0
+ * @since 11.0.0
*/
interface ILDAPProvider {
/**
* Translate a user id to LDAP DN.
* @param string $uid user id
* @return string
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getUserDN($uid);
* @param string $dn LDAP DN
* @return string with the internal user name
* @throws \Exception if translation was unsuccessful
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getUserName($dn);
* Convert a stored DN so it can be used as base parameter for LDAP queries.
* @param string $dn the DN
* @return string
- * @since 9.2.0
+ * @since 11.0.0
*/
public function DNasBaseParameter($dn);
* Sanitize a DN received from the LDAP server.
* @param array $dn the DN in question
* @return array the sanitized DN
- * @since 9.2.0
+ * @since 11.0.0
*/
public function sanitizeDN($dn);
* Return a new LDAP connection resource for the specified user.
* @param string $uid user id
* @return resource of the LDAP connection
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getLDAPConnection($uid);
* @param string $uid user id
* @return string the base for users
* @throws \Exception if user id was not found in LDAP
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getLDAPBaseUsers($uid);
* @param string $uid user id
* @return string the base for groups
* @throws \Exception if user id was not found in LDAP
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getLDAPBaseGroups($uid);
* Check whether a LDAP DN exists
* @param string $dn LDAP DN
* @return bool whether the DN exists
- * @since 9.2.0
+ * @since 11.0.0
*/
public function dnExists($dn);
/**
* Clear the cache if a cache is used, otherwise do nothing.
* @param string $uid user id
- * @since 9.2.0
+ * @since 11.0.0
*/
public function clearCache($uid);
}
* instance.
*
* @package OCP\LDAP
- * @since 9.2.0
+ * @since 11.0.0
*/
interface ILDAPProviderFactory {
* Constructor for the LDAP provider factory
*
* @param IServerContainer $serverContainer server container
- * @since 9.2.0
+ * @since 11.0.0
*/
public function __construct(IServerContainer $serverContainer);
* creates and returns an instance of the ILDAPProvider
*
* @return ILDAPProvider
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getLDAPProvider();
}
* @param array $parameters
* @return $this
* @throws \InvalidArgumentException if the subject or parameters are invalid
- * @since 9.2.0
+ * @since 11.0.0
*/
public function setRichSubject($subject, array $parameters = []);
/**
* @return string
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getRichSubject();
/**
* @return array[]
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getRichSubjectParameters();
* @param array $parameters
* @return $this
* @throws \InvalidArgumentException if the message or parameters are invalid
- * @since 9.2.0
+ * @since 11.0.0
*/
public function setRichMessage($message, array $parameters = []);
/**
* @return string
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getRichMessage();
/**
* @return array[]
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getRichMessageParameters();
* @param string $icon
* @return $this
* @throws \InvalidArgumentException if the icon is invalid
- * @since 9.2.0
+ * @since 11.0.0
*/
public function setIcon($icon);
/**
* @return string
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getIcon();
* Class Definitions
*
* @package OCP\RichObjectStrings
- * @since 9.2.0
+ * @since 11.0.0
*/
class Definitions {
/**
* @var array
- * @since 9.2.0
+ * @since 11.0.0
*/
public $definitions = [
'addressbook' => [
* @param string $type
* @return array
* @throws InvalidObjectExeption
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getDefinition($type) {
if (isset($this->definitions[$type])) {
* Class Validator
*
* @package OCP\RichObjectStrings
- * @since 9.2.0
+ * @since 11.0.0
*/
interface IValidator {
* @param string $subject
* @param array[] $parameters
* @throws InvalidObjectExeption
- * @since 9.2.0
+ * @since 11.0.0
*/
public function validate($subject, array $parameters);
}
* Class InvalidObjectExeption
*
* @package OCP\RichObjectStrings
- * @since 9.2.0
+ * @since 11.0.0
*/
class InvalidObjectExeption extends \InvalidArgumentException {
}
* @param Folder $node
* @param bool $reshares
* @return IShare[][] [$fileId => IShare[], ...]
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getSharesInFolder($userId, Folder $node, $reshares = false);
* Check if a given share provider exists
* @param int $shareType
* @return bool
- * @since 9.2.0
+ * @since 11.0.0
*/
public function shareProviderExists($shareType);
/**
* @return IShareProvider[]
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getAllProviders();
}
* @param Folder $node
* @param bool $reshares Also get the shares where $user is the owner instead of just the shares where $user is the initiator
* @return \OCP\Share\IShare[]
- * @since 9.2.0
+ * @since 11.0.0
*/
public function getSharesInFolder($userId, Folder $node, $reshares);
projects / nextcloud-server.git / commitdiff