ISetting.php 1.9 KB

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