Feature/client permissions enum

src/main/java/com/github/theholywaffle/teamspeak3/TS3Api.java

@@ -12,10 +12,10 @@
  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
- * 
+ *
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
- * 
+ *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -251,6 +251,12 @@ public void addChannelPermission(int channelId, String permName, int permValue)
 
 	/**
 	 * Adds a specified permission to a channel.
+	 * @deprecated
+	 * This method is no longer preferred for adding permissions to the client
+	 * <p>
+	 *    	Use {@link TS3Api#addClientPermission(int, IPermissionType, int, boolean)}
+	 * 		or {@link TS3Api#addClientPermission(int, BPermissionType, boolean, boolean)} instead.
+	 * </p>
 	 *
 	 * @param clientDBId
 	 * 		the database ID of the client to grant the permission
@@ -267,10 +273,57 @@ public void addChannelPermission(int channelId, String permName, int permValue)
 	 * @see Client#getDatabaseId()
 	 * @see Permission
 	 */
+	@Deprecated
 	public void addClientPermission(int clientDBId, String permName, int value, boolean skipped) {
 		asyncApi.addClientPermission(clientDBId, permName, value, skipped).getUninterruptibly();
 	}
 
+	/**
+	 * Adds a specified permission to a client.
+	 *
+	 * @param clientDBId
+	 * 		the database ID of the client to grant the permission
+	 * @param permName
+	 * 		the enum of the permission to grant
+	 * 		@see IPermissionType
+	 * @param value
+	 * 		the numeric value of the permission
+	 * @param skipped
+	 * 		if set to {@code true}, the permission will not be overridden by channel group permissions
+	 *
+	 * @throws TS3CommandFailedException
+	 * 		if the execution of a command fails
+	 * @querycommands 1
+	 * @see Client#getDatabaseId()
+	 * @see Permission
+	 */
+	public void addClientPermission(int clientDBId, IPermissionType permName, int value, boolean skipped) {
+		asyncApi.addClientPermission(clientDBId, permName, value, skipped).getUninterruptibly();
+	}
+
+	/**
+	 * Adds a specified permission to a client.
+	 *
+	 * @param clientDBId
+	 * 		the database ID of the client to grant the permission
+	 * @param permName
+	 * 		the enum of the permission to grant
+	 * 		@see BPermissionType
+	 * @param value
+	 * 		the boolean value of the permission
+	 * @param skipped
+	 * 		if set to {@code true}, the permission will not be overridden by channel group permissions
+	 *
+	 * @throws TS3CommandFailedException
+	 * 		if the execution of a command fails
+	 * @querycommands 1
+	 * @see Client#getDatabaseId()
+	 * @see Permission
+	 */
+	public void addClientPermission(int clientDBId, BPermissionType permName, boolean value, boolean skipped) {
+		asyncApi.addClientPermission(clientDBId, permName, value, skipped).getUninterruptibly();
+	}
+
 	/**
 	 * Adds a client to the specified server group.
 	 * <p>
@@ -1042,6 +1095,44 @@ public void deleteClientPermission(int clientDBId, String permName) {
 		asyncApi.deleteClientPermission(clientDBId, permName).getUninterruptibly();
 	}
 
+	/**
+	 * Removes a permission from a client.
+	 *
+	 * @param clientDBId
+	 * 		the database ID of the client
+	 * @param permName
+	 * 		the enum of the permission to revoke
+	 * 		@see IPermissionType
+	 *
+	 * @throws TS3CommandFailedException
+	 * 		if the execution of a command fails
+	 * @querycommands 1
+	 * @see Client#getDatabaseId()
+	 * @see Permission#getName()
+	 */
+	public void deleteClientPermission(int clientDBId, IPermissionType permName) {
+		asyncApi.deleteClientPermission(clientDBId, permName).getUninterruptibly();
+	}
+
+	/**
+	 * Removes a permission from a client.
+	 *
+	 * @param clientDBId
+	 * 		the database ID of the client
+	 * @param permName
+	 * 		the enum of the permission to revoke
+	 * 		@see BPermissionType
+	 *
+	 * @throws TS3CommandFailedException
+	 * 		if the execution of a command fails
+	 * @querycommands 1
+	 * @see Client#getDatabaseId()
+	 * @see Permission#getName()
+	 */
+	public void deleteClientPermission(int clientDBId, BPermissionType permName) {
+		asyncApi.deleteClientPermission(clientDBId, permName).getUninterruptibly();
+	}
+
 	/**
 	 * Deletes the complaint about the client with database ID {@code targetClientDBId} submitted by
 	 * the client with database ID {@code fromClientDBId} from the server.

src/main/java/com/github/theholywaffle/teamspeak3/TS3ApiAsync.java

@@ -283,6 +283,12 @@ public CommandFuture<Void> addChannelPermission(int channelId, String permName,
 
 	/**
 	 * Adds a specified permission to a channel.
+	 * @deprecated
+	 * This method is no longer preferred for adding permissions to the client
+	 * <p> 
+	 *  	Use {@link TS3ApiAsync#addClientPermission(int, IPermissionType, int, boolean)}
+	 * 	 	or {@link TS3ApiAsync#addClientPermission(int, BPermissionType, boolean, boolean)} instead.
+	 * </p>
 	 *
 	 * @param clientDBId
 	 * 		the database ID of the client to grant the permission
@@ -301,11 +307,60 @@ public CommandFuture<Void> addChannelPermission(int channelId, String permName,
 	 * @see Client#getDatabaseId()
 	 * @see Permission
 	 */
