### logger() Source: https://nextcloud-server.netlify.app/namespaces/ocp-log Get a PSR logger instance. It's recommended to inject a logger into classes rather than relying on this helper function. The returned logger implementation is not guaranteed to be the same between calls, and a no-op implementation might be returned during early stages of Nextcloud startup. ```APIDOC ## logger() ### Description Get a PSR logger instance. It's recommended to inject a logger into classes rather than relying on this helper function. The returned logger implementation is not guaranteed to be the same between calls, and a no-op implementation might be returned during early stages of Nextcloud startup. ### Function Signature `logger([string|null $appId = null]) : LoggerInterface` ### Parameters #### Query Parameters - **appId** (string|null) - Optional - An optional parameter to acquire the app-specific logger. ### Return values - **LoggerInterface** - The logger instance. ### 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 ``` -------------------------------- ### IManager Interface Source: https://nextcloud-server.netlify.app/namespaces/ocp-textprocessing API surface for apps interacting with and making use of LanguageModel providers without known which providers are installed. ```APIDOC ## Interface: IManager ### Description API surface for apps interacting with and making use of LanguageModel providers without known which providers are installed. ### Methods This interface provides methods for managing and interacting with text processing providers. ``` -------------------------------- ### IManager Source: https://nextcloud-server.netlify.app/namespaces/ocp-texttoimage API surface for apps interacting with and making use of TextToImage providers without knowing which providers are installed. ```APIDOC ## Interface: IManager ### Description API surface for apps interacting with and making use of TextToImage providers without knowing which providers are installed. ### Methods (No specific methods are documented in the source text for this interface.) ### Parameters (No specific parameters are documented in the source text for this interface.) ### Request Body (No request body information is available in the source text.) ### Response (No specific response information is available in the source text.) ``` -------------------------------- ### ISchemaWrapper Source: https://nextcloud-server.netlify.app/namespaces/ocp-db This interface allows to get information about the database schema. It provides access to metadata about tables, columns, and other database objects. ```APIDOC ## Interface: ISchemaWrapper ### Description This interface allows to get information about the database schema. It provides access to metadata about tables, columns, and other database objects. ### Methods (Details of methods are not provided in the source text) ### Usage (Usage examples are not provided in the source text) ``` -------------------------------- ### IProviderWithExpectedRuntime Interface Source: https://nextcloud-server.netlify.app/namespaces/ocp-textprocessing This interface allows the system to learn the provider's expected runtime. ```APIDOC ## Interface: IProviderWithExpectedRuntime ### Description This interface allows the system to learn the provider's expected runtime. ### Methods Provides information about the expected runtime of the text processing provider. ``` -------------------------------- ### IProvider Source: https://nextcloud-server.netlify.app/namespaces/ocp-texttoimage This is the interface that is implemented by apps that implement a text to image provider. ```APIDOC ## Interface: IProvider ### Description This is the interface that is implemented by apps that implement a text to image provider. ### Methods (No specific methods are documented in the source text for this interface.) ### Parameters (No specific parameters are documented in the source text for this interface.) ### Request Body (No request body information is available in the source text.) ### Response (No specific response information is available in the source text.) ``` -------------------------------- ### Task Source: https://nextcloud-server.netlify.app/namespaces/ocp-texttoimage This is a text to image task. ```APIDOC ## Class: Task ### Description This is a text to image task. ### Methods (No specific methods are documented in the source text for this class.) ### Parameters (No specific parameters are documented in the source text for this class.) ### Request Body (No request body information is available in the source text.) ### Response (No specific response information is available in the source text.) ``` -------------------------------- ### IOCMProvider Source: https://nextcloud-server.netlify.app/namespaces/ocp-ocm Represents a model based on the Open Cloud Mesh Discovery API. ```APIDOC ## Interface IOCMProvider ### Description Model based on the Open Cloud Mesh Discovery API. ### Usage This interface defines the structure and behavior of an OCM provider. ### Methods (Specific provider methods are not detailed in the source.) ``` -------------------------------- ### IPreparedStatement Source: https://nextcloud-server.netlify.app/namespaces/ocp-db This interface allows you to prepare a database query. It is used for executing SQL statements with parameters in a safe and efficient manner. ```APIDOC ## Interface: IPreparedStatement ### Description This interface allows you to prepare a database query. It is used for executing SQL statements with parameters in a safe and efficient manner. ### Methods (Details of methods are not provided in the source text) ### Usage (Usage examples are not provided in the source text) ``` -------------------------------- ### IProviderWithUserId Source: https://nextcloud-server.netlify.app/namespaces/ocp-texttoimage This is the interface that is implemented by apps that implement a text to image provider. ```APIDOC ## Interface: IProviderWithUserId ### Description This is the interface that is implemented by apps that implement a text to image provider. ### Methods (No specific methods are documented in the source text for this interface.) ### Parameters (No specific parameters are documented in the source text for this interface.) ### Request Body (No request body information is available in the source text.) ### Response (No specific response information is available in the source text.) ``` -------------------------------- ### IOCMResource Source: https://nextcloud-server.netlify.app/namespaces/ocp-ocm Represents a model based on the Open Cloud Mesh Discovery API. ```APIDOC ## Interface IOCMResource ### Description Model based on the Open Cloud Mesh Discovery API. ### Usage This interface likely represents a resource managed or exposed by an OCM provider. ### Methods (Specific resource methods are not detailed in the source.) ``` -------------------------------- ### ICapabilityAwareOCMProvider Source: https://nextcloud-server.netlify.app/namespaces/ocp-ocm Provides extensions for version 1.1 and 1.2 of the Open Cloud Mesh Discovery API, allowing for awareness of OCM provider capabilities. ```APIDOC ## Interface ICapabilityAwareOCMProvider ### Description Version 1.1 and 1.2 extensions to the Open Cloud Mesh Discovery API. ### Usage This interface is intended for OCM providers that need to expose or be aware of specific capabilities. ### Methods (Specific methods are not detailed in the source, but the interface implies capability-related operations.) ### Version Support 1.1 and 1.2 ``` -------------------------------- ### CalendarImportOptions Source: https://nextcloud-server.netlify.app/namespaces/ocp-calendar Represents options for importing calendar data. ```APIDOC ## Class CalendarImportOptions ### Description Calendar Import Options. ### Class ` ocp-calendar.CalendarImportOptions ` ``` -------------------------------- ### IProvider Interface Source: https://nextcloud-server.netlify.app/namespaces/ocp-textprocessing This is the interface that is implemented by apps that implement a text processing provider. ```APIDOC ## Interface: IProvider ### Description This is the interface that is implemented by apps that implement a text processing provider. ### Methods Implementations of this interface define the core functionality of a text processing provider. ``` -------------------------------- ### IManager Source: https://nextcloud-server.netlify.app/namespaces/ocp-calendar Provides access to the Nextcloud CalDAV backend. This class is central to interacting with calendar data. ```APIDOC ## Interface IManager ### Description This class provides access to the Nextcloud CalDAV backend. ### Interface ` ocp-calendar.IManager ` ``` -------------------------------- ### ICloudFederationProvider Source: https://nextcloud-server.netlify.app/namespaces/ocp-federation Interface for federation providers. ```APIDOC ## Interface ICloudFederationProvider ### Description Interface for federation providers. ### Methods (No specific methods documented in the source) ``` -------------------------------- ### ICreateFromString Source: https://nextcloud-server.netlify.app/namespaces/ocp-calendar Extends the current ICalendar interface to add a public write method. ```APIDOC ## Interface ICreateFromString ### Description Extends the current ICalendar interface to add a public write method. ### Interface ` ocp-calendar.ICreateFromString ` ``` -------------------------------- ### IProviderWithId Interface Source: https://nextcloud-server.netlify.app/namespaces/ocp-textprocessing This is the interface that is implemented by apps that implement a text processing provider. ```APIDOC ## Interface: IProviderWithId ### Description This is the interface that is implemented by apps that implement a text processing provider. ### Methods This interface likely includes methods for identifying the text processing provider. ``` -------------------------------- ### OCMCapabilities Source: https://nextcloud-server.netlify.app/namespaces/ocp-ocm An immutable representation of an OCM provider's capabilities. ```APIDOC ## Class OCMCapabilities ### Description Immutable representation of an OCM provider's capabilities. ### Usage This class is used to hold and access the capabilities advertised by an OCM provider. ### Properties (Specific properties are not detailed in the source, but it is described as an immutable representation.) ``` -------------------------------- ### ICloudFederationFactory Source: https://nextcloud-server.netlify.app/namespaces/ocp-federation Interface for creating and managing federation-related objects. ```APIDOC ## Interface ICloudFederationFactory ### Description Interface for creating and managing federation-related objects. ### Methods (No specific methods documented in the source) ``` -------------------------------- ### BackendTemporarilyUnavailableException Source: https://nextcloud-server.netlify.app/namespaces/ocp-calendar Exception class for when the backend is temporarily unavailable. ```APIDOC ## Class BackendTemporarilyUnavailableException ### Description Exception class for when the backend is temporarily unavailable. ### Class ` ocp-calendar.BackendTemporarilyUnavailableException ` ``` -------------------------------- ### ICalendarQuery Source: https://nextcloud-server.netlify.app/namespaces/ocp-calendar Build a flexible, extendable query to the CalDAV backend. ```APIDOC ## Interface ICalendarQuery ### Description Build a flexible, extendable query to the CalDAV backend. ### Interface ` ocp-calendar.ICalendarQuery ` ``` -------------------------------- ### IProviderWithUserId Interface Source: https://nextcloud-server.netlify.app/namespaces/ocp-textprocessing This interface allows providers to access the user that initiated the task being run. ```APIDOC ## Interface: IProviderWithUserId ### Description This interface allows providers to access the user that initiated the task being run. ### Methods Enables text processing providers to access user-specific information related to the task. ``` -------------------------------- ### ISignedCloudFederationProvider Source: https://nextcloud-server.netlify.app/namespaces/ocp-federation Interface for signed federation providers, extending ICloudFederationProvider. ```APIDOC ## Interface ISignedCloudFederationProvider ### Description Interface for signed federation providers, extending ICloudFederationProvider. ### Methods (No specific methods documented in the source) ``` -------------------------------- ### Task Class Source: https://nextcloud-server.netlify.app/namespaces/ocp-textprocessing This is a text processing task. ```APIDOC ## Class: Task ### Description This is a text processing task. ### Methods Represents a generic text processing task, likely serving as a base class or a fundamental unit for operations. ``` -------------------------------- ### ICrypto Source: https://nextcloud-server.netlify.app/namespaces/ocp-security Interface for high-level encryption using AES-CBC with HMAC. ```APIDOC ## Interface ICrypto ### Description 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. ### Interface \OCP\Security\ICrypto ``` -------------------------------- ### FreePromptTaskType Class Source: https://nextcloud-server.netlify.app/namespaces/ocp-textprocessing This is the text processing task type for free prompting. ```APIDOC ## Class: FreePromptTaskType ### Description This is the text processing task type for free prompting. ### Methods Represents a task type specifically for free-form text generation or prompting. ``` -------------------------------- ### CalendarExportOptions Source: https://nextcloud-server.netlify.app/namespaces/ocp-calendar Represents options for exporting calendar data. ```APIDOC ## Class CalendarExportOptions ### Description Calendar Export Options. ### Class ` ocp-calendar.CalendarExportOptions ` ``` -------------------------------- ### IOCMDiscoveryService Source: https://nextcloud-server.netlify.app/namespaces/ocp-ocm Service responsible for discovering remote OCM services. ```APIDOC ## Interface IOCMDiscoveryService ### Description Discover remote OCM services. ### Usage This service is used to find and interact with other OCM-enabled services within the mesh. ### Methods (Specific methods for discovery are not detailed in the source.) ``` -------------------------------- ### IMailer Source: https://nextcloud-server.netlify.app/namespaces/ocp-mail Provides basic functions to create a mail message. ```APIDOC ## IMailer ### Description Class IMailer provides some basic functions to create a mail message that can be used in combination with \OC\Mail\Message. ### Class IMailer ``` -------------------------------- ### ICloudIdResolver Source: https://nextcloud-server.netlify.app/namespaces/ocp-federation Interface for resolving federated cloud IDs. ```APIDOC ## Interface ICloudIdResolver ### Description Interface for resolving federated cloud ids. ### Methods (No specific methods documented in the source) ``` -------------------------------- ### IContentSecurityPolicyManager Source: https://nextcloud-server.netlify.app/namespaces/ocp-security Interface for managing Content Security Policy (CSP) settings. ```APIDOC ## Interface IContentSecurityPolicyManager ### Description Used for Content Security Policy manipulations. ### Interface \OCP\Security\IContentSecurityPolicyManager ``` -------------------------------- ### ITrustedDomainHelper Source: https://nextcloud-server.netlify.app/namespaces/ocp-security Interface for checking domains and URLs against trusted domains. ```APIDOC ## Interface ITrustedDomainHelper ### Description Allows checking domains and full URLs against the list of trusted domains for this server in the config file. ### Interface \OCP\Security\ITrustedDomainHelper ``` -------------------------------- ### ISecureRandom Source: https://nextcloud-server.netlify.app/namespaces/ocp-security Interface for generating secure random strings using native CSPRNG or a fallback. ```APIDOC ## Interface ISecureRandom ### Description 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. ### Interface \OCP\Security\ISecureRandom ``` -------------------------------- ### logger() Source: https://nextcloud-server.netlify.app/packages/application Retrieves a PSR logger instance. It is recommended to inject a logger into classes whenever possible. This function should not be cached as the logger implementation might change. ```APIDOC ## logger() ### Description Get a PSR logger. Whenever possible, inject a logger into your classes instead of relying on this helper function. ### Method `logger([string|null $appId = null]): LoggerInterface` ### Parameters #### Path Parameters * **appId** (string|null) - Optional - 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 ``` -------------------------------- ### ICloudFederationShare Source: https://nextcloud-server.netlify.app/namespaces/ocp-federation Interface for managing federated shares. ```APIDOC ## Interface ICloudFederationShare ### Description Interface for managing federated shares. ### Methods (No specific methods documented in the source) ``` -------------------------------- ### HeadlineTaskType Class Source: https://nextcloud-server.netlify.app/namespaces/ocp-textprocessing This is the text processing task type for creating headlines. ```APIDOC ## Class: HeadlineTaskType ### Description This is the text processing task type for creating headlines. ### Methods Represents a task type focused on generating headlines from given text. ```