1
0

ISetting.php 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com>
  4. *
  5. * @author Joas Schilling <coding@schilljs.com>
  6. *
  7. * @license GNU AGPL version 3 or any later version
  8. *
  9. * This program is free software: you can redistribute it and/or modify
  10. * it under the terms of the GNU Affero General Public License as
  11. * published by the Free Software Foundation, either version 3 of the
  12. * License, or (at your option) any later version.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU Affero General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Affero General Public License
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  21. *
  22. */
  23. namespace OCP\Activity;
  24. /**
  25. * Interface ISetting
  26. *
  27. * @since 11.0.0
  28. */
  29. interface ISetting {
  30. /**
  31. * @return string Lowercase a-z and underscore only identifier
  32. * @since 11.0.0
  33. */
  34. public function getIdentifier();
  35. /**
  36. * @return string A translated string
  37. * @since 11.0.0
  38. */
  39. public function getName();
  40. /**
  41. * @return int whether the filter should be rather on the top or bottom of
  42. * the admin section. The filters are arranged in ascending order of the
  43. * priority values. It is required to return a value between 0 and 100.
  44. * @since 11.0.0
  45. */
  46. public function getPriority();
  47. /**
  48. * @return bool True when the option can be changed for the stream
  49. * @since 11.0.0
  50. */
  51. public function canChangeStream();
  52. /**
  53. * @return bool True when the option can be changed for the stream
  54. * @since 11.0.0
  55. */
  56. public function isDefaultEnabledStream();
  57. /**
  58. * @return bool True when the option can be changed for the mail
  59. * @since 11.0.0
  60. */
  61. public function canChangeMail();
  62. /**
  63. * @return bool True when the option can be changed for the stream
  64. * @since 11.0.0
  65. */
  66. public function isDefaultEnabledMail();
  67. }