public class AnywhereClientAPI
extends java.lang.Object
See the method AnywhereAPI.getClientAPI() to obtain an instance of the AnywhereClientAPI.
| Modifier | Constructor and Description |
|---|---|
protected |
AnywhereClientAPI(AnywhereConnector connector) |
| Modifier and Type | Method and Description |
|---|---|
Client |
clearCredentials(AuthToken authToken,
java.lang.String id)
Clear the client with the specified id's credentials, forcing it to be logged into again
|
Client |
deregister(AuthToken authToken,
java.lang.String id,
boolean wipe)
Deregister the client with the specified id
|
ClientListing |
list(AuthToken authToken)
List all of the available clients
|
Client |
rename(AuthToken authToken,
java.lang.String id,
java.lang.String name)
Rename the client with the specified id to have the specified name
|
protected AnywhereClientAPI(AnywhereConnector connector)
public Client rename(AuthToken authToken, java.lang.String id, java.lang.String name) throws AwUnsupportedApiVersionException, java.io.IOException, AnywhereException
authToken - authentication token for the user performing the requestid - the id of the client to be renamedname - the name to assign to the clientAwUnsupportedApiVersionException - if this method is not supported by the server due to the server's supported API
versionsjava.io.IOExceptionAnywhereExceptionpublic Client deregister(AuthToken authToken, java.lang.String id, boolean wipe) throws AwUnsupportedApiVersionException, java.io.IOException, AnywhereException
authToken - authentication token for the user performing the requestid - the id of the client to be deregisteredwipe - whether the client should wipe all of its dataAwUnsupportedApiVersionException - if this method is not supported by the server due to the server's supported API
versionsjava.io.IOExceptionAnywhereExceptionpublic ClientListing list(AuthToken authToken) throws AwUnsupportedApiVersionException, java.io.IOException, AnywhereException
authToken - authentication token for the user performing the requestAwUnsupportedApiVersionException - if this method is not supported by the server due to the server's supported API
versionsjava.io.IOExceptionAnywhereExceptionpublic Client clearCredentials(AuthToken authToken, java.lang.String id) throws AwUnsupportedApiVersionException, java.io.IOException, AnywhereException
authToken - authentication token for the user performing the requestid - the id of the client whose credentials should be clearedAwUnsupportedApiVersionException - if this method is not supported by the server due to the server's supported API
versionsjava.io.IOExceptionAnywhereException