polls/lib/ResponseDefinitions.php at 7a05136e0b694377c9d1a7b42b5428a70456c1b0 · artlog/polls · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCA\Polls;

/**
 * @psalm-type PollsPollPermissions = array {
 *  addOptions: boolean,
 *  reorderOptions: boolean,
 *  archive: boolean,
 *  comment: boolean,
 *  confirmOptions: boolean,
 *  delete: boolean,
 *  edit: boolean,
 *  seeResults: boolean,
 *  seeUsernames: boolean,
 *  subscribe: boolean,
 *  view: boolean,
 *  vote: boolean,
 * }
 *
 * @psalm-type PollsCurrentUserStatus = array {
 * 	userRole: string,
 *  isLocked: boolean,
 *  isInvolved: boolean,
 *  isLoggedIn: boolean,
 *  isNoUser: boolean,
 *  isOwner: boolean,
 *  userId: string,
 *  orphanedVotes: int,
 *  yesVotes: int,
 *  countVotes: int,
 *  shareToken: string,
 *  groupInvitations: string[],
 * }
 *
 * @psalm-type PollsPollsStatus = array {
 * 	lastInteraction: int,
 *  created: int,
 *  deleted: boolean,
 *  expired: boolean,
 *  relevantThreshold: int,
 *  countParticipants: int,
 * }
 *
 * @psalm-type PollsUser = array {
 *  array: string,
 *  categories?: string[],
 *  desc?: string,
 *  displayName: string,
 *  emailAddress?: string,
 * 	id: string,
 *  user?: string,
 *  isAdmin: boolean,
 *  isGuest: boolean,
 *  isNoUser: boolean,
 *  isUnrestrictedOwner: boolean,
 *  languageCode?: string,
 *  languageCodeIntl?: string,
 *  localeCode?: string,
 *  localeCodeIntl?: string,
 *  organisation?: string,
 *  subName?: string,
 *  subtitle?: string,
 *  timeZone?: string,
 *  type: string,
 *  userId: string,
 * }
 *
 * @psalm-type PollsPollConfiguration = array {
 * 	title: string,
 *  description: string,
 *  access: string,
 *  allowComment: boolean,
 *  allowMaybe: boolean,
 *  chosenRank: String,
 *  allowProposals: string,
 *  anonymous: boolean,
 *  autoReminder: boolean,
 *  expire: int,
 *  hideBookedUp: boolean,
 *  proposalsExpire: int,
 *  showResults: string,
 *  useNo: boolean,
 *  maxVotesPerOption: int,
 *  maxVotesPerUser: int,
 * }
 *
 * @psalm-type PollsPoll = array {
 *   id: int,
 *   type: string,
 *   descriptionSafe: string,
 *   configuration: PollsPollConfiguration,
 *   owner: PollsUser,
 *   status: PollsPollsStatus,
 *   currentUserStatus: PollsCurrentUserStatus,
 *   permissions: PollsPollPermissions,
 *   revealPartitians: boolean,
 * }
 * @psalm-suppress UnusedClass
 */
class ResponseDefinitions {
}