+	@Deprecated
 	public CommandFuture<Void> addClientPermission(int clientDBId, String permName, int value, boolean skipped) {
 		Command cmd = PermissionCommands.clientAddPerm(clientDBId, permName, value, skipped);
 		return executeAndReturnError(cmd);
 	}
 
+	/**
+	 * Adds a specified permission to a client.
+	 *
+	 * @param clientDBId
+	 * 		the database ID of the client to grant the permission
+	 * @param permName
+	 * 		the enum of the permission to grant
+	 * 		@see IPermissionType
+	 * @param value
+	 * 		the numeric value of the permission
+	 * @param skipped
+	 * 		if set to {@code true}, the permission will not be overridden by channel group permissions
+	 *
+	 * @throws TS3CommandFailedException
+	 * 		if the execution of a command fails
+	 * @querycommands 1
+	 * @see Client#getDatabaseId()
+	 * @see Permission
+	 */
+	public CommandFuture<Void> addClientPermission(int clientDBId, IPermissionType permName, int value, boolean skipped) {
+		Command cmd = PermissionCommands.clientAddPerm(clientDBId, permName.getName(), value, skipped);
+		return executeAndReturnError(cmd);
+	}
+
+	/**
+	 * Adds a specified permission to a client.
+	 *
+	 * @param clientDBId
+	 * 		the database ID of the client to grant the permission
+	 * @param permName
+	 * 		the enum of the permission to grant
+	 * 		@see BPermissionType
+	 * @param value
+	 * 		the boolean value of the permission
+	 * @param skipped
+	 * 		if set to {@code true}, the permission will not be overridden by channel group permissions
+	 *
+	 * @throws TS3CommandFailedException
+	 * 		if the execution of a command fails
+	 * @querycommands 1
+	 * @see Client#getDatabaseId()
+	 * @see Permission
+	 */
+	public CommandFuture<Void> addClientPermission(int clientDBId, BPermissionType permName, boolean value, boolean skipped) {
+		Command cmd = PermissionCommands.clientAddPerm(clientDBId, permName.getName(), value, skipped);
+		return executeAndReturnError(cmd);
+	}
+
 	/**
 	 * Adds a client to the specified server group.
 	 * <p>
@@ -1157,6 +1212,46 @@ public CommandFuture<Void> deleteClientPermission(int clientDBId, String permNam
 		return executeAndReturnError(cmd);
 	}
 
+	/**
+	 * Removes a permission from a client.
+	 *
+	 * @param clientDBId
+	 * 		the database ID of the client
+	 * @param permName
+	 * 		the enum of the permission to revoke
+	 * 		@see IPermissionType
+	 *
+	 * @throws TS3CommandFailedException
+	 * 		if the execution of a command fails
+	 * @querycommands 1
+	 * @see Client#getDatabaseId()
+	 * @see Permission#getName()
+	 */
+	public CommandFuture<Void> deleteClientPermission(int clientDBId, IPermissionType permName) {
+		Command cmd = PermissionCommands.clientDelPerm(clientDBId, permName.getName());
+		return executeAndReturnError(cmd);
+	}
+
+	/**
+	 * Removes a permission from a client.
+	 *
+	 * @param clientDBId
+	 * 		the database ID of the client
+	 * @param permName
+	 * 		the enum of the permission to revoke
+	 * 		@see BPermissionType
+	 *
+	 * @throws TS3CommandFailedException
+	 * 		if the execution of a command fails
+	 * @querycommands 1
+	 * @see Client#getDatabaseId()
+	 * @see Permission#getName()
+	 */
+	public CommandFuture<Void> deleteClientPermission(int clientDBId, BPermissionType permName) {
+		Command cmd = PermissionCommands.clientDelPerm(clientDBId, permName.getName());
+		return executeAndReturnError(cmd);
+	}
+
 	/**
 	 * Deletes the complaint about the client with database ID {@code targetClientDBId} submitted by
 	 * the client with database ID {@code fromClientDBId} from the server.