@@ -63,536 +63,536 @@ |
||
| 63 | 63 | */ |
| 64 | 64 | interface IServerContainer extends IContainer { |
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * The calendar manager will act as a broker between consumers for calendar information and |
|
| 68 | - * providers which actual deliver the calendar information. |
|
| 69 | - * |
|
| 70 | - * @return \OCP\Calendar\IManager |
|
| 71 | - * @since 13.0.0 |
|
| 72 | - */ |
|
| 73 | - public function getCalendarManager(); |
|
| 74 | - |
|
| 75 | - /** |
|
| 76 | - * The calendar resource backend manager will act as a broker between consumers |
|
| 77 | - * for calendar resource information an providers which actual deliver the room information. |
|
| 78 | - * |
|
| 79 | - * @return \OCP\Calendar\Resource\IBackend |
|
| 80 | - * @since 14.0.0 |
|
| 81 | - */ |
|
| 82 | - public function getCalendarResourceBackendManager(); |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * The calendar room backend manager will act as a broker between consumers |
|
| 86 | - * for calendar room information an providers which actual deliver the room information. |
|
| 87 | - * |
|
| 88 | - * @return \OCP\Calendar\Room\IBackend |
|
| 89 | - * @since 14.0.0 |
|
| 90 | - */ |
|
| 91 | - public function getCalendarRoomBackendManager(); |
|
| 92 | - |
|
| 93 | - /** |
|
| 94 | - * The contacts manager will act as a broker between consumers for contacts information and |
|
| 95 | - * providers which actual deliver the contact information. |
|
| 96 | - * |
|
| 97 | - * @return \OCP\Contacts\IManager |
|
| 98 | - * @since 6.0.0 |
|
| 99 | - */ |
|
| 100 | - public function getContactsManager(); |
|
| 101 | - |
|
| 102 | - /** |
|
| 103 | - * The current request object holding all information about the request currently being processed |
|
| 104 | - * is returned from this method. |
|
| 105 | - * In case the current execution was not initiated by a web request null is returned |
|
| 106 | - * |
|
| 107 | - * @return \OCP\IRequest |
|
| 108 | - * @since 6.0.0 |
|
| 109 | - */ |
|
| 110 | - public function getRequest(); |
|
| 111 | - |
|
| 112 | - /** |
|
| 113 | - * Returns the preview manager which can create preview images for a given file |
|
| 114 | - * |
|
| 115 | - * @return \OCP\IPreview |
|
| 116 | - * @since 6.0.0 |
|
| 117 | - */ |
|
| 118 | - public function getPreviewManager(); |
|
| 119 | - |
|
| 120 | - /** |
|
| 121 | - * Returns the tag manager which can get and set tags for different object types |
|
| 122 | - * |
|
| 123 | - * @see \OCP\ITagManager::load() |
|
| 124 | - * @return \OCP\ITagManager |
|
| 125 | - * @since 6.0.0 |
|
| 126 | - */ |
|
| 127 | - public function getTagManager(); |
|
| 128 | - |
|
| 129 | - /** |
|
| 130 | - * Returns the root folder of ownCloud's data directory |
|
| 131 | - * |
|
| 132 | - * @return \OCP\Files\IRootFolder |
|
| 133 | - * @since 6.0.0 - between 6.0.0 and 8.0.0 this returned \OCP\Files\Folder |
|
| 134 | - */ |
|
| 135 | - public function getRootFolder(); |
|
| 136 | - |
|
| 137 | - /** |
|
| 138 | - * Returns a view to ownCloud's files folder |
|
| 139 | - * |
|
| 140 | - * @param string $userId user ID |
|
| 141 | - * @return \OCP\Files\Folder |
|
| 142 | - * @since 6.0.0 - parameter $userId was added in 8.0.0 |
|
| 143 | - * @see getUserFolder in \OCP\Files\IRootFolder |
|
| 144 | - */ |
|
| 145 | - public function getUserFolder($userId = null); |
|
| 146 | - |
|
| 147 | - /** |
|
| 148 | - * Returns an app-specific view in ownClouds data directory |
|
| 149 | - * |
|
| 150 | - * @return \OCP\Files\Folder |
|
| 151 | - * @since 6.0.0 |
|
| 152 | - * @deprecated 9.2.0 use IAppData |
|
| 153 | - */ |
|
| 154 | - public function getAppFolder(); |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * Returns a user manager |
|
| 158 | - * |
|
| 159 | - * @return \OCP\IUserManager |
|
| 160 | - * @since 8.0.0 |
|
| 161 | - */ |
|
| 162 | - public function getUserManager(); |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * Returns a group manager |
|
| 166 | - * |
|
| 167 | - * @return \OCP\IGroupManager |
|
| 168 | - * @since 8.0.0 |
|
| 169 | - */ |
|
| 170 | - public function getGroupManager(); |
|
| 171 | - |
|
| 172 | - /** |
|
| 173 | - * Returns the user session |
|
| 174 | - * |
|
| 175 | - * @return \OCP\IUserSession |
|
| 176 | - * @since 6.0.0 |
|
| 177 | - */ |
|
| 178 | - public function getUserSession(); |
|
| 179 | - |
|
| 180 | - /** |
|
| 181 | - * Returns the navigation manager |
|
| 182 | - * |
|
| 183 | - * @return \OCP\INavigationManager |
|
| 184 | - * @since 6.0.0 |
|
| 185 | - */ |
|
| 186 | - public function getNavigationManager(); |
|
| 187 | - |
|
| 188 | - /** |
|
| 189 | - * Returns the config manager |
|
| 190 | - * |
|
| 191 | - * @return \OCP\IConfig |
|
| 192 | - * @since 6.0.0 |
|
| 193 | - */ |
|
| 194 | - public function getConfig(); |
|
| 195 | - |
|
| 196 | - /** |
|
| 197 | - * Returns a Crypto instance |
|
| 198 | - * |
|
| 199 | - * @return \OCP\Security\ICrypto |
|
| 200 | - * @since 8.0.0 |
|
| 201 | - */ |
|
| 202 | - public function getCrypto(); |
|
| 203 | - |
|
| 204 | - /** |
|
| 205 | - * Returns a Hasher instance |
|
| 206 | - * |
|
| 207 | - * @return \OCP\Security\IHasher |
|
| 208 | - * @since 8.0.0 |
|
| 209 | - */ |
|
| 210 | - public function getHasher(); |
|
| 211 | - |
|
| 212 | - /** |
|
| 213 | - * Returns a SecureRandom instance |
|
| 214 | - * |
|
| 215 | - * @return \OCP\Security\ISecureRandom |
|
| 216 | - * @since 8.1.0 |
|
| 217 | - */ |
|
| 218 | - public function getSecureRandom(); |
|
| 219 | - |
|
| 220 | - /** |
|
| 221 | - * Returns a CredentialsManager instance |
|
| 222 | - * |
|
| 223 | - * @return \OCP\Security\ICredentialsManager |
|
| 224 | - * @since 9.0.0 |
|
| 225 | - */ |
|
| 226 | - public function getCredentialsManager(); |
|
| 227 | - |
|
| 228 | - /** |
|
| 229 | - * Returns the app config manager |
|
| 230 | - * |
|
| 231 | - * @return \OCP\IAppConfig |
|
| 232 | - * @since 7.0.0 |
|
| 233 | - */ |
|
| 234 | - public function getAppConfig(); |
|
| 235 | - |
|
| 236 | - /** |
|
| 237 | - * @return \OCP\L10N\IFactory |
|
| 238 | - * @since 8.2.0 |
|
| 239 | - */ |
|
| 240 | - public function getL10NFactory(); |
|
| 241 | - |
|
| 242 | - /** |
|
| 243 | - * get an L10N instance |
|
| 244 | - * @param string $app appid |
|
| 245 | - * @param string $lang |
|
| 246 | - * @return \OCP\IL10N |
|
| 247 | - * @since 6.0.0 - parameter $lang was added in 8.0.0 |
|
| 248 | - */ |
|
| 249 | - public function getL10N($app, $lang = null); |
|
| 250 | - |
|
| 251 | - /** |
|
| 252 | - * @return \OC\Encryption\Manager |
|
| 253 | - * @since 8.1.0 |
|
| 254 | - */ |
|
| 255 | - public function getEncryptionManager(); |
|
| 256 | - |
|
| 257 | - /** |
|
| 258 | - * @return \OC\Encryption\File |
|
| 259 | - * @since 8.1.0 |
|
| 260 | - */ |
|
| 261 | - public function getEncryptionFilesHelper(); |
|
| 262 | - |
|
| 263 | - /** |
|
| 264 | - * @return \OCP\Encryption\Keys\IStorage |
|
| 265 | - * @since 8.1.0 |
|
| 266 | - */ |
|
| 267 | - public function getEncryptionKeyStorage(); |
|
| 268 | - |
|
| 269 | - /** |
|
| 270 | - * Returns the URL generator |
|
| 271 | - * |
|
| 272 | - * @return \OCP\IURLGenerator |
|
| 273 | - * @since 6.0.0 |
|
| 274 | - */ |
|
| 275 | - public function getURLGenerator(); |
|
| 276 | - |
|
| 277 | - /** |
|
| 278 | - * Returns an ICache instance |
|
| 279 | - * |
|
| 280 | - * @return \OCP\ICache |
|
| 281 | - * @since 6.0.0 |
|
| 282 | - */ |
|
| 283 | - public function getCache(); |
|
| 284 | - |
|
| 285 | - /** |
|
| 286 | - * Returns an \OCP\CacheFactory instance |
|
| 287 | - * |
|
| 288 | - * @return \OCP\ICacheFactory |
|
| 289 | - * @since 7.0.0 |
|
| 290 | - */ |
|
| 291 | - public function getMemCacheFactory(); |
|
| 292 | - |
|
| 293 | - /** |
|
| 294 | - * Returns the current session |
|
| 295 | - * |
|
| 296 | - * @return \OCP\ISession |
|
| 297 | - * @since 6.0.0 |
|
| 298 | - */ |
|
| 299 | - public function getSession(); |
|
| 300 | - |
|
| 301 | - /** |
|
| 302 | - * Returns the activity manager |
|
| 303 | - * |
|
| 304 | - * @return \OCP\Activity\IManager |
|
| 305 | - * @since 6.0.0 |
|
| 306 | - */ |
|
| 307 | - public function getActivityManager(); |
|
| 308 | - |
|
| 309 | - /** |
|
| 310 | - * Returns the current session |
|
| 311 | - * |
|
| 312 | - * @return \OCP\IDBConnection |
|
| 313 | - * @since 6.0.0 |
|
| 314 | - */ |
|
| 315 | - public function getDatabaseConnection(); |
|
| 316 | - |
|
| 317 | - /** |
|
| 318 | - * Returns an avatar manager, used for avatar functionality |
|
| 319 | - * |
|
| 320 | - * @return \OCP\IAvatarManager |
|
| 321 | - * @since 6.0.0 |
|
| 322 | - */ |
|
| 323 | - public function getAvatarManager(); |
|
| 324 | - |
|
| 325 | - /** |
|
| 326 | - * Returns an job list for controlling background jobs |
|
| 327 | - * |
|
| 328 | - * @return \OCP\BackgroundJob\IJobList |
|
| 329 | - * @since 7.0.0 |
|
| 330 | - */ |
|
| 331 | - public function getJobList(); |
|
| 332 | - |
|
| 333 | - /** |
|
| 334 | - * Returns a logger instance |
|
| 335 | - * |
|
| 336 | - * @return \OCP\ILogger |
|
| 337 | - * @since 8.0.0 |
|
| 338 | - */ |
|
| 339 | - public function getLogger(); |
|
| 340 | - |
|
| 341 | - /** |
|
| 342 | - * returns a log factory instance |
|
| 343 | - * |
|
| 344 | - * @return ILogFactory |
|
| 345 | - * @since 14.0.0 |
|
| 346 | - */ |
|
| 347 | - public function getLogFactory(); |
|
| 348 | - |
|
| 349 | - /** |
|
| 350 | - * Returns a router for generating and matching urls |
|
| 351 | - * |
|
| 352 | - * @return \OCP\Route\IRouter |
|
| 353 | - * @since 7.0.0 |
|
| 354 | - */ |
|
| 355 | - public function getRouter(); |
|
| 356 | - |
|
| 357 | - /** |
|
| 358 | - * Returns a search instance |
|
| 359 | - * |
|
| 360 | - * @return \OCP\ISearch |
|
| 361 | - * @since 7.0.0 |
|
| 362 | - */ |
|
| 363 | - public function getSearch(); |
|
| 364 | - |
|
| 365 | - /** |
|
| 366 | - * Get the certificate manager for the user |
|
| 367 | - * |
|
| 368 | - * @param string $userId (optional) if not specified the current loggedin user is used, use null to get the system certificate manager |
|
| 369 | - * @return \OCP\ICertificateManager | null if $userId is null and no user is logged in |
|
| 370 | - * @since 8.0.0 |
|
| 371 | - */ |
|
| 372 | - public function getCertificateManager($userId = null); |
|
| 373 | - |
|
| 374 | - /** |
|
| 375 | - * Create a new event source |
|
| 376 | - * |
|
| 377 | - * @return \OCP\IEventSource |
|
| 378 | - * @since 8.0.0 |
|
| 379 | - */ |
|
| 380 | - public function createEventSource(); |
|
| 381 | - |
|
| 382 | - /** |
|
| 383 | - * Returns an instance of the HTTP client service |
|
| 384 | - * |
|
| 385 | - * @return \OCP\Http\Client\IClientService |
|
| 386 | - * @since 8.1.0 |
|
| 387 | - */ |
|
| 388 | - public function getHTTPClientService(); |
|
| 389 | - |
|
| 390 | - /** |
|
| 391 | - * Get the active event logger |
|
| 392 | - * |
|
| 393 | - * @return \OCP\Diagnostics\IEventLogger |
|
| 394 | - * @since 8.0.0 |
|
| 395 | - */ |
|
| 396 | - public function getEventLogger(); |
|
| 397 | - |
|
| 398 | - /** |
|
| 399 | - * Get the active query logger |
|
| 400 | - * |
|
| 401 | - * The returned logger only logs data when debug mode is enabled |
|
| 402 | - * |
|
| 403 | - * @return \OCP\Diagnostics\IQueryLogger |
|
| 404 | - * @since 8.0.0 |
|
| 405 | - */ |
|
| 406 | - public function getQueryLogger(); |
|
| 407 | - |
|
| 408 | - /** |
|
| 409 | - * Get the manager for temporary files and folders |
|
| 410 | - * |
|
| 411 | - * @return \OCP\ITempManager |
|
| 412 | - * @since 8.0.0 |
|
| 413 | - */ |
|
| 414 | - public function getTempManager(); |
|
| 415 | - |
|
| 416 | - /** |
|
| 417 | - * Get the app manager |
|
| 418 | - * |
|
| 419 | - * @return \OCP\App\IAppManager |
|
| 420 | - * @since 8.0.0 |
|
| 421 | - */ |
|
| 422 | - public function getAppManager(); |
|
| 423 | - |
|
| 424 | - /** |
|
| 425 | - * Get the webroot |
|
| 426 | - * |
|
| 427 | - * @return string |
|
| 428 | - * @since 8.0.0 |
|
| 429 | - */ |
|
| 430 | - public function getWebRoot(); |
|
| 431 | - |
|
| 432 | - /** |
|
| 433 | - * @return \OCP\Files\Config\IMountProviderCollection |
|
| 434 | - * @since 8.0.0 |
|
| 435 | - */ |
|
| 436 | - public function getMountProviderCollection(); |
|
| 437 | - |
|
| 438 | - /** |
|
| 439 | - * Get the IniWrapper |
|
| 440 | - * |
|
| 441 | - * @return \bantu\IniGetWrapper\IniGetWrapper |
|
| 442 | - * @since 8.0.0 |
|
| 443 | - */ |
|
| 444 | - public function getIniWrapper(); |
|
| 445 | - /** |
|
| 446 | - * @return \OCP\Command\IBus |
|
| 447 | - * @since 8.1.0 |
|
| 448 | - */ |
|
| 449 | - public function getCommandBus(); |
|
| 450 | - |
|
| 451 | - /** |
|
| 452 | - * Creates a new mailer |
|
| 453 | - * |
|
| 454 | - * @return \OCP\Mail\IMailer |
|
| 455 | - * @since 8.1.0 |
|
| 456 | - */ |
|
| 457 | - public function getMailer(); |
|
| 458 | - |
|
| 459 | - /** |
|
| 460 | - * Get the locking provider |
|
| 461 | - * |
|
| 462 | - * @return \OCP\Lock\ILockingProvider |
|
| 463 | - * @since 8.1.0 |
|
| 464 | - */ |
|
| 465 | - public function getLockingProvider(); |
|
| 466 | - |
|
| 467 | - /** |
|
| 468 | - * @return \OCP\Files\Mount\IMountManager |
|
| 469 | - * @since 8.2.0 |
|
| 470 | - */ |
|
| 471 | - public function getMountManager(); |
|
| 472 | - |
|
| 473 | - /** |
|
| 474 | - * Get the MimeTypeDetector |
|
| 475 | - * |
|
| 476 | - * @return \OCP\Files\IMimeTypeDetector |
|
| 477 | - * @since 8.2.0 |
|
| 478 | - */ |
|
| 479 | - public function getMimeTypeDetector(); |
|
| 480 | - |
|
| 481 | - /** |
|
| 482 | - * Get the MimeTypeLoader |
|
| 483 | - * |
|
| 484 | - * @return \OCP\Files\IMimeTypeLoader |
|
| 485 | - * @since 8.2.0 |
|
| 486 | - */ |
|
| 487 | - public function getMimeTypeLoader(); |
|
| 488 | - |
|
| 489 | - /** |
|
| 490 | - * Get the EventDispatcher |
|
| 491 | - * |
|
| 492 | - * @return EventDispatcherInterface |
|
| 493 | - * @deprecated 20.0.0 use \OCP\EventDispatcher\IEventDispatcher |
|
| 494 | - * @since 8.2.0 |
|
| 495 | - */ |
|
| 496 | - public function getEventDispatcher(); |
|
| 497 | - |
|
| 498 | - /** |
|
| 499 | - * Get the Notification Manager |
|
| 500 | - * |
|
| 501 | - * @return \OCP\Notification\IManager |
|
| 502 | - * @since 9.0.0 |
|
| 503 | - */ |
|
| 504 | - public function getNotificationManager(); |
|
| 505 | - |
|
| 506 | - /** |
|
| 507 | - * @return \OCP\Comments\ICommentsManager |
|
| 508 | - * @since 9.0.0 |
|
| 509 | - */ |
|
| 510 | - public function getCommentsManager(); |
|
| 511 | - |
|
| 512 | - /** |
|
| 513 | - * Returns the system-tag manager |
|
| 514 | - * |
|
| 515 | - * @return \OCP\SystemTag\ISystemTagManager |
|
| 516 | - * |
|
| 517 | - * @since 9.0.0 |
|
| 518 | - */ |
|
| 519 | - public function getSystemTagManager(); |
|
| 520 | - |
|
| 521 | - /** |
|
| 522 | - * Returns the system-tag object mapper |
|
| 523 | - * |
|
| 524 | - * @return \OCP\SystemTag\ISystemTagObjectMapper |
|
| 525 | - * |
|
| 526 | - * @since 9.0.0 |
|
| 527 | - */ |
|
| 528 | - public function getSystemTagObjectMapper(); |
|
| 529 | - |
|
| 530 | - /** |
|
| 531 | - * Returns the share manager |
|
| 532 | - * |
|
| 533 | - * @return \OCP\Share\IManager |
|
| 534 | - * @since 9.0.0 |
|
| 535 | - */ |
|
| 536 | - public function getShareManager(); |
|
| 537 | - |
|
| 538 | - /** |
|
| 539 | - * @return IContentSecurityPolicyManager |
|
| 540 | - * @since 9.0.0 |
|
| 541 | - * @deprecated 17.0.0 Use the AddContentSecurityPolicyEvent |
|
| 542 | - */ |
|
| 543 | - public function getContentSecurityPolicyManager(); |
|
| 544 | - |
|
| 545 | - /** |
|
| 546 | - * @return \OCP\IDateTimeZone |
|
| 547 | - * @since 8.0.0 |
|
| 548 | - */ |
|
| 549 | - public function getDateTimeZone(); |
|
| 550 | - |
|
| 551 | - /** |
|
| 552 | - * @return \OCP\IDateTimeFormatter |
|
| 553 | - * @since 8.0.0 |
|
| 554 | - */ |
|
| 555 | - public function getDateTimeFormatter(); |
|
| 556 | - |
|
| 557 | - /** |
|
| 558 | - * @return \OCP\Federation\ICloudIdManager |
|
| 559 | - * @since 12.0.0 |
|
| 560 | - */ |
|
| 561 | - public function getCloudIdManager(); |
|
| 562 | - |
|
| 563 | - /** |
|
| 564 | - * @return \OCP\GlobalScale\IConfig |
|
| 565 | - * @since 14.0.0 |
|
| 566 | - */ |
|
| 567 | - public function getGlobalScaleConfig(); |
|
| 568 | - |
|
| 569 | - /** |
|
| 570 | - * @return ICloudFederationFactory |
|
| 571 | - * @since 14.0.0 |
|
| 572 | - */ |
|
| 573 | - public function getCloudFederationFactory(); |
|
| 574 | - |
|
| 575 | - /** |
|
| 576 | - * @return ICloudFederationProviderManager |
|
| 577 | - * @since 14.0.0 |
|
| 578 | - */ |
|
| 579 | - public function getCloudFederationProviderManager(); |
|
| 580 | - |
|
| 581 | - /** |
|
| 582 | - * @return \OCP\Remote\Api\IApiFactory |
|
| 583 | - * @since 13.0.0 |
|
| 584 | - */ |
|
| 585 | - public function getRemoteApiFactory(); |
|
| 586 | - |
|
| 587 | - /** |
|
| 588 | - * @return \OCP\Remote\IInstanceFactory |
|
| 589 | - * @since 13.0.0 |
|
| 590 | - */ |
|
| 591 | - public function getRemoteInstanceFactory(); |
|
| 592 | - |
|
| 593 | - /** |
|
| 594 | - * @return \OCP\Files\Storage\IStorageFactory |
|
| 595 | - * @since 15.0.0 |
|
| 596 | - */ |
|
| 597 | - public function getStorageFactory(); |
|
| 66 | + /** |
|
| 67 | + * The calendar manager will act as a broker between consumers for calendar information and |
|
| 68 | + * providers which actual deliver the calendar information. |
|
| 69 | + * |
|
| 70 | + * @return \OCP\Calendar\IManager |
|
| 71 | + * @since 13.0.0 |
|
| 72 | + */ |
|
| 73 | + public function getCalendarManager(); |
|
| 74 | + |
|
| 75 | + /** |
|
| 76 | + * The calendar resource backend manager will act as a broker between consumers |
|
| 77 | + * for calendar resource information an providers which actual deliver the room information. |
|
| 78 | + * |
|
| 79 | + * @return \OCP\Calendar\Resource\IBackend |
|
| 80 | + * @since 14.0.0 |
|
| 81 | + */ |
|
| 82 | + public function getCalendarResourceBackendManager(); |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * The calendar room backend manager will act as a broker between consumers |
|
| 86 | + * for calendar room information an providers which actual deliver the room information. |
|
| 87 | + * |
|
| 88 | + * @return \OCP\Calendar\Room\IBackend |
|
| 89 | + * @since 14.0.0 |
|
| 90 | + */ |
|
| 91 | + public function getCalendarRoomBackendManager(); |
|
| 92 | + |
|
| 93 | + /** |
|
| 94 | + * The contacts manager will act as a broker between consumers for contacts information and |
|
| 95 | + * providers which actual deliver the contact information. |
|
| 96 | + * |
|
| 97 | + * @return \OCP\Contacts\IManager |
|
| 98 | + * @since 6.0.0 |
|
| 99 | + */ |
|
| 100 | + public function getContactsManager(); |
|
| 101 | + |
|
| 102 | + /** |
|
| 103 | + * The current request object holding all information about the request currently being processed |
|
| 104 | + * is returned from this method. |
|
| 105 | + * In case the current execution was not initiated by a web request null is returned |
|
| 106 | + * |
|
| 107 | + * @return \OCP\IRequest |
|
| 108 | + * @since 6.0.0 |
|
| 109 | + */ |
|
| 110 | + public function getRequest(); |
|
| 111 | + |
|
| 112 | + /** |
|
| 113 | + * Returns the preview manager which can create preview images for a given file |
|
| 114 | + * |
|
| 115 | + * @return \OCP\IPreview |
|
| 116 | + * @since 6.0.0 |
|
| 117 | + */ |
|
| 118 | + public function getPreviewManager(); |
|
| 119 | + |
|
| 120 | + /** |
|
| 121 | + * Returns the tag manager which can get and set tags for different object types |
|
| 122 | + * |
|
| 123 | + * @see \OCP\ITagManager::load() |
|
| 124 | + * @return \OCP\ITagManager |
|
| 125 | + * @since 6.0.0 |
|
| 126 | + */ |
|
| 127 | + public function getTagManager(); |
|
| 128 | + |
|
| 129 | + /** |
|
| 130 | + * Returns the root folder of ownCloud's data directory |
|
| 131 | + * |
|
| 132 | + * @return \OCP\Files\IRootFolder |
|
| 133 | + * @since 6.0.0 - between 6.0.0 and 8.0.0 this returned \OCP\Files\Folder |
|
| 134 | + */ |
|
| 135 | + public function getRootFolder(); |
|
| 136 | + |
|
| 137 | + /** |
|
| 138 | + * Returns a view to ownCloud's files folder |
|
| 139 | + * |
|
| 140 | + * @param string $userId user ID |
|
| 141 | + * @return \OCP\Files\Folder |
|
| 142 | + * @since 6.0.0 - parameter $userId was added in 8.0.0 |
|
| 143 | + * @see getUserFolder in \OCP\Files\IRootFolder |
|
| 144 | + */ |
|
| 145 | + public function getUserFolder($userId = null); |
|
| 146 | + |
|
| 147 | + /** |
|
| 148 | + * Returns an app-specific view in ownClouds data directory |
|
| 149 | + * |
|
| 150 | + * @return \OCP\Files\Folder |
|
| 151 | + * @since 6.0.0 |
|
| 152 | + * @deprecated 9.2.0 use IAppData |
|
| 153 | + */ |
|
| 154 | + public function getAppFolder(); |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * Returns a user manager |
|
| 158 | + * |
|
| 159 | + * @return \OCP\IUserManager |
|
| 160 | + * @since 8.0.0 |
|
| 161 | + */ |
|
| 162 | + public function getUserManager(); |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * Returns a group manager |
|
| 166 | + * |
|
| 167 | + * @return \OCP\IGroupManager |
|
| 168 | + * @since 8.0.0 |
|
| 169 | + */ |
|
| 170 | + public function getGroupManager(); |
|
| 171 | + |
|
| 172 | + /** |
|
| 173 | + * Returns the user session |
|
| 174 | + * |
|
| 175 | + * @return \OCP\IUserSession |
|
| 176 | + * @since 6.0.0 |
|
| 177 | + */ |
|
| 178 | + public function getUserSession(); |
|
| 179 | + |
|
| 180 | + /** |
|
| 181 | + * Returns the navigation manager |
|
| 182 | + * |
|
| 183 | + * @return \OCP\INavigationManager |
|
| 184 | + * @since 6.0.0 |
|
| 185 | + */ |
|
| 186 | + public function getNavigationManager(); |
|
| 187 | + |
|
| 188 | + /** |
|
| 189 | + * Returns the config manager |
|
| 190 | + * |
|
| 191 | + * @return \OCP\IConfig |
|
| 192 | + * @since 6.0.0 |
|
| 193 | + */ |
|
| 194 | + public function getConfig(); |
|
| 195 | + |
|
| 196 | + /** |
|
| 197 | + * Returns a Crypto instance |
|
| 198 | + * |
|
| 199 | + * @return \OCP\Security\ICrypto |
|
| 200 | + * @since 8.0.0 |
|
| 201 | + */ |
|
| 202 | + public function getCrypto(); |
|
| 203 | + |
|
| 204 | + /** |
|
| 205 | + * Returns a Hasher instance |
|
| 206 | + * |
|
| 207 | + * @return \OCP\Security\IHasher |
|
| 208 | + * @since 8.0.0 |
|
| 209 | + */ |
|
| 210 | + public function getHasher(); |
|
| 211 | + |
|
| 212 | + /** |
|
| 213 | + * Returns a SecureRandom instance |
|
| 214 | + * |
|
| 215 | + * @return \OCP\Security\ISecureRandom |
|
| 216 | + * @since 8.1.0 |
|
| 217 | + */ |
|
| 218 | + public function getSecureRandom(); |
|
| 219 | + |
|
| 220 | + /** |
|
| 221 | + * Returns a CredentialsManager instance |
|
| 222 | + * |
|
| 223 | + * @return \OCP\Security\ICredentialsManager |
|
| 224 | + * @since 9.0.0 |
|
| 225 | + */ |
|
| 226 | + public function getCredentialsManager(); |
|
| 227 | + |
|
| 228 | + /** |
|
| 229 | + * Returns the app config manager |
|
| 230 | + * |
|
| 231 | + * @return \OCP\IAppConfig |
|
| 232 | + * @since 7.0.0 |
|
| 233 | + */ |
|
| 234 | + public function getAppConfig(); |
|
| 235 | + |
|
| 236 | + /** |
|
| 237 | + * @return \OCP\L10N\IFactory |
|
| 238 | + * @since 8.2.0 |
|
| 239 | + */ |
|
| 240 | + public function getL10NFactory(); |
|
| 241 | + |
|
| 242 | + /** |
|
| 243 | + * get an L10N instance |
|
| 244 | + * @param string $app appid |
|
| 245 | + * @param string $lang |
|
| 246 | + * @return \OCP\IL10N |
|
| 247 | + * @since 6.0.0 - parameter $lang was added in 8.0.0 |
|
| 248 | + */ |
|
| 249 | + public function getL10N($app, $lang = null); |
|
| 250 | + |
|
| 251 | + /** |
|
| 252 | + * @return \OC\Encryption\Manager |
|
| 253 | + * @since 8.1.0 |
|
| 254 | + */ |
|
| 255 | + public function getEncryptionManager(); |
|
| 256 | + |
|
| 257 | + /** |
|
| 258 | + * @return \OC\Encryption\File |
|
| 259 | + * @since 8.1.0 |
|
| 260 | + */ |
|
| 261 | + public function getEncryptionFilesHelper(); |
|
| 262 | + |
|
| 263 | + /** |
|
| 264 | + * @return \OCP\Encryption\Keys\IStorage |
|
| 265 | + * @since 8.1.0 |
|
| 266 | + */ |
|
| 267 | + public function getEncryptionKeyStorage(); |
|
| 268 | + |
|
| 269 | + /** |
|
| 270 | + * Returns the URL generator |
|
| 271 | + * |
|
| 272 | + * @return \OCP\IURLGenerator |
|
| 273 | + * @since 6.0.0 |
|
| 274 | + */ |
|
| 275 | + public function getURLGenerator(); |
|
| 276 | + |
|
| 277 | + /** |
|
| 278 | + * Returns an ICache instance |
|
| 279 | + * |
|
| 280 | + * @return \OCP\ICache |
|
| 281 | + * @since 6.0.0 |
|
| 282 | + */ |
|
| 283 | + public function getCache(); |
|
| 284 | + |
|
| 285 | + /** |
|
| 286 | + * Returns an \OCP\CacheFactory instance |
|
| 287 | + * |
|
| 288 | + * @return \OCP\ICacheFactory |
|
| 289 | + * @since 7.0.0 |
|
| 290 | + */ |
|
| 291 | + public function getMemCacheFactory(); |
|
| 292 | + |
|
| 293 | + /** |
|
| 294 | + * Returns the current session |
|
| 295 | + * |
|
| 296 | + * @return \OCP\ISession |
|
| 297 | + * @since 6.0.0 |
|
| 298 | + */ |
|
| 299 | + public function getSession(); |
|
| 300 | + |
|
| 301 | + /** |
|
| 302 | + * Returns the activity manager |
|
| 303 | + * |
|
| 304 | + * @return \OCP\Activity\IManager |
|
| 305 | + * @since 6.0.0 |
|
| 306 | + */ |
|
| 307 | + public function getActivityManager(); |
|
| 308 | + |
|
| 309 | + /** |
|
| 310 | + * Returns the current session |
|
| 311 | + * |
|
| 312 | + * @return \OCP\IDBConnection |
|
| 313 | + * @since 6.0.0 |
|
| 314 | + */ |
|
| 315 | + public function getDatabaseConnection(); |
|
| 316 | + |
|
| 317 | + /** |
|
| 318 | + * Returns an avatar manager, used for avatar functionality |
|
| 319 | + * |
|
| 320 | + * @return \OCP\IAvatarManager |
|
| 321 | + * @since 6.0.0 |
|
| 322 | + */ |
|
| 323 | + public function getAvatarManager(); |
|
| 324 | + |
|
| 325 | + /** |
|
| 326 | + * Returns an job list for controlling background jobs |
|
| 327 | + * |
|
| 328 | + * @return \OCP\BackgroundJob\IJobList |
|
| 329 | + * @since 7.0.0 |
|
| 330 | + */ |
|
| 331 | + public function getJobList(); |
|
| 332 | + |
|
| 333 | + /** |
|
| 334 | + * Returns a logger instance |
|
| 335 | + * |
|
| 336 | + * @return \OCP\ILogger |
|
| 337 | + * @since 8.0.0 |
|
| 338 | + */ |
|
| 339 | + public function getLogger(); |
|
| 340 | + |
|
| 341 | + /** |
|
| 342 | + * returns a log factory instance |
|
| 343 | + * |
|
| 344 | + * @return ILogFactory |
|
| 345 | + * @since 14.0.0 |
|
| 346 | + */ |
|
| 347 | + public function getLogFactory(); |
|
| 348 | + |
|
| 349 | + /** |
|
| 350 | + * Returns a router for generating and matching urls |
|
| 351 | + * |
|
| 352 | + * @return \OCP\Route\IRouter |
|
| 353 | + * @since 7.0.0 |
|
| 354 | + */ |
|
| 355 | + public function getRouter(); |
|
| 356 | + |
|
| 357 | + /** |
|
| 358 | + * Returns a search instance |
|
| 359 | + * |
|
| 360 | + * @return \OCP\ISearch |
|
| 361 | + * @since 7.0.0 |
|
| 362 | + */ |
|
| 363 | + public function getSearch(); |
|
| 364 | + |
|
| 365 | + /** |
|
| 366 | + * Get the certificate manager for the user |
|
| 367 | + * |
|
| 368 | + * @param string $userId (optional) if not specified the current loggedin user is used, use null to get the system certificate manager |
|
| 369 | + * @return \OCP\ICertificateManager | null if $userId is null and no user is logged in |
|
| 370 | + * @since 8.0.0 |
|
| 371 | + */ |
|
| 372 | + public function getCertificateManager($userId = null); |
|
| 373 | + |
|
| 374 | + /** |
|
| 375 | + * Create a new event source |
|
| 376 | + * |
|
| 377 | + * @return \OCP\IEventSource |
|
| 378 | + * @since 8.0.0 |
|
| 379 | + */ |
|
| 380 | + public function createEventSource(); |
|
| 381 | + |
|
| 382 | + /** |
|
| 383 | + * Returns an instance of the HTTP client service |
|
| 384 | + * |
|
| 385 | + * @return \OCP\Http\Client\IClientService |
|
| 386 | + * @since 8.1.0 |
|
| 387 | + */ |
|
| 388 | + public function getHTTPClientService(); |
|
| 389 | + |
|
| 390 | + /** |
|
| 391 | + * Get the active event logger |
|
| 392 | + * |
|
| 393 | + * @return \OCP\Diagnostics\IEventLogger |
|
| 394 | + * @since 8.0.0 |
|
| 395 | + */ |
|
| 396 | + public function getEventLogger(); |
|
| 397 | + |
|
| 398 | + /** |
|
| 399 | + * Get the active query logger |
|
| 400 | + * |
|
| 401 | + * The returned logger only logs data when debug mode is enabled |
|
| 402 | + * |
|
| 403 | + * @return \OCP\Diagnostics\IQueryLogger |
|
| 404 | + * @since 8.0.0 |
|
| 405 | + */ |
|
| 406 | + public function getQueryLogger(); |
|
| 407 | + |
|
| 408 | + /** |
|
| 409 | + * Get the manager for temporary files and folders |
|
| 410 | + * |
|
| 411 | + * @return \OCP\ITempManager |
|
| 412 | + * @since 8.0.0 |
|
| 413 | + */ |
|
| 414 | + public function getTempManager(); |
|
| 415 | + |
|
| 416 | + /** |
|
| 417 | + * Get the app manager |
|
| 418 | + * |
|
| 419 | + * @return \OCP\App\IAppManager |
|
| 420 | + * @since 8.0.0 |
|
| 421 | + */ |
|
| 422 | + public function getAppManager(); |
|
| 423 | + |
|
| 424 | + /** |
|
| 425 | + * Get the webroot |
|
| 426 | + * |
|
| 427 | + * @return string |
|
| 428 | + * @since 8.0.0 |
|
| 429 | + */ |
|
| 430 | + public function getWebRoot(); |
|
| 431 | + |
|
| 432 | + /** |
|
| 433 | + * @return \OCP\Files\Config\IMountProviderCollection |
|
| 434 | + * @since 8.0.0 |
|
| 435 | + */ |
|
| 436 | + public function getMountProviderCollection(); |
|
| 437 | + |
|
| 438 | + /** |
|
| 439 | + * Get the IniWrapper |
|
| 440 | + * |
|
| 441 | + * @return \bantu\IniGetWrapper\IniGetWrapper |
|
| 442 | + * @since 8.0.0 |
|
| 443 | + */ |
|
| 444 | + public function getIniWrapper(); |
|
| 445 | + /** |
|
| 446 | + * @return \OCP\Command\IBus |
|
| 447 | + * @since 8.1.0 |
|
| 448 | + */ |
|
| 449 | + public function getCommandBus(); |
|
| 450 | + |
|
| 451 | + /** |
|
| 452 | + * Creates a new mailer |
|
| 453 | + * |
|
| 454 | + * @return \OCP\Mail\IMailer |
|
| 455 | + * @since 8.1.0 |
|
| 456 | + */ |
|
| 457 | + public function getMailer(); |
|
| 458 | + |
|
| 459 | + /** |
|
| 460 | + * Get the locking provider |
|
| 461 | + * |
|
| 462 | + * @return \OCP\Lock\ILockingProvider |
|
| 463 | + * @since 8.1.0 |
|
| 464 | + */ |
|
| 465 | + public function getLockingProvider(); |
|
| 466 | + |
|
| 467 | + /** |
|
| 468 | + * @return \OCP\Files\Mount\IMountManager |
|
| 469 | + * @since 8.2.0 |
|
| 470 | + */ |
|
| 471 | + public function getMountManager(); |
|
| 472 | + |
|
| 473 | + /** |
|
| 474 | + * Get the MimeTypeDetector |
|
| 475 | + * |
|
| 476 | + * @return \OCP\Files\IMimeTypeDetector |
|
| 477 | + * @since 8.2.0 |
|
| 478 | + */ |
|
| 479 | + public function getMimeTypeDetector(); |
|
| 480 | + |
|
| 481 | + /** |
|
| 482 | + * Get the MimeTypeLoader |
|
| 483 | + * |
|
| 484 | + * @return \OCP\Files\IMimeTypeLoader |
|
| 485 | + * @since 8.2.0 |
|
| 486 | + */ |
|
| 487 | + public function getMimeTypeLoader(); |
|
| 488 | + |
|
| 489 | + /** |
|
| 490 | + * Get the EventDispatcher |
|
| 491 | + * |
|
| 492 | + * @return EventDispatcherInterface |
|
| 493 | + * @deprecated 20.0.0 use \OCP\EventDispatcher\IEventDispatcher |
|
| 494 | + * @since 8.2.0 |
|
| 495 | + */ |
|
| 496 | + public function getEventDispatcher(); |
|
| 497 | + |
|
| 498 | + /** |
|
| 499 | + * Get the Notification Manager |
|
| 500 | + * |
|
| 501 | + * @return \OCP\Notification\IManager |
|
| 502 | + * @since 9.0.0 |
|
| 503 | + */ |
|
| 504 | + public function getNotificationManager(); |
|
| 505 | + |
|
| 506 | + /** |
|
| 507 | + * @return \OCP\Comments\ICommentsManager |
|
| 508 | + * @since 9.0.0 |
|
| 509 | + */ |
|
| 510 | + public function getCommentsManager(); |
|
| 511 | + |
|
| 512 | + /** |
|
| 513 | + * Returns the system-tag manager |
|
| 514 | + * |
|
| 515 | + * @return \OCP\SystemTag\ISystemTagManager |
|
| 516 | + * |
|
| 517 | + * @since 9.0.0 |
|
| 518 | + */ |
|
| 519 | + public function getSystemTagManager(); |
|
| 520 | + |
|
| 521 | + /** |
|
| 522 | + * Returns the system-tag object mapper |
|
| 523 | + * |
|
| 524 | + * @return \OCP\SystemTag\ISystemTagObjectMapper |
|
| 525 | + * |
|
| 526 | + * @since 9.0.0 |
|
| 527 | + */ |
|
| 528 | + public function getSystemTagObjectMapper(); |
|
| 529 | + |
|
| 530 | + /** |
|
| 531 | + * Returns the share manager |
|
| 532 | + * |
|
| 533 | + * @return \OCP\Share\IManager |
|
| 534 | + * @since 9.0.0 |
|
| 535 | + */ |
|
| 536 | + public function getShareManager(); |
|
| 537 | + |
|
| 538 | + /** |
|
| 539 | + * @return IContentSecurityPolicyManager |
|
| 540 | + * @since 9.0.0 |
|
| 541 | + * @deprecated 17.0.0 Use the AddContentSecurityPolicyEvent |
|
| 542 | + */ |
|
| 543 | + public function getContentSecurityPolicyManager(); |
|
| 544 | + |
|
| 545 | + /** |
|
| 546 | + * @return \OCP\IDateTimeZone |
|
| 547 | + * @since 8.0.0 |
|
| 548 | + */ |
|
| 549 | + public function getDateTimeZone(); |
|
| 550 | + |
|
| 551 | + /** |
|
| 552 | + * @return \OCP\IDateTimeFormatter |
|
| 553 | + * @since 8.0.0 |
|
| 554 | + */ |
|
| 555 | + public function getDateTimeFormatter(); |
|
| 556 | + |
|
| 557 | + /** |
|
| 558 | + * @return \OCP\Federation\ICloudIdManager |
|
| 559 | + * @since 12.0.0 |
|
| 560 | + */ |
|
| 561 | + public function getCloudIdManager(); |
|
| 562 | + |
|
| 563 | + /** |
|
| 564 | + * @return \OCP\GlobalScale\IConfig |
|
| 565 | + * @since 14.0.0 |
|
| 566 | + */ |
|
| 567 | + public function getGlobalScaleConfig(); |
|
| 568 | + |
|
| 569 | + /** |
|
| 570 | + * @return ICloudFederationFactory |
|
| 571 | + * @since 14.0.0 |
|
| 572 | + */ |
|
| 573 | + public function getCloudFederationFactory(); |
|
| 574 | + |
|
| 575 | + /** |
|
| 576 | + * @return ICloudFederationProviderManager |
|
| 577 | + * @since 14.0.0 |
|
| 578 | + */ |
|
| 579 | + public function getCloudFederationProviderManager(); |
|
| 580 | + |
|
| 581 | + /** |
|
| 582 | + * @return \OCP\Remote\Api\IApiFactory |
|
| 583 | + * @since 13.0.0 |
|
| 584 | + */ |
|
| 585 | + public function getRemoteApiFactory(); |
|
| 586 | + |
|
| 587 | + /** |
|
| 588 | + * @return \OCP\Remote\IInstanceFactory |
|
| 589 | + * @since 13.0.0 |
|
| 590 | + */ |
|
| 591 | + public function getRemoteInstanceFactory(); |
|
| 592 | + |
|
| 593 | + /** |
|
| 594 | + * @return \OCP\Files\Storage\IStorageFactory |
|
| 595 | + * @since 15.0.0 |
|
| 596 | + */ |
|
| 597 | + public function getStorageFactory(); |
|
| 598 | 598 | } |