1 | <?php |
||
5 | class Group extends Rest |
||
6 | { |
||
7 | /** |
||
8 | * Get all groups. |
||
9 | * |
||
10 | * @param null|string $cursor |
||
11 | * @param int $limit |
||
12 | * |
||
13 | * @return array|bool |
||
14 | */ |
||
15 | public function all($cursor = null, $limit = 20) |
||
33 | |||
34 | /** |
||
35 | * Fetch the group details. |
||
36 | * |
||
37 | * @return bool|array |
||
38 | */ |
||
39 | public function detail() |
||
50 | |||
51 | /** |
||
52 | * @param $name |
||
53 | * @param $desc |
||
54 | * @param $owner |
||
55 | * @param array $members |
||
56 | * @param bool $is_public |
||
57 | * @param int $max_users 默认值200,最大值2000 |
||
58 | * @param bool $approval 是否需要批准 |
||
59 | * |
||
60 | * @return bool|array ['groupid' => 12312312] |
||
61 | */ |
||
62 | public function create( |
||
85 | |||
86 | /** |
||
87 | * Update group. |
||
88 | * |
||
89 | * @param string $group_id |
||
90 | * @param null|string $groupname |
||
91 | * @param null|string $description |
||
92 | * @param null|int $maxusers |
||
93 | * |
||
94 | * @return bool |
||
95 | */ |
||
96 | public function update($group_id, $groupname = null, $description = null, $maxusers = null) |
||
108 | |||
109 | /** |
||
110 | * Remove a group. |
||
111 | * |
||
112 | * @param string $group_id |
||
113 | * |
||
114 | * @return bool |
||
115 | */ |
||
116 | public function remove($group_id) |
||
122 | |||
123 | /** |
||
124 | * Get group's members. |
||
125 | * |
||
126 | * @param string $group_id |
||
127 | * |
||
128 | * @return bool|array |
||
129 | */ |
||
130 | public function members($group_id) |
||
136 | |||
137 | /** |
||
138 | * Join one user to a group. |
||
139 | * |
||
140 | * @param string $group_id |
||
141 | * @param string $username |
||
142 | * |
||
143 | * @return bool |
||
144 | */ |
||
145 | public function join($group_id, $username) |
||
151 | |||
152 | /** |
||
153 | * Join multiple users to a group. |
||
154 | * |
||
155 | * @param string $group_id |
||
156 | * @param array $users |
||
157 | * |
||
158 | * @return bool|array |
||
159 | */ |
||
160 | public function batchJoin($group_id, array $users) |
||
170 | |||
171 | /** |
||
172 | * Remove one member from group. |
||
173 | * |
||
174 | * @param string $group_id |
||
175 | * @param string $username |
||
176 | * |
||
177 | * @return bool |
||
178 | */ |
||
179 | public function out($group_id, $username) |
||
185 | |||
186 | /** |
||
187 | * @param string $group_id |
||
188 | * @param array $users |
||
189 | * |
||
190 | * @return bool|array |
||
191 | */ |
||
192 | public function batchOut($group_id, array $users) |
||
199 | |||
200 | /** |
||
201 | * Get user joined groups. |
||
202 | * |
||
203 | * @param string $username |
||
204 | * |
||
205 | * @return bool|array |
||
206 | */ |
||
207 | public function getUserGroups($username) |
||
213 | |||
214 | /** |
||
215 | * Transfer group owner. |
||
216 | * |
||
217 | * @param string $group_id |
||
218 | * @param string $username |
||
219 | * |
||
220 | * @return bool |
||
221 | */ |
||
222 | public function transfer($group_id, $username) |
||
232 | |||
233 | /** |
||
234 | * Cat the group blocked users. |
||
235 | * |
||
236 | * @param string $group_id |
||
237 | * |
||
238 | * @return bool|array |
||
239 | */ |
||
240 | public function blocks($group_id) |
||
246 | |||
247 | /** |
||
248 | * Block user. |
||
249 | * |
||
250 | * @param string $group_id |
||
251 | * @param string $username |
||
252 | * |
||
253 | * @return bool |
||
254 | */ |
||
255 | public function block($group_id, $username) |
||
261 | |||
262 | /** |
||
263 | * @param string $group_id |
||
264 | * @param array $users |
||
265 | * |
||
266 | * @return bool|array |
||
267 | */ |
||
268 | public function batchBlock($group_id, array $users) |
||
278 | |||
279 | /** |
||
280 | * @param string $group_id |
||
281 | * @param string $username |
||
282 | * |
||
283 | * @return bool |
||
284 | */ |
||
285 | public function unblock($group_id, $username) |
||
291 | |||
292 | /** |
||
293 | * @param string $group_id |
||
294 | * @param array $users |
||
295 | * |
||
296 | * @return bool|array |
||
297 | */ |
||
298 | public function batchUnblock($group_id, array $users) |
||
305 | } |
||
306 |