@@ -22,9 +22,8 @@ class API extends RestClient
2222 * @var string
2323 */
2424 public $ uuid = null ;
25-
2625 /**
27- * login logs in to the SinusBot and fetches the token
26+ * login logs on to the SinusBot and retrieves the token
2827 *
2928 * @param string $username SinusBot username
3029 * @param string $password SinusBot password
@@ -56,8 +55,8 @@ public function getFiles()
5655 /**
5756 * getRadioStations returns the imported radio stations
5857 *
59- * @param string $search optional name of the radio station
60- * @return array stations
58+ * @param string $search optional name of the search query
59+ * @return array radio stations
6160 */
6261 public function getRadioStations ($ search = "" )
6362 {
@@ -196,7 +195,7 @@ public function addFolder($folderName = "Folder", $parent = "")
196195 * moveFolder
197196 *
198197 * @param string $folderUUID folder uuid
199- * @param string $parent subfolder UUID, empty value = mainfolder
198+ * @param string $parent subfolder UUID, empty value means root folder
200199 * @return array status
201200 */
202201 public function moveFolder ($ folderUUID , $ parent = "" )
@@ -207,7 +206,7 @@ public function moveFolder($folderUUID, $parent = "")
207206 /**
208207 * renameFolder
209208 *
210- * @param string $folderName Folder
209+ * @param string $folderName Folder name
211210 * @param string $folderUUID uuid of the folder
212211 * @return array status
213212 */
@@ -245,7 +244,7 @@ public function getJobs()
245244 /**
246245 * addJob
247246 *
248- * @param string $URL {YouTube-URL,SoundCloud-URL,Directfile}
247+ * @param string $URL {YouTube-URL, SoundCloud-URL, Directfile}
249248 * @return array status
250249 */
251250 public function addJob ($ URL )
@@ -267,7 +266,6 @@ public function deleteJob($jobUUID)
267266 return $ this ->request ('/bot/jobs/ ' .$ jobUUID , 'DELETE ' );
268267 }
269268
270-
271269 /**
272270 * deleteFinishedJobs
273271 *
@@ -278,7 +276,6 @@ public function deleteFinishedJobs()
278276 return $ this ->request ('/bot/jobs ' , 'DELETE ' );
279277 }
280278
281-
282279 /**
283280 * uploadTrack
284281 *
@@ -290,8 +287,6 @@ public function uploadTrack($path)
290287 return $ this ->request ('/bot/upload ' , 'POST ' , file_get_contents ($ path ));
291288 }
292289
293-
294-
295290 /**
296291 * getUsers
297292 *
@@ -302,7 +297,6 @@ public function getUsers()
302297 return $ this ->request ('/bot/users ' );
303298 }
304299
305-
306300 /**
307301 * addUser
308302 *
@@ -320,12 +314,11 @@ public function addUser($username, $password, $privileges = 0)
320314 ]);
321315 }
322316
323-
324317 /**
325318 * setUserPassword
326319 *
327320 * @param string $password Password
328- * @param string $userUUID 65f7473e-f820-4114-b3df-1a48adc74aeb
321+ * @param string $userUUID user uuid
329322 * @return array status
330323 */
331324 public function setUserPassword ($ password , $ userUUID )
@@ -340,8 +333,8 @@ public function setUserPassword($password, $userUUID)
340333 * setUserPrivileges
341334 *
342335 * @param integer $privileges Bitmask-Value
343- * @param string $userUUID 65f7473e-f820-4114-b3df-1a48adc74aeb
344- * @return array status
336+ * @param string $userUUID user UUID
337+ * @return array status
345338 */
346339 public function setUserPrivileges ($ privileges , $ userUUID )
347340 {
@@ -353,8 +346,8 @@ public function setUserPrivileges($privileges, $userUUID)
353346 /**
354347 * setUserIdentity
355348 *
356- * @param string $identity Zzbfw9S5ttDeAThBhop6TlwCaRo=
357- * @param string $userUUID 65f7473e-f820-4114-b3df-1a48adc74aeb
349+ * @param string $identity teamspeak identity
350+ * @param string $userUUID SinusBot user UUID
358351 * @return array status
359352 */
360353 public function setUserIdentity ($ identity , $ userUUID )
@@ -368,8 +361,8 @@ public function setUserIdentity($identity, $userUUID)
368361 /**
369362 * setUserServergroup
370363 *
371- * @param string $groupID 6
372- * @param string $userUUID 65f7473e-f820-4114-b3df-1a48adc74aeb
364+ * @param string $groupID TeamSpeak Group ID
365+ * @param string $userUUID SinusBot User UUID
373366 * @return array status
374367 */
375368 public function setUserServergroup ($ groupID , $ userUUID )
@@ -383,7 +376,7 @@ public function setUserServergroup($groupID, $userUUID)
383376 /**
384377 * deleteUser
385378 *
386- * @param string $userUUID 65f7473e-f820-4114-b3df-1a48adc74aeb
379+ * @param string $userUUID SinusBot User UUID
387380 * @return array status
388381 */
389382 public function deleteUser ($ userUUID )
0 commit comments