summaryrefslogtreecommitdiffstats
path: root/src/models/circle.d.ts
blob: 25dc05369262437b185eea5df33f995d2ec872c5 (plain)
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/**
 * @copyright Copyright (c) 2021 John Molakvoæ <skjnldsv@protonmail.com>
 *
 * @author John Molakvoæ <skjnldsv@protonmail.com>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */
import Member from './member';
declare type MemberList = Record<string, Member>;
export default class Circle {
    _data: any;
    _members: MemberList;
    _owner: Member;
    _initiator: Member;
    /**
     * Creates an instance of Circle
     */
    constructor(data: Object);
    /**
     * Update inner circle data, owner and initiator
     */
    updateData(data: any): void;
    /**
     * Circle id
     */
    get id(): string;
    /**
     * Formatted display name
     */
    get displayName(): string;
    /**
     * Set the display name
     */
    set displayName(text: string);
    /**
     * Circle creation date
     */
    get creation(): number;
    /**
     * Circle description
     */
    get description(): string;
    /**
     * Circle description
     */
    set description(text: string);
    /**
     * Circle member count
     */
    get population(): any;
    /**
     * Circle ini_initiator the current
     * user info for this circle
     * null if not a member
     */
    get initiator(): Member | null;
    /**
     * Set new circle initiator
     * null if not a member
     */
    set initiator(initiator: Member | null);
    /**
     * Circle ownership
     */
    get owner(): Member;
    /**
     * Set new circle owner
     */
    set owner(owner: Member);
    /**
     * Circle members
     */
    get members(): MemberList;
    /**
     * Define members circle
     */
    set members(members: MemberList);
    /**
     * Add a member to this circle
     */
    addMember(member: Member): void;
    /**
     * Remove a member from this circle
     */
    deleteMember(member: Member): void;
    get settings(): any;
    /**
     * Circle config
     */
    get config(): number;
    /**
     * Define circle config
     */
    set config(config: number);
    /**
     * Circle requires invite to be confirmed by moderator or above
     */
    get requireJoinAccept(): boolean;
    /**
     * Circle can be requested to join
     */
    get canJoin(): boolean;
    /**
     * Circle is visible to others
     */
    get isVisible(): boolean;
    /**
     * Circle requires invite to be accepted by the member
     */
    get requireInviteAccept(): boolean;
    /**
     * Can the initiator add members to this circle?
     */
    get isOwner(): boolean;
    /**
     * Is the initiator a member of this circle?
     */
    get isMember(): boolean | 0 | undefined;
    /**
     * Is the initiator a pending member of this circle?
     */
    get isPendingMember(): boolean;
    /**
     * Can the initiator delete this circle?
     */
    get canDelete(): boolean;
    /**
     * Can the initiator leave this circle?
     */
    get canLeave(): boolean | 0 | undefined;
    /**
     * Can the initiator add/remove members to this circle?
     */
    get canManageMembers(): boolean | 0 | undefined;
    /**
     * Vue router param
     */
    get router(): {
        name: string;
        params: {
            selectedCircle: string;
        };
    };
    /**
     * Default javascript fallback
     * Used for sorting as well
     */
    toString(): string;
}
export {};