1
0

ResponseDefinitions.php 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2023 Kate Döen <kate.doeen@nextcloud.com>
  5. *
  6. * @author Kate Döen <kate.doeen@nextcloud.com>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCA\UserStatus;
  25. /**
  26. * @psalm-type UserStatusClearAtTimeType = "day"|"week"
  27. *
  28. * @psalm-type UserStatusClearAt = array{
  29. * type: "period"|"end-of",
  30. * time: int|UserStatusClearAtTimeType,
  31. * }
  32. *
  33. * @psalm-type UserStatusPredefined = array{
  34. * id: string,
  35. * icon: string,
  36. * message: string,
  37. * clearAt: ?UserStatusClearAt,
  38. * visible: ?bool,
  39. * }
  40. *
  41. * @psalm-type UserStatusType = "online"|"away"|"dnd"|"busy"|"offline"|"invisible"
  42. *
  43. * @psalm-type UserStatusPublic = array{
  44. * userId: string,
  45. * message: ?string,
  46. * icon: ?string,
  47. * clearAt: ?int,
  48. * status: UserStatusType,
  49. * }
  50. *
  51. * @psalm-type UserStatusPrivate = UserStatusPublic&array{
  52. * messageId: ?string,
  53. * messageIsPredefined: bool,
  54. * statusIsUserDefined: bool,
  55. * }
  56. */
  57. class ResponseDefinitions {
  58. }