1 | <?php |
||
14 | class Group extends Rest |
||
15 | { |
||
16 | /** |
||
17 | * Get all groups. |
||
18 | * |
||
19 | * @param null|string $cursor |
||
20 | * @param int $limit |
||
21 | * |
||
22 | * @return array|bool |
||
23 | */ |
||
24 | public function all($cursor = null, $limit = 20) |
||
42 | |||
43 | /** |
||
44 | * Fetch the group details. |
||
45 | * |
||
46 | * @return bool|array |
||
47 | */ |
||
48 | public function detail() |
||
59 | |||
60 | /** |
||
61 | * @param $name |
||
62 | * @param $desc |
||
63 | * @param $owner |
||
64 | * @param array $members |
||
65 | * @param bool $is_public |
||
66 | * @param int $max_users 默认值200,最大值2000 |
||
67 | * @param bool $approval 是否需要批准 |
||
68 | * |
||
69 | * @return bool|array ['groupid' => 12312312] |
||
70 | */ |
||
71 | public function create( |
||
94 | |||
95 | /** |
||
96 | * Update group. |
||
97 | * |
||
98 | * @param string $group_id |
||
99 | * @param null|string $groupname |
||
100 | * @param null|string $description |
||
101 | * @param null|int $maxusers |
||
102 | * |
||
103 | * @return bool |
||
104 | */ |
||
105 | public function update($group_id, $groupname = null, $description = null, $maxusers = null) |
||
117 | |||
118 | /** |
||
119 | * Remove a group. |
||
120 | * |
||
121 | * @param string $group_id |
||
122 | * |
||
123 | * @return bool |
||
124 | */ |
||
125 | public function remove($group_id) |
||
131 | |||
132 | /** |
||
133 | * Get group's members. |
||
134 | * |
||
135 | * @param string $group_id |
||
136 | * |
||
137 | * @return bool|array |
||
138 | */ |
||
139 | public function members($group_id) |
||
145 | |||
146 | /** |
||
147 | * Join one user to a group. |
||
148 | * |
||
149 | * @param string $group_id |
||
150 | * @param string $username |
||
151 | * |
||
152 | * @return bool |
||
153 | */ |
||
154 | public function join($group_id, $username) |
||
160 | |||
161 | /** |
||
162 | * Join multiple users to a group. |
||
163 | * |
||
164 | * @param string $group_id |
||
165 | * @param array $users |
||
166 | * |
||
167 | * @return bool|array |
||
168 | */ |
||
169 | public function batchJoin($group_id, array $users) |
||
179 | |||
180 | /** |
||
181 | * Remove one member from group. |
||
182 | * |
||
183 | * @param string $group_id |
||
184 | * @param string $username |
||
185 | * |
||
186 | * @return bool |
||
187 | */ |
||
188 | public function out($group_id, $username) |
||
194 | |||
195 | /** |
||
196 | * @param string $group_id |
||
197 | * @param array $users |
||
198 | * |
||
199 | * @return bool|array |
||
200 | */ |
||
201 | public function batchOut($group_id, array $users) |
||
208 | |||
209 | /** |
||
210 | * Get user joined groups. |
||
211 | * |
||
212 | * @param string $username |
||
213 | * |
||
214 | * @return bool|array |
||
215 | */ |
||
216 | public function getUserGroups($username) |
||
222 | |||
223 | /** |
||
224 | * Transfer group owner. |
||
225 | * |
||
226 | * @param string $group_id |
||
227 | * @param string $username |
||
228 | * |
||
229 | * @return bool |
||
230 | */ |
||
231 | public function transfer($group_id, $username) |
||
241 | |||
242 | /** |
||
243 | * Cat the group blocked users. |
||
244 | * |
||
245 | * @param string $group_id |
||
246 | * |
||
247 | * @return bool|array |
||
248 | */ |
||
249 | public function blocks($group_id) |
||
255 | |||
256 | /** |
||
257 | * Block user. |
||
258 | * |
||
259 | * @param string $group_id |
||
260 | * @param string $username |
||
261 | * |
||
262 | * @return bool |
||
263 | */ |
||
264 | public function block($group_id, $username) |
||
270 | |||
271 | /** |
||
272 | * @param string $group_id |
||
273 | * @param array $users |
||
274 | * |
||
275 | * @return bool|array |
||
276 | */ |
||
277 | public function batchBlock($group_id, array $users) |
||
287 | |||
288 | /** |
||
289 | * @param string $group_id |
||
290 | * @param string $username |
||
291 | * |
||
292 | * @return bool |
||
293 | */ |
||
294 | public function unblock($group_id, $username) |
||
300 | |||
301 | /** |
||
302 | * @param string $group_id |
||
303 | * @param array $users |
||
304 | * |
||
305 | * @return bool|array |
||
306 | */ |
||
307 | public function batchUnblock($group_id, array $users) |
||
314 | } |
||
315 |