Nextcloud PHP API (master)

Application

Table of Contents

Interfaces

IAccount
Interface IAccount
IAccountManager
Access user profile information
IAccountProperty
Interface IAccountProperty
IConsumer
Interface IConsumer
IEvent
Interface IEvent
IEventMerger
Interface EventMerger
IExtension
Interface IExtension
IFilter
Interface IFilter
IManager
Interface IManager
IProvider
Interface IProvider
ISetting
Interface ISetting
IAppManager
Interface IAppManager
IBootContext
IBootstrap
IRegistrationContext
The context object passed to IBootstrap::register
IMapperException
ICallbackResponse
Interface ICallbackResponse
IOutput
Very thin wrapper class to make output testable
IMenuAction
Interface IMenuAction
IAppContainer
This is a tagging interface for a container that belongs to an app
IAppConfig
Wrapper for AppConfig for the AppFramework
IInitialState
IControllerMethodReflector
Interface ControllerMethodReflector
ITimeFactory
Use this to get a timestamp or DateTime object in code to remain testable
IAlternativeLogin
IApacheBackend
Interface IApacheBackend
IProvideUserSecretBackend
Interface IProvideUserSecretBackend
ICredentials
IStore
IProvider
IToken
IActivatableAtLogin
IActivatableByAdmin
Marks a 2FA provider as activatable by the administrator. This means that an admin can activate this provider without user interaction. The provider, therefore, must not require any user-provided configuration.
IDeactivatableByAdmin
Marks a 2FA provider as activale by the administrator. This means that an admin can activate this provider without user interaction. The provider, therefore, must not require any user-provided configuration.
ILoginSetupProvider
IPersonalProviderSettings
Interface IPersonalProviderSettings
IProvider
IProvidesCustomCSP
IProvidesIcons
Interface for two-factor providers that provide dark and light provider icons
IProvidesPersonalSettings
Interface for admins that have personal settings. These settings will be shown in the security sections. Some information like the display name of the provider is read from the provider directly.
IRegistry
Nextcloud 2FA provider registry for stateful 2FA providers
IJob
This interface represend a backgroud job run with cron
IJobList
Interface IJobList
IParallelAwareJob
IBroadcastEvent
ICalendar
Interface ICalendar
ICalendarProvider
This interface defines a lazy loading mechanism for calendars for Public Consumption
ICalendarQuery
Build a flexible, extendable query to the CalDAV backend
ICreateFromString
Extends the current ICalendar interface to add a public write method
IHandleImipMessage
Extends the current ICalendar interface to add a public write method to handle iMIP data
IManager
This class provides access to the Nextcloud CalDAV backend.
IMetadataProvider
Interface IMetadataProvider
IBackend
Interface IBackend
IManager
IResource
Interface IResource
IResourceMetadata
Interface IResourceMetadata
IBackend
Interface IBackend
IManager
IRoom
Interface IRoom
IRoomMetadata
Interface IRoomMetadata
ICapability
Minimal interface that has to be implemented for a class to be considered a capability.
IInitialStateExcludedCapability
Indicate that a capability should not be injected in the initial state of the page as it might be expensive to query and not useful for the webui.
IPublicCapability
Minimal interface that has to be implemented for a class to be considered a capability.
IManager
Interface IManager
ISorter
Interface ISorter
ISearch
Interface ISearch
ISearchPlugin
Interface ISearchPlugin
ISearchResult
Interface ISearchResult
IDiscoverableReferenceProvider
IReference
IReferenceManager
IReferenceProvider
ISearchableReferenceProvider
ICollection
IManager
IProvider
IProviderManager
IResource
IBus
Interface IBus
ICommand
Interface ICommand
IComment
Interface IComment
ICommentsEventHandler
Interface ICommentsEventHandler
ICommentsManagerFactory
Interface ICommentsManagerFactory
IAction
Apps should use the IActionFactory to create new action objects
IActionFactory
IBulkProvider
Process contacts menu entries in bulk
IContactsStore
IEntry
ILinkAction
Apps should use the IActionFactory to create new action objects
IProvider
Process contacts menu entries
IManager
This class provides access to the contacts app. Use this class exclusively if you want to access contacts.
IAPIWidget
interface IAPIWidget
IAPIWidgetV2
Interface IAPIWidgetV2
IButtonWidget
Adds a button to the dashboard api representation
IConditionalWidget
interface IConditionalWidget
IIconWidget
Allow getting the absolute icon url for a widget
IManager
Interface IManager
IOptionWidget
Allow getting widget options
IReloadableWidget
Allow {@see IAPIWidgetV2} to reload their items
IWidget
Interface IWidget
IDataCollector
DataCollectorInterface.
IPreparedStatement
This interface allows you to prepare a database query.
IResult
This interface represents the result of a database query.
ISchemaWrapper
This interface allows to get information about the database schema.
ICompositeExpression
This class provides a wrapper around Doctrine's CompositeExpression
IExpressionBuilder
This class provides a wrapper around Doctrine's ExpressionBuilder
IFunctionBuilder
This class provides a builder for sql some functions
ILiteral
IParameter
IQueryBuilder
This class provides a wrapper around Doctrine's QueryBuilder
IQueryFunction
IEvent
Interface IEvent
IEventLogger
Interface IEventLogger
IQuery
Interface IQuery
IQueryLogger
Interface IQueryLogger
IEditor
IManager
Interface IManager
IToken
IEncryptionModule
Interface IEncryptionModule
IFile
Interface IFile
IManager
This class provides access to files encryption apps.
IStorage
Interface IStorage
IEventDispatcher
Event dispatcher service of Nextcloud
IEventListener
ICloudFederationFactory
Interface ICloudFederationFactory
ICloudFederationNotification
Interface ICloudFederationNotification
ICloudFederationProvider
Interface ICloudFederationProvider
ICloudFederationProviderManager
Class ICloudFederationProviderManager
ICloudFederationShare
Interface ICloudFederationShare
ICloudId
Parsed federated cloud id
ICloudIdManager
Interface for resolving federated cloud ids
IAppDataFactory
A factory allows you to get the AppData folder for an application.
ICache
Metadata cache for a storage
ICacheEntry
meta data for a file or folder
ICacheEvent
IFileAccess
Low level access to the file cache.
IPropagator
Propagate etags and mtimes within the storage
IScanner
Scan files from the storage and save to the cache
IUpdater
Update the cache and propagate changes
IWatcher
check the storage backends for updates and change the cache accordingly
ICachedMountFileInfo
Holds information about a mount for a user
ICachedMountInfo
Holds information about a mount for a user
IHomeMountProvider
Provides
IMountProvider
Provides
IMountProviderCollection
Manages the different mount providers
IRootMountProvider
IUserMountCache
Cache mounts points per user in the cache so we can easily look them up
File
Interface File
FileInfo
Interface FileInfo
Folder
Interface Node
IAppData
Interface IAppData
IHomeStorage
Interface IHomeStorage
IMimeTypeDetector
Interface IMimeTypeDetector
IMimeTypeLoader
Interface IMimeTypeLoader
IRootFolder
Interface IRootFolder
ILock
ILockManager
Manage app integrations with files_lock with collaborative editors
ILockProvider
IMountManager
Interface IMountManager
IMountPoint
A storage mounted to folder on the filesystem
IMovableMount
Denotes that the mount point can be (re)moved by the user
ISystemMountPoint
Mark a mountpoint as containing system data, meaning that the data is not user specific
Node
Interface Node
IChange
Represents a detected change in the storage
INotifyHandler
Provides access to detected changes in the storage by either actively listening or getting the list of changes that happened in the background
IRenameChange
Represents a detected rename change
IObjectStore
Interface IObjectStore
IObjectStoreMultiPartUpload
ISearchBinaryOperator
ISearchComparison
ISearchOperator
ISearchOrder
ISearchQuery
ISimpleFile
This interface allows to manage simple files.
ISimpleFolder
Interface ISimpleFolder
ISimpleRoot
Interface ISimpleRoot
IChunkedFileWrite
Provide a common interface to all different storage options
IDisableEncryptionStorage
Marks that a storage does not support server side encryption
ILockingStorage
Storage backends that require explicit locking
INotifyStorage
Storage backend that support active notifications
IReliableEtagStorage
Marks a storage as providing reliable etags according to expected behavior of etags within nextcloud:
IStorage
Provide a common interface to all different storage options
IStorageFactory
Creates storage instances and manages and applies storage wrappers
IWriteStreamStorage
Interface that adds the ability to write a stream directly to file
Storage
Provide a common interface to all different storage options
ICustomTemplateProvider
ITemplateManager
IFilesMetadataManager
Manager for FilesMetadata; manage files' metadata.
IMetadataQuery
Model that help building queries with metadata and metadata indexes
IFilesMetadata
Model that represent metadata linked to a specific file.
IMetadataValueWrapper
Model that store the value of a single metadata.
IFullTextSearchManager
Interface IFullTextSearchManager
IFullTextSearchPlatform
Interface IFullTextSearchPlatform
IFullTextSearchProvider
Interface IFullTextSearchProvider
IDocumentAccess
Interface IDocumentAccess
IIndex
Interface IIndex
IIndexDocument
Class IIndexDocument
IIndexOptions
Interface IIndexOptions
IRunner
Interface IRunner
ISearchOption
ISearchRequest
Interface ISearchRequest
ISearchRequestSimpleQuery
Interface ISearchRequestSimpleQuery
ISearchResult
Interface ISearchResult
ISearchTemplate
Class ISearchTemplate
IIndexService
Interface IIndexService
IProviderService
Interface IProviderService
ISearchService
Interface ISearchService
IConfig
Interface IConfig
IAddToGroupBackend
IBatchMethodsBackend
ICountDisabledInGroup
ICountUsersBackend
ICreateGroupBackend
ICreateNamedGroupBackend
IDeleteGroupBackend
IGetDisplayNameBackend
IGroupDetailsBackend
IHideFromCollaborationBackend
IIsAdminBackend
INamedBackend
IRemoveFromGroupBackend
ISearchableGroupBackend
ISetDisplayNameBackend
ISubAdmin
GroupInterface
TODO actually this is a IGroupBackend
IClient
Interface IClient
IClientService
Interface IClientService
IPromise
A wrapper around Guzzle's PromiseInterface
IResponse
Interface IResponse
IHandler
Interface for an app handler that reacts to requests to Nextcloud's well known URLs, e.g. to a WebFinger
IRequestContext
The context object for \OCP\Http\IWellKnownHandler::handle
IResponse
IAddressBook
Interface IAddressBook
IAppConfig
This class provides an easy way for apps to store config values in the database.
IAvatar
This class provides avatar functionality
IAvatarManager
This class provides avatar functionality
IBinaryFinder
Service that find the binary path for a program.
ICache
This interface defines method for accessing the file based user cache.
ICacheFactory
Interface ICacheFactory
ICertificate
Interface ICertificate
ICertificateManager
Manage trusted certificates
IConfig
Access to all the configuration options Nextcloud offers.
IContainer
Class IContainer
IDateTimeFormatter
Interface IDateTimeFormatter
IDateTimeZone
Interface IDateTimeZone
IDBConnection
Interface IDBConnection
IEmojiHelper
IEventSource
wrapper for server side events (http://en.wikipedia.org/wiki/Server-sent_events) includes a fallback for older browsers and IE
IEventSourceFactory
IGroup
Interface IGroup
IGroupManager
Class Manager
IImage
Class for basic image manipulation
IInitialStateService
IL10N
Interface IL10N
ILogger
Interface ILogger
IMemcache
This interface defines method for accessing the file based user cache.
IMemcacheTTL
Interface for memcache backends that support setting ttl after the value is set
INavigationManager
Manages the ownCloud navigation
IPhoneNumberUtil
IPreview
This class provides functions to render and show thumbnails and previews of files
IRequest
This interface provides an immutable object with with accessors to request variables and headers.
IRequestId
ISearch
Small Interface for Search
IServerContainer
This is a tagging interface for the server container
ISession
Interface ISession
IStreamImage
Class for basic image manipulation
ITagManager
Factory class creating instances of \OCP\ITags
ITags
Class for easily tagging objects by their id
ITempManager
Interface ITempManager
IURLGenerator
Class to generate URLs
IUser
Interface IUser
IUserBackend
Interface IUserBackend
IUserManager
Class Manager
IUserSession
User session
IFactory
ILanguageIterator
Interface ILanguageIterator
IDeletionFlagSupport
Interface IDeletionFlagSupport
ILDAPProvider
Interface ILDAPProvider
ILDAPProviderFactory
Interface ILDAPProviderFactory
ILockingProvider
This interface allows locking and unlocking filesystem paths
ILockdownManager
IDataLogger
Interface IDataLogger
IFileBased
Interface IFileBased
ILogFactory
Interface ILogFactory
IWriter
Interface IWriter
IAttachment
Interface IAttachment
IEMailTemplate
Interface IEMailTemplate
IMailer
Class IMailer provides some basic functions to create a mail message that can be used in combination with \OC\Mail\Message.
IMessage
Interface IMessage
IMigrationStep
IOutput
Interface IOutput
IRepairStep
Repair step
IAction
Interface IAction
IApp
Interface IApp
IDeferrableApp
Interface IDeferrableApp
IDismissableNotifier
Interface INotifier classes should implement if they want to process notifications that are dismissed by the user.
IManager
Interface IManager
INotification
Interface INotification
INotifier
Interface INotifier
IOCMDiscoveryService
Discover remote OCM services
IOCMProvider
Model based on the Open Cloud Mesh Discovery API
IOCMResource
Model based on the Open Cloud Mesh Discovery API
IDiscoveryService
Interface IDiscoveryService
IMimeIconProvider
Interface IMimeIconProvider
IProvider
Interface IProvider
IProviderV2
IVersionedPreviewFile
Marks files that should keep multiple preview "versions" for the same file id
ILinkAction
IProfileManager
IProfile
This interface store the results of the profiling of one request. You can get the saved profiles from the @see IProfiler.
IProfiler
This interface allows to interact with the built-in Nextcloud profiler.
IApiCollection
Provides access to the various apis of a remote instance
IApiFactory
ICapabilitiesApi
IUserApi
ICredentials
The credentials for a remote user
IInstance
Provides some basic info about a remote Nextcloud instance
IInstanceFactory
IUser
User info for a remote user
IValidator
Class Validator
IRoute
Interface IRoute
IRouter
Interface IRouter
IFilter
Interface for search filters
IFilterCollection
Interface for search filters
IFilteringProvider
Interface for advanced search providers
IInAppSearch
Interface for search providers supporting in-app search
IProvider
Interface for search providers
ISearchQuery
The query objected passed into \OCP\Search\IProvider::search
IContentSecurityPolicyManager
Used for Content Security Policy manipulations
ICredentialsManager
Store and retrieve credentials for external services
ICrypto
Class Crypto provides a high-level encryption layer using AES-CBC. If no key has been provided it will use the secret defined in config.php as key. Additionally the message will be HMAC'd.
IHasher
Class Hasher provides some basic hashing functions. Furthermore, it supports legacy hashes used by previous versions of ownCloud and helps migrating those hashes to newer ones.
IRemoteHostValidator
Validator for remote hosts
ISecureRandom
Class SecureRandom provides a wrapper around the random_int function to generate secure random strings. For PHP 7 the native CSPRNG is used, older versions do use a fallback.
ILimiter
Programmatic rate limiter for web requests that are not handled by an app framework controller
IRateLimitExceededException
Thrown if the (anonymous) user has exceeded a rate limit
IVerificationToken
IDeclarativeManager
IDeclarativeSettingsForm
IDelegatedSettings
Special cases of settings that can be allowed to use by member of special groups.
IIconSection
IManager
ISettings
ISubAdminSettings
Tagging interface for settings that should be shown to sub admins
ISetupCheck
This interface needs to be implemented if you want to provide custom setup checks in your application. The results of these checks will them be displayed in the admin overview.
ISetupCheckManager
IManager
This interface allows to manage sharing files between users and groups.
IProviderFactory
Interface IProviderFactory
IPublicShareTemplateFactory
IPublicShareTemplateProvider
IShare
This interface allows to represent a share object.
IShareHelper
Interface IShareHelper
IShareProvider
Interface IShareProvider
Share_Backend
Interface that apps must implement to share content.
Share_Backend_Collection
Interface for collections of of items implemented by another share backend.
Share_Backend_File_Dependent
Interface for share backends that share content that is dependent on files.
ISpeechToTextManager
ISpeechToTextProvider
ISpeechToTextProviderWithId
ISpeechToTextProviderWithUserId
ICollectBreadcrumbs
IMessageReporter
IRegistry
IReporter
IAssertion
IRegistry
ISubscription
ISupportedApps
ISystemTag
Public interface for a system-wide tag.
ISystemTagManager
Public interface to access and manage system-wide tags.
ISystemTagManagerFactory
Interface ISystemTagManagerFactory
ISystemTagObjectMapper
Public interface to access and manage system-wide tags.
IBroker
Abstraction over the optional Talk backend
IConversation
IConversationOptions
ITalkBackend
Interface for the Talk app to implement
IManager
API surface for apps interacting with and making use of LanguageModel providers without known which providers are installed
IProvider
This is the interface that is implemented by apps that implement a task processing provider
ISynchronousProvider
This is the interface that is implemented by apps that implement a task processing provider
ITaskType
This is a task type interface that is implemented by task processing task types
ITeamManager
ITeamResourceProvider
Implement a provider of resources that are shared or owned by a team
IManager
API surface for apps interacting with and making use of LanguageModel providers without known which providers are installed
IProvider
This is the interface that is implemented by apps that implement a text processing provider
IProviderWithExpectedRuntime
This interface allows the system to learn the provider's expected runtime
IProviderWithId
This is the interface that is implemented by apps that implement a text processing provider
IProviderWithUserId
This interface allows providers to access the user that initiated the task being run.
ITaskType
This is a task type interface that is implemented by text processing task types
IManager
API surface for apps interacting with and making use of TextToImage providers without knowing which providers are installed
IProvider
This is the interface that is implemented by apps that implement a text to image provider
IProviderWithUserId
This is the interface that is implemented by apps that implement a text to image provider
IDetectLanguageProvider
ITranslationManager
ITranslationProvider
ITranslationProviderWithId
ITranslationProviderWithUserId
ICheckPasswordBackend
ICountMappedUsersBackend
ICountUsersBackend
ICreateUserBackend
ICustomLogout
IGetDisplayNameBackend
IGetHomeBackend
IGetRealUIDBackend
IPasswordConfirmationBackend
IProvideAvatarBackend
IProvideEnabledStateBackend
ISearchKnownUsersBackend
ISetDisplayNameBackend
ISetPasswordBackend
IAvailabilityCoordinator
Coordinator for availability and out-of-office messages
IOutOfOfficeData
DTO to hold out-of-office information of a user
UserInterface
TODO actually this is a IUserBackend
IExportDestination
IImportSource
IMigrator
ISizeEstimationMigrator
IManager
This interface allows to manage the user status.
IProvider
Interface IProvider
IUserStatus
Interface IUserStatus
IContextPortation
Interface IContextPortation
IDisplayName
Interface IDisplayName
IDisplayText
Interface IDisplayText
IIcon
Interface IIcon
IUrl
Interface IUrl
ICheck
Interface ICheck
IComplexOperation
Interface IComplexOperation
IEntity
Interface IEntity
IEntityCheck
Interface IFileCheck
IEntityEvent
Interface IEntityEvent
IFileCheck
Interface IFileCheck
IManager
Interface IManager
IOperation
Interface IOperation
IRuleMatcher
Class IRuleMatcher
ISpecificOperation
Interface ISpecificOperation

Classes

PropertyDoesNotExistException
Class PropertyDoesNotExistException
UserUpdatedEvent
Base event class for the event dispatcher service
ActivitySettings
FilterNotFoundException
IncompleteActivityException
Thrown when {@see \OCP\Notification\IManager::notify()} is called with a notification that does not have all required fields set:
InvalidValueException
SettingNotFoundException
UnknownActivityException
AppPathNotFoundException
Class AppPathNotFoundException
AppDisableEvent
Base event class for the event dispatcher service
AppEnableEvent
Base event class for the event dispatcher service
AppUpdateEvent
Base event class for the event dispatcher service
ManagerEvent
Class ManagerEvent
ApiController
Base class to inherit your controllers from that are used for RESTful APIs
App
Class App
AuthPublicShareController
Base controller for interactive public shares
Controller
Base class to inherit your controllers from
DoesNotExistException
This is returned or should be returned when a find request does not find an entry in the database
Entity
MultipleObjectsReturnedException
This is returned or should be returned when a find request finds more than one row
QBMapper
Simple parent class for inheriting your data access layer from. This class may be subject to change in the future
AnonRateLimit
Attribute for controller methods that want to limit the times a not logged-in guest can call the endpoint in a given time period.
ApiRoute
This attribute can be used to define API routes on controller methods.
ARateLimit
Attribute for controller methods that want to limit the times a logged-in user can call the endpoint in a given time period.
AuthorizedAdminSetting
Attribute for controller methods that should be only accessible with full admin or partial admin permissions.
BruteForceProtection
Attribute for controller methods that want to protect passwords, keys, tokens or other data against brute force
CORS
Attribute for controller methods that can also be accessed by not logged-in user
FrontpageRoute
This attribute can be used to define Frontpage routes on controller methods.
IgnoreOpenAPI
Attribute for controller methods that should be ignored when generating OpenAPI documentation
NoAdminRequired
Attribute for controller methods that can be accessed by any logged-in user
NoCSRFRequired
Attribute for controller methods that are not CSRF protected
OpenAPI
With this attribute a controller or a method can be moved into a different scope or tag. Scopes should be seen as API consumers, tags can be used to group different routes inside the same scope.
PasswordConfirmationRequired
Attribute for controller methods that require the password to be confirmed with in the last 30 minutes
PublicPage
Attribute for controller methods that can also be accessed by not logged-in user
Route
This attribute can be used to define routes on controller methods.
StrictCookiesRequired
Attribute for controller methods that require strict cookies
SubAdminRequired
Attribute for controller methods that can be accessed by sub-admins
UserRateLimit
Attribute for controller methods that want to limit the times a logged-in user can call the endpoint in a given time period.
UseSession
Attribute for controller methods that need to read/write PHP session data
ContentSecurityPolicy
Class ContentSecurityPolicy is a simple helper which allows applications to modify the Content-Security-Policy sent by Nextcloud. Per default only JavaScript, stylesheets, images, fonts, media and connections from the same domain ('self') are allowed.
DataDisplayResponse
Class DataDisplayResponse
DataDownloadResponse
Class DataDownloadResponse
DataResponse
A generic DataResponse class that is used to return generic data responses for responders to transform
DownloadResponse
Prompts the user to download the a file
EmptyContentSecurityPolicy
Class EmptyContentSecurityPolicy is a simple helper which allows applications to modify the Content-Security-Policy sent by Nexcloud. Per default the policy is forbidding everything.
EmptyFeaturePolicy
Class EmptyFeaturePolicy is a simple helper which allows applications to modify the FeaturePolicy sent by Nextcloud. Per default the policy is forbidding everything.
BeforeLoginTemplateRenderedEvent
Emitted before the rendering step of the login TemplateResponse.
BeforeTemplateRenderedEvent
Emitted before the rendering step of each TemplateResponse. The event holds a flag that specifies if an user is logged in.
FeaturePolicy
Class FeaturePolicy is a simple helper which allows applications to modify the Feature-Policy sent by Nextcloud. Per default only autoplay is allowed from the same domain and full screen as well from the same domain.
FileDisplayResponse
Class FileDisplayResponse
JSONResponse
A renderer for JSON calls
NotFoundResponse
A generic 404 response showing an 404 error page as well to the end-user
ParameterOutOfRangeException
RedirectResponse
Redirects to a different URL
RedirectToDefaultAppResponse
Redirects to the default app
StandaloneTemplateResponse
A template response that does not emit the loadAdditionalScripts events.
StreamResponse
Class StreamResponse
StrictContentSecurityPolicy
Class StrictContentSecurityPolicy is a simple helper which allows applications to modify the Content-Security-Policy sent by Nextcloud. Per default only JavaScript, stylesheets, images, fonts, media and connections from the same domain ('self') are allowed.
StrictEvalContentSecurityPolicy
Class StrictEvalContentSecurityPolicy is a simple helper which allows applications to modify the Content-Security-Policy sent by Nextcloud. Per default only JavaScript, stylesheets, images, fonts, media and connections from the same domain ('self') are allowed.
StrictInlineContentSecurityPolicy
Class StrictInlineContentSecurityPolicy is a simple helper which allows applications to modify the Content-Security-Policy sent by Nextcloud. Per default only JavaScript, stylesheets, images, fonts, media and connections from the same domain ('self') are allowed.
ExternalShareMenuAction
Class LinkMenuAction
LinkMenuAction
Class LinkMenuAction
PublicTemplateResponse
Class PublicTemplateResponse
SimpleMenuAction
Class SimpleMenuAction
TemplateResponse
Response for a normal template
TextPlainResponse
A renderer for text responses
TooManyRequestsResponse
A generic 429 response showing an 404 error page as well to the end-user
ZipResponse
Public library to send several files in one zip archive.
Http
Base class which contains constants for HTTP status codes
Middleware
Middleware is used to provide hooks before or after controller methods and deal with possible exceptions raised in the controller methods.
OCSBadRequestException
Class OCSBadRequestException
OCSException
Class OCSException
OCSForbiddenException
Class OCSForbiddenException
OCSNotFoundException
Class OCSNotFoundException
OCSPreconditionFailedException
Class OCSPreconditionFailedException
OCSController
Base class to inherit your controllers from that are used for RESTful APIs
PublicShareController
Base controller for public shares
QueryException
Class QueryException
InitialStateProvider
AnyLoginFailedEvent
Emitted when the authentication fails
LoginFailedEvent
Emitted when the authentication fails, but only if the login name can be associated with an existing user.
CredentialsUnavailableException
ExpiredTokenException
InvalidTokenException
PasswordUnavailableException
WipeTokenException
ALoginSetupController
Base class to inherit your controllers from
RegistryEvent
Base event class for the event dispatcher service
TwoFactorException
Two Factor Authentication failed
TwoFactorProviderChallengeFailed
Base event class for the event dispatcher service
TwoFactorProviderChallengePassed
Base event class for the event dispatcher service
TwoFactorProviderDisabled
Base event class for the event dispatcher service
TwoFactorProviderForUserDisabled
Base event class for the event dispatcher service
TwoFactorProviderForUserEnabled
Base event class for the event dispatcher service
TwoFactorProviderForUserRegistered
Base event class for the event dispatcher service
TwoFactorProviderForUserUnregistered
Base event class for the event dispatcher service
TwoFactorProviderUserDeleted
Base event class for the event dispatcher service
AutoloadNotAllowedException
Exception for when a not allowed path is attempted to be autoloaded
Job
Base class for background jobs
QueuedJob
Simple base class for a one time background job
TimedJob
Simple base class to extend to run periodic background jobs.
BeforeSabrePubliclyLoadedEvent
Dispatched before Sabre is loaded when accessing public webdav endpoints This can be used to inject a Sabre plugin for example
CappedMemoryCache
In-memory cache with a capacity limit to keep memory usage in check
BackendTemporarilyUnavailableException
Class BackendTemporarilyUnavailableException
CalendarException
AutoCompleteEvent
Class GenericEvent
AutoCompleteFilterEvent
Base event class for the event dispatcher service
SearchResultType
Class SearchResultType
ADiscoverableReferenceProvider
LinkReferenceProvider
Reference
RenderReferenceEvent
Event that apps can emit on their page rendering to trigger loading of aditional scripts for reference widget rendering
CollectionException
LoadAdditionalScriptsEvent
This event is used by apps to register their own frontend scripts for integrating projects in their app. Apps also need to dispatch the event in order to load scripts during page load
ResourceException
Color
Simple RGB color container
CommentsEntityEvent
Class CommentsEntityEvent
CommentsEvent
Class CommentsEvent
IllegalIDChangeException
Exception for illegal attempts to modify a comment ID
MessageTooLongException
Exception thrown when a comment message exceeds the allowed character limit
NotFoundException
Exception for not found entity
NotFoundException
This is thrown whenever something was expected to exist but doesn't
BeforePreferenceDeletedEvent
Base event class for the event dispatcher service
BeforePreferenceSetEvent
Base event class for the event dispatcher service
ConsoleEvent
Class ConsoleEvent
Constants
Class Constants
ContactInteractedWithEvent
An event that allows apps to notify other components about an interaction between two users. This can be used to build better recommendations and suggestions in user interfaces.
WidgetButton
Button for a dashboard widget
WidgetItem
Interface WidgetItem
WidgetItems
Interface WidgetItems
WidgetOptions
Option for displaying a widget
AbstractDataCollector
Children of this class must store the collected data in the data property.
AddMissingColumnsEvent
Event to allow apps to register information about missing database columns
AddMissingIndicesEvent
Event to allow apps to register information about missing database indices
AddMissingPrimaryKeyEvent
Event to allow apps to register information about missing database primary keys
Exception
Database exception
Types
Database types supported by Nextcloud's DBs
Defaults
public api to access default strings and urls for your templates
ACreateEmpty
ACreateFromTemplate
ATemplate
Class ATemplate
RegisterDirectEditorEvent
Event to allow to register the direct editor.
GenericEncryptionException
Class GenericEncryptionException
ABroadcastedEvent
Base event class for the event dispatcher service
Event
Base event class for the event dispatcher service
GenericEvent
Class GenericEvent
AbortedEventException
AppConfigException
AppConfigIncorrectTypeException
AppConfigTypeConflictException
AppConfigUnknownKeyException
TrustedServerRemovedEvent
Base event class for the event dispatcher service
ActionNotSupportedException
Class ActionNotSupportedException
AuthenticationFailedException
Class AuthenticationFailedException
BadRequestException
Class BadRequestException
ProviderAlreadyExistsException
Class ProviderAlreadyExistsException
ProviderCouldNotAddShareException
Class ProviderCouldNotAddShareException
ProviderDoesNotExistsException
Class ProviderDoesNotExistsException
AlreadyExistsException
Exception for already existing files/folders
AbstractCacheEvent
Base event class for the event dispatcher service
CacheEntryInsertedEvent
Event for when an existing entry in the cache gets inserted
CacheEntryRemovedEvent
Event for when an existing entry in the cache gets removed
CacheEntryUpdatedEvent
Event for when an existing entry in the cache gets updated
CacheInsertEvent
Event for when a new entry gets added to the cache
CacheUpdateEvent
Event for when an existing entry in the cache gets updated
ConnectionLostException
Exception for lost connection with the
DavUtil
This class provides different helper functions related to WebDAV protocol
EmptyFileNameException
Class EmptyFileNameException
EntityTooLargeException
Exception for too large entity
BeforeDirectFileDownloadEvent
This event is triggered when a user tries to download a file directly.
BeforeFileScannedEvent
Base event class for the event dispatcher service
BeforeFolderScannedEvent
Base event class for the event dispatcher service
BeforeZipCreatedEvent
Base event class for the event dispatcher service
FileCacheUpdated
Base event class for the event dispatcher service
FileScannedEvent
Base event class for the event dispatcher service
FolderScannedEvent
Base event class for the event dispatcher service
InvalidateMountCacheEvent
Used to notify the filesystem setup manager that the available mounts for a user have changed
AbstractNodeEvent
Base event class for the event dispatcher service
AbstractNodesEvent
Base event class for the event dispatcher service
BeforeNodeCopiedEvent
Base event class for the event dispatcher service
BeforeNodeCreatedEvent
Base event class for the event dispatcher service
BeforeNodeDeletedEvent
Base event class for the event dispatcher service
BeforeNodeReadEvent
Base event class for the event dispatcher service
BeforeNodeRenamedEvent
Base event class for the event dispatcher service
BeforeNodeTouchedEvent
Base event class for the event dispatcher service
BeforeNodeWrittenEvent
Base event class for the event dispatcher service
FilesystemTornDownEvent
Event fired after the filesystem has been torn down
NodeCopiedEvent
Base event class for the event dispatcher service
NodeCreatedEvent
Base event class for the event dispatcher service
NodeDeletedEvent
Base event class for the event dispatcher service
NodeRenamedEvent
Base event class for the event dispatcher service
NodeTouchedEvent
Base event class for the event dispatcher service
NodeWrittenEvent
Base event class for the event dispatcher service
NodeAddedToCache
Base event class for the event dispatcher service
NodeAddedToFavorite
Base event class for the event dispatcher service
NodeRemovedFromCache
Base event class for the event dispatcher service
NodeRemovedFromFavorite
Base event class for the event dispatcher service
FileNameTooLongException
Class FileNameTooLongException
ForbiddenException
Class ForbiddenException
GenericFileException
Class GenericFileException
InvalidCharacterInPathException
Exception for invalid path
InvalidContentException
Exception for invalid content
InvalidDirectoryException
Class InvalidDirectoryException
InvalidPathException
Exception for invalid path
LockContext
Structure to identify a specific lock context to request or describe a lock with the affected node and ownership information
NoLockProviderException
OwnerLockedException
Class LockedException
LockNotAcquiredException
Exception for a file that is locked
NotEnoughSpaceException
Exception for not enough space
NotFoundException
Exception for not found entity
NotPermittedException
Exception for not permitted action
ReservedWordException
Exception for invalid path
InMemoryFile
This class represents a file that is only hold in memory.
StorageAuthException
Storage authentication exception
StorageBadConfigException
Storage has bad or missing config params
StorageConnectionException
Storage authentication exception
StorageInvalidException
Storage has invalid configuration
StorageNotAvailableException
Storage is temporarily not available
StorageTimeoutException
Storage authentication exception
FileCreatedFromTemplateEvent
Base event class for the event dispatcher service
RegisterTemplateCreatorEvent
Base event class for the event dispatcher service
Template
TemplateFileCreator
UnseekableException
Exception for seek problem
Files
This class provides access to the internal filesystem abstraction layer. Use this class exclusively if you want to access files
AFilesDocument
Abstract Class AFilesDocument
AMetadataEvent
Base event class for the event dispatcher service
MetadataBackgroundEvent
MetadataBackgroundEvent is an event similar to MetadataLiveEvent but dispatched on a background thread instead of live thread. Meaning there is no limit to the time required for the generation of your metadata.
MetadataLiveEvent
MetadataLiveEvent is an event initiated when a file is created or updated.
MetadataNamedEvent
MetadataNamedEvent is an event similar to MetadataBackgroundEvent completed with a target name, used to limit the refresh of metadata only listeners capable of filtering themselves out.
FilesMetadataException
FilesMetadataKeyFormatException
FilesMetadataNotFoundException
FilesMetadataTypeException
FullTextSearchAppNotAvailableException
FullTextSearchIndexNotAvailableException
ABackend
BeforeGroupChangedEvent
Base event class for the event dispatcher service
BeforeGroupCreatedEvent
Base event class for the event dispatcher service
BeforeGroupDeletedEvent
Base event class for the event dispatcher service
BeforeUserAddedEvent
Base event class for the event dispatcher service
BeforeUserRemovedEvent
Base event class for the event dispatcher service
GroupChangedEvent
Base event class for the event dispatcher service
GroupCreatedEvent
Base event class for the event dispatcher service
GroupDeletedEvent
Base event class for the event dispatcher service
SubAdminAddedEvent
Base event class for the event dispatcher service
SubAdminRemovedEvent
Base event class for the event dispatcher service
UserAddedEvent
Base event class for the event dispatcher service
UserRemovedEvent
Base event class for the event dispatcher service
LocalServerException
GenericResponse
JrdResponse
A JSON Document Format (JDF) response to a well-known request
Image
This class provides functions to handle images
LockedException
Class LockedException
ManuallyLockedException
Class ManuallyLockedException
CriticalActionPerformedEvent
Emitted when the admin_audit app should log an entry
BeforeMessageLoggedEvent
Even for when a log item is being logged
BeforeMessageSent
Emitted before a system mail is sent. It can be used to alter the message.
AutoSubmitted
Keyword values for the Auto-Submitted email header, as per RFC 3834.
BigIntMigration
SimpleMigrationStep
AlreadyProcessedException
IncompleteNotificationException
Thrown when {@see \OCP\Notification\IManager::notify()} is called with a notification that does not have all required fields set:
IncompleteParsedNotificationException
Thrown when {@see \OCP\Notification\IManager::prepare()} is called with a notification that does not have all required fields set at the end of the manager or after a INotifier that claimed to have parsed the notification.
InvalidValueException
UnknownNotificationException
ResourceTypeRegisterEvent
Use this event to register additional OCM resources before the API returns them in the OCM provider list and capability
OCMArgumentException
OCMProviderException
PreConditionNotMetException
Exception if the precondition of the config update method isn't met
BeforePreviewFetchedEvent
Base event class for the event dispatcher service
BeforeTemplateRenderedEvent
Emitted before the rendering step of the public profile page happens.
ParameterDoesNotExistException
Definitions
Class Definitions
InvalidObjectExeption
Class InvalidObjectExeption
SabrePluginEvent
Base event class for the event dispatcher service
SabrePluginException
FilterDefinition
Filter definition
PagedProvider
Provides a template for search functionality throughout ownCloud;
Provider
Provides a template for search functionality throughout Nextcloud;
Result
The generic result of a search
SearchResult
SearchResultEntry
Represents an entry in a list of results an app returns for a unified search query.
MaxDelayReached
Class MaxDelayReached
AddContentSecurityPolicyEvent
Allows to inject something into the default content policy. This is for example useful when you're injecting Javascript code into a view belonging to another controller and cannot modify its Content-Security-Policy itself.
GenerateSecurePasswordEvent
Base event class for the event dispatcher service
ValidatePasswordPolicyEvent
Base event class for the event dispatcher service
AddFeaturePolicyEvent
Event that allows to register a feature policy header to a request.
InvalidTokenException
Server
Class allowing to inject services into your application. You should use whenever possible dependency injections instead.
SessionNotAvailableException
DeclarativeSettingsTypes
Declarative settings types supported in the IDeclarativeSettingsForm forms
DeclarativeSettingsGetValueEvent
Base event class for the event dispatcher service
DeclarativeSettingsRegisterFormEvent
Base event class for the event dispatcher service
DeclarativeSettingsSetValueEvent
Base event class for the event dispatcher service
SetupResult
BeforeShareCreatedEvent
Base event class for the event dispatcher service
BeforeShareDeletedEvent
Base event class for the event dispatcher service
ShareAcceptedEvent
Base event class for the event dispatcher service
ShareCreatedEvent
Base event class for the event dispatcher service
ShareDeletedEvent
Base event class for the event dispatcher service
ShareDeletedFromSelfEvent
Base event class for the event dispatcher service
VerifyMountPointEvent
Base event class for the event dispatcher service
AlreadySharedException
Class GenericEncryptionException
GenericShareException
Class GenericEncryptionException
IllegalIDChangeException
Exception for illegal attempts to modify an id of a share
ShareNotFound
Class ShareNotFound
Share
This class remains only for use with the ::class namespace used for various hooks
AbstractTranscriptionEvent
Base event class for the event dispatcher service
TranscriptionFailedEvent
This Event is emitted if a transcription of a media file using a Speech-To-Text provider failed
TranscriptionSuccessfulEvent
This Event is emitted when a transcription of a media file happened successfully
AlreadyRegisteredException
ManagerEvent
Class ManagerEvent
MapperEvent
Class MapperEvent
SystemTagsEntityEvent
Class SystemTagsEntityEvent
TagAlreadyExistsException
Exception when a tag already exists.
TagNotFoundException
Exception when a tag was not found.
NoBackendException
Thrown when the Talk API is accessed but there is no registered backend
AbstractTaskProcessingEvent
Base event class for the event dispatcher service
TaskFailedEvent
Base event class for the event dispatcher service
TaskSuccessfulEvent
Base event class for the event dispatcher service
Exception
TaskProcessing Exception
NotFoundException
TaskProcessing Exception
PreConditionNotMetException
TaskProcessing Exception
ProcessingException
Exception thrown during processing of a task by a synchronous provider
UnauthorizedException
TaskProcessing Exception
ValidationException
TaskProcessing Exception
ShapeDescriptor
Data object for input output shape entries
Task
This is a task processing task
AudioToText
This is the task processing task type for generic transcription
ContextWrite
This is the task processing task type for generic text processing
GenerateEmoji
This is the task processing task type for generic text processing
TextToImage
This is the task processing task type for image generation
TextToText
This is the task processing task type for generic text processing
TextToTextHeadline
This is the task processing task type for creating headline
TextToTextSummary
This is the task processing task type for summaries
TextToTextTopics
This is the task processing task type for topics extraction
Team
Simple abstraction to represent a team in the public API
TeamResource
Template
This class provides the template system for owncloud. You can use it to load specific templates, add data and generate the html code
AbstractTextProcessingEvent
Base event class for the event dispatcher service
TaskFailedEvent
Base event class for the event dispatcher service
TaskSuccessfulEvent
Base event class for the event dispatcher service
TaskFailureException
Exception thrown when a task failed
FreePromptTaskType
This is the text processing task type for free prompting
HeadlineTaskType
This is the text processing task type for creating headline
SummaryTaskType
This is the text processing task type for summaries
Task
This is a text processing task
TopicsTaskType
This is the text processing task type for topics extraction
AbstractTextToImageEvent
Base event class for the event dispatcher service
TaskFailedEvent
Base event class for the event dispatcher service
TaskSuccessfulEvent
Base event class for the event dispatcher service
TaskFailureException
TaskNotFoundException
TextToImageException
Task
This is a text to image task
CouldNotTranslateException
LanguageTuple
ABackend
BeforePasswordUpdatedEvent
Emitted before the user password is updated.
BeforeUserCreatedEvent
Emitted before a new user is created on the back-end.
BeforeUserDeletedEvent
Base event class for the event dispatcher service
BeforeUserLoggedInEvent
Base event class for the event dispatcher service
BeforeUserLoggedInWithCookieEvent
Emitted before a user is logged in via remember-me cookies.
BeforeUserLoggedOutEvent
Emitted before a user is logged out.
OutOfOfficeChangedEvent
Emitted when a user's out-of-office period has changed
OutOfOfficeClearedEvent
Emitted when a user's out-of-office period is cleared
OutOfOfficeEndedEvent
Emitted when a user's out-of-office period ended
OutOfOfficeScheduledEvent
Emitted when a user's out-of-office period is scheduled
OutOfOfficeStartedEvent
Emitted when a user's out-of-office period started
PasswordUpdatedEvent
Emitted when the user password has been updated.
PostLoginEvent
Base event class for the event dispatcher service
UserChangedEvent
Base event class for the event dispatcher service
UserCreatedEvent
Emitted when a new user has been created on the back-end.
UserDeletedEvent
Base event class for the event dispatcher service
UserFirstTimeLoggedInEvent
Base event class for the event dispatcher service
UserLiveStatusEvent
Base event class for the event dispatcher service
UserLoggedInEvent
Base event class for the event dispatcher service
UserLoggedInWithCookieEvent
Emitted when a user has been successfully logged in via remember-me cookies.
UserLoggedOutEvent
Emitted when a user has been logged out successfully.
GetQuotaEvent
Event to allow apps to
UserMigrationException
Util
This class provides different helper functions to make the life of a developer easier
LoadSettingsScriptsEvent
Emitted when the workflow engine settings page is loaded.
RegisterChecksEvent
Base event class for the event dispatcher service
RegisterEntitiesEvent
Base event class for the event dispatcher service
RegisterOperationsEvent
Base event class for the event dispatcher service
GenericEntityEvent
Class GenericEntityEvent

Traits

TTransactional
Helper trait for transactional operations
RotationTrait
Trait RotationTrait
TMigratorBasicVersionHandling
Basic version handling: we can import older versions but not newer ones

Enums

EShapeType
The input and output Shape types

Functions

logger()  : LoggerInterface
Get a PSR logger

Functions

logger()

Get a PSR logger

logger([string|null $appId = null ]) : LoggerInterface

Whenever possible, inject a logger into your classes instead of relying on this helper function.

Parameters
$appId : string|null = null

optional parameter to acquire the app-specific logger

Tags
warning

the returned logger implementation is not guaranteed to be the same between two function calls. During early stages of the process you might in fact get a noop implementation when Nextcloud isn't ready to log. Therefore you MUST NOT cache the result of this function but fetch a new logger for every log line you want to write.

since
24.0.0
Return values
LoggerInterface

        
On this page

Search results