APIClient¶
-
class
Cocotec.CocoPlatform.APIClient
: public IDisposable¶ This class permits users to access the API methods.
Note that whilst APIClient is threadsafe, other API objects are not unless they explicitly state otherwise.
Public Functions
-
APIClient
()¶
-
void
StartServer
()¶
-
void
StartServer
(string serverPath) Starts the server process on the given path. This must be called before creating any instances of APIClient.
- Parameters
serverPath
: an absolute path to the coco-platform-server executable. This will be passed directly to the the constructor of ProcessBuilder.
- Exceptions
IOException
: if any error is encountered whilst trying to start the server.
-
void
Dispose
()¶ Shuts down the server cleanly
-