tgstation-server/TGServiceInterface/Administration.cs

using System.ServiceModel;

namespace TGServiceInterface
{
	/// <summary>
	/// Manage the group that is used to access the service, can only be used by an administrator
	/// </summary>
	[ServiceContract]
	public interface ITGAdministration
	{
		/// <summary>
		/// Get the port used for remote operation
		/// </summary>
		/// <returns>The port used for remote operation</returns>
		[OperationContract]
		ushort RemoteAccessPort();

		/// <summary>
		/// Set the port used for remote operation
		/// Requires a service restart to take effect
		/// </summary>
		/// <param name="port">The new port to use for remote operation</param>
		/// <returns>null on success, error message on failure</returns>
		[OperationContract]
		string SetRemoteAccessPort(ushort port);

		/// <summary>
		/// Returns the name of the windows group allowed to use the service other than administrator
		/// </summary>
		/// <returns>The name of the windows group allowed to use the service other than administrator, "ADMIN" if it's unset, null on failure</returns>
		[OperationContract]
		string GetCurrentAuthorizedGroup();

		/// <summary>
		/// Searches the windows machine for the group named <paramref name="groupName"/>, sets it as the authorized group if it's found
		/// </summary>
		/// <param name="groupName">The name of the windows group to search for or null to clear the setting</param>
		/// <returns>The name of the windows group that is now authorized to use the service on success, null on failure, "ADMIN" on clearing</returns>
		[OperationContract]
		string SetAuthorizedGroup(string groupName);

		/// <summary>
		/// Moves the entire server installation, requires no operations to be running
		/// </summary>
		/// <param name="new_location">The new path to place the server</param>
		/// <returns>null on success, error message on failure</returns>
		[OperationContract]
		string MoveServer(string new_location);

		/// <summary>
		/// Renames the current static folder to a backup name and recreates is from the current repo using TGS3.json
		/// </summary>
		/// <returns>null on success, error message on failure</returns>
		[OperationContract]
		string RecreateStaticFolder();
	}
}