@since 9.2.0 to @since 11.0.0

Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>
This commit is contained in:
Roeland Jago Douma 2016-11-15 18:51:52 +01:00
parent b775d935f2
commit f07d75a4dd
No known key found for this signature in database
GPG Key ID: F941078878347C0C
35 changed files with 101 additions and 101 deletions

View File

@ -734,7 +734,7 @@
/**
* Returns the dav.Client instance used internally
*
* @since 9.2
* @since 11.0.0
* @return {dav.Client}
*/
getClient: function() {
@ -744,7 +744,7 @@
/**
* Returns the user name
*
* @since 9.2
* @since 11.0.0
* @return {String} userName
*/
getUserName: function() {
@ -754,7 +754,7 @@
/**
* Returns the password
*
* @since 9.2
* @since 11.0.0
* @return {String} password
*/
getPassword: function() {
@ -764,7 +764,7 @@
/**
* Returns the base URL
*
* @since 9.2
* @since 11.0.0
* @return {String} base URL
*/
getBaseUrl: function() {

View File

@ -20,7 +20,7 @@
/**
* @namespace
* @since 9.2.0
* @since 11.0.0
*/
OCP.AppConfig = {
/**
@ -46,7 +46,7 @@ OCP.AppConfig = {
/**
* @param {Object} [options]
* @param {function} [options.success]
* @since 9.2.0
* @since 11.0.0
*/
getApps: function(options) {
this._call('get', '', options);
@ -57,7 +57,7 @@ OCP.AppConfig = {
* @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);
@ -70,7 +70,7 @@ OCP.AppConfig = {
* @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 || {};
@ -88,7 +88,7 @@ OCP.AppConfig = {
* @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 || {};
@ -105,7 +105,7 @@ OCP.AppConfig = {
* @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);

View File

@ -306,7 +306,7 @@ class Db implements IDb {
* 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();

View File

@ -207,7 +207,7 @@ class Comment implements IComment {
* 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:
* [

View File

@ -768,7 +768,7 @@ class Manager implements ICommentsManager {
* @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.
@ -790,7 +790,7 @@ class Manager implements ICommentsManager {
* @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

View File

@ -412,7 +412,7 @@ class Connection extends \Doctrine\DBAL\Connection implements IDBConnection {
* 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');

View File

@ -289,7 +289,7 @@ class Notification implements INotification {
* @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 === '') {
@ -304,7 +304,7 @@ class Notification implements INotification {
/**
* @return string
* @since 9.2.0
* @since 11.0.0
*/
public function getRichSubject() {
return $this->subjectRich;
@ -312,7 +312,7 @@ class Notification implements INotification {
/**
* @return array[]
* @since 9.2.0
* @since 11.0.0
*/
public function getRichSubjectParameters() {
return $this->subjectRichParameters;
@ -379,7 +379,7 @@ class Notification implements INotification {
* @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 === '') {
@ -394,7 +394,7 @@ class Notification implements INotification {
/**
* @return string
* @since 9.2.0
* @since 11.0.0
*/
public function getRichMessage() {
return $this->messageRich;
@ -402,7 +402,7 @@ class Notification implements INotification {
/**
* @return array[]
* @since 9.2.0
* @since 11.0.0
*/
public function getRichMessageParameters() {
return $this->messageRichParameters;
@ -434,7 +434,7 @@ class Notification implements INotification {
* @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])) {
@ -446,7 +446,7 @@ class Notification implements INotification {
/**
* @return string
* @since 9.2.0
* @since 11.0.0
*/
public function getIcon() {
return $this->icon;

View File

@ -155,7 +155,7 @@ class PreviewManager implements IPreview {
* @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) {

View File

@ -30,7 +30,7 @@ use OCP\RichObjectStrings\IValidator;
* Class Validator
*
* @package OCP\RichObjectStrings
* @since 9.2.0
* @since 11.0.0
*/
class Validator implements IValidator {
@ -53,7 +53,7 @@ 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 = [];

View File

@ -375,7 +375,7 @@ class Manager extends PublicEmitter implements IUserManager {
* 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();
@ -395,7 +395,7 @@ class Manager extends PublicEmitter implements IUserManager {
/**
* @param \Closure $callback
* @since 9.2.0
* @since 11.0.0
*/
public function callForSeenUsers(\Closure $callback) {
$limit = 1000;

View File

@ -88,7 +88,7 @@ class EmptyContentSecurityPolicy {
*
* @param string $nonce
* @return $this
* @since 9.2.0
* @since 11.0.0
*/
public function useJsNonce($nonce) {
$this->useJsNonce = $nonce;

View File

@ -28,7 +28,7 @@ use OCP\AppFramework\Http;
* Class FileDisplayResponse
*
* @package OCP\AppFramework\Http
* @since 9.2.0
* @since 11.0.0
*/
class FileDisplayResponse extends Response implements ICallbackResponse {
@ -41,7 +41,7 @@ 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=[]) {
@ -58,7 +58,7 @@ class FileDisplayResponse extends Response implements ICallbackResponse {
/**
* @param IOutput $output
* @since 9.2.0
* @since 11.0.0
*/
public function callback(IOutput $output) {
if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) {

View File

@ -76,7 +76,7 @@ abstract class OCSController extends ApiController {
/**
* @param int $version
* @since 9.2.0
* @since 11.0.0
* @internal
*/
public function setOCSVersion($version) {

View File

@ -136,7 +136,7 @@ interface IComment {
* 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:
* [

View File

@ -27,13 +27,13 @@ namespace OCP\Comments;
* 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);
}

View File

@ -242,7 +242,7 @@ interface ICommentsManager {
* to consumers of the comments infrastructure
*
* @param \Closure $closure
* @since 9.2.0
* @since 11.0.0
*/
public function registerEventHandler(\Closure $closure);
@ -252,7 +252,7 @@ interface ICommentsManager {
* @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.
@ -266,7 +266,7 @@ interface ICommentsManager {
* @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

View File

@ -50,13 +50,13 @@ interface IQuery {
/**
* @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();
}

View File

@ -73,7 +73,7 @@ interface ICachedMountInfo {
* 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();
}

View File

@ -28,7 +28,7 @@ use OCP\Files\SimpleFS\ISimpleRoot;
* 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 {

View File

@ -28,7 +28,7 @@ use OCP\Files\NotPermittedException;
* 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 {
@ -37,7 +37,7 @@ interface ISimpleFile {
* Get the name
*
* @return string
* @since 9.2.0
* @since 11.0.0
*/
public function getName();
@ -45,7 +45,7 @@ interface ISimpleFile {
* Get the size in bytes
*
* @return int
* @since 9.2.0
* @since 11.0.0
*/
public function getSize();
@ -53,7 +53,7 @@ interface ISimpleFile {
* Get the ETag
*
* @return string
* @since 9.2.0
* @since 11.0.0
*/
public function getETag();
@ -61,7 +61,7 @@ interface ISimpleFile {
* Get the last modification time
*
* @return int
* @since 9.2.0
* @since 11.0.0
*/
public function getMTime();
@ -69,7 +69,7 @@ interface ISimpleFile {
* Get the content
*
* @return string
* @since 9.2.0
* @since 11.0.0
*/
public function getContent();
@ -78,7 +78,7 @@ interface ISimpleFile {
*
* @param string $data
* @throws NotPermittedException
* @since 9.2.0
* @since 11.0.0
*/
public function putContent($data);
@ -86,7 +86,7 @@ interface ISimpleFile {
* Delete the file
*
* @throws NotPermittedException
* @since 9.2.0
* @since 11.0.0
*/
public function delete();
@ -94,7 +94,7 @@ interface ISimpleFile {
* Get the MimeType
*
* @return string
* @since 9.2.0
* @since 11.0.0
*/
public function getMimeType();
}

View File

@ -29,7 +29,7 @@ use OCP\Files\NotPermittedException;
* 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 {
@ -37,7 +37,7 @@ interface ISimpleFolder {
* Get all the files in a folder
*
* @return ISimpleFile[]
* @since 9.2.0
* @since 11.0.0
*/
public function getDirectoryListing();
@ -46,7 +46,7 @@ interface ISimpleFolder {
*
* @param string $name
* @return bool
* @since 9.2.0
* @since 11.0.0
*/
public function fileExists($name);
@ -56,7 +56,7 @@ interface ISimpleFolder {
* @param string $name
* @return ISimpleFile
* @throws NotFoundException
* @since 9.2.0
* @since 11.0.0
*/
public function getFile($name);
@ -66,7 +66,7 @@ interface ISimpleFolder {
* @param string $name
* @return ISimpleFile
* @throws NotPermittedException
* @since 9.2.0
* @since 11.0.0
*/
public function newFile($name);
@ -74,7 +74,7 @@ interface ISimpleFolder {
* Remove the folder and all the files in it
*
* @throws NotPermittedException
* @since 9.2.0
* @since 11.0.0
*/
public function delete();
@ -82,7 +82,7 @@ interface ISimpleFolder {
* Get the folder name
*
* @return string
* @since 9.2.0
* @since 11.0.0
*/
public function getName();
}

View File

@ -29,7 +29,7 @@ use OCP\Files\NotPermittedException;
* 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 {
@ -40,7 +40,7 @@ interface ISimpleRoot {
* @return ISimpleFolder
* @throws NotFoundException
* @throws \RuntimeException
* @since 9.2.0
* @since 11.0.0
*/
public function getFolder($name);
@ -50,7 +50,7 @@ interface ISimpleRoot {
* @return ISimpleFolder[]
* @throws NotFoundException
* @throws \RuntimeException
* @since 9.2.0
* @since 11.0.0
*/
public function getDirectoryListing();
@ -61,7 +61,7 @@ interface ISimpleRoot {
* @return ISimpleFolder
* @throws NotPermittedException
* @throws \RuntimeException
* @since 9.2.0
* @since 11.0.0
*/
public function newFolder($name);
}

View File

@ -256,7 +256,7 @@ interface IDBConnection {
* Check whether or not the current database support 4byte wide unicode
*
* @return bool
* @since 9.2.0
* @since 11.0.0
*/
public function supports4ByteText();
}

View File

@ -99,7 +99,7 @@ interface IPreview {
* @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);

View File

@ -148,13 +148,13 @@ interface IUserManager {
* 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);

View File

@ -26,20 +26,20 @@ namespace OCP\LDAP;
* 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);
}

View File

@ -26,14 +26,14 @@ namespace OCP\LDAP;
* 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);
@ -42,7 +42,7 @@ interface ILDAPProvider {
* @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);
@ -50,7 +50,7 @@ interface ILDAPProvider {
* 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);
@ -58,7 +58,7 @@ interface ILDAPProvider {
* 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);
@ -66,7 +66,7 @@ interface ILDAPProvider {
* 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);
@ -75,7 +75,7 @@ interface ILDAPProvider {
* @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);
@ -84,7 +84,7 @@ interface ILDAPProvider {
* @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);
@ -92,14 +92,14 @@ interface ILDAPProvider {
* 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);
}

View File

@ -31,7 +31,7 @@ use OCP\IServerContainer;
* instance.
*
* @package OCP\LDAP
* @since 9.2.0
* @since 11.0.0
*/
interface ILDAPProviderFactory {
@ -39,7 +39,7 @@ 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);
@ -47,7 +47,7 @@ interface ILDAPProviderFactory {
* creates and returns an instance of the ILDAPProvider
*
* @return ILDAPProvider
* @since 9.2.0
* @since 11.0.0
*/
public function getLDAPProvider();
}

View File

@ -132,19 +132,19 @@ interface INotification {
* @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();
@ -188,19 +188,19 @@ interface INotification {
* @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();
@ -222,13 +222,13 @@ interface INotification {
* @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();

View File

@ -26,12 +26,12 @@ namespace OCP\RichObjectStrings;
* 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' => [
@ -284,7 +284,7 @@ class Definitions {
* @param string $type
* @return array
* @throws InvalidObjectExeption
* @since 9.2.0
* @since 11.0.0
*/
public function getDefinition($type) {
if (isset($this->definitions[$type])) {

View File

@ -25,7 +25,7 @@ namespace OCP\RichObjectStrings;
* Class Validator
*
* @package OCP\RichObjectStrings
* @since 9.2.0
* @since 11.0.0
*/
interface IValidator {
@ -33,7 +33,7 @@ interface IValidator {
* @param string $subject
* @param array[] $parameters
* @throws InvalidObjectExeption
* @since 9.2.0
* @since 11.0.0
*/
public function validate($subject, array $parameters);
}

View File

@ -25,7 +25,7 @@ namespace OCP\RichObjectStrings;
* Class InvalidObjectExeption
*
* @package OCP\RichObjectStrings
* @since 9.2.0
* @since 11.0.0
*/
class InvalidObjectExeption extends \InvalidArgumentException {
}

View File

@ -95,7 +95,7 @@ interface IManager {
* @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);
@ -290,7 +290,7 @@ interface IManager {
* Check if a given share provider exists
* @param int $shareType
* @return bool
* @since 9.2.0
* @since 11.0.0
*/
public function shareProviderExists($shareType);

View File

@ -58,7 +58,7 @@ interface IProviderFactory {
/**
* @return IShareProvider[]
* @since 9.2.0
* @since 11.0.0
*/
public function getAllProviders();
}

View File

@ -99,7 +99,7 @@ interface IShareProvider {
* @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);