Package com.vonage.client.application

Class ApplicationClient

java.lang.Object

com.vonage.client.AbstractClient

com.vonage.client.application.ApplicationClient

public class ApplicationClient
extends AbstractClient

A client for talking to the Vonage Application API. The standard way to obtain an instance of this class is to use VonageClient.getApplicationClient()

Field Summary

Fields inherited from class com.vonage.client.AbstractClient

httpWrapper

Constructor Summary

Constructors

Constructor	Description
ApplicationClient(HttpWrapper httpWrapper)

Method Summary

Modifier and Type	Method	Description
Application	createApplication(Application application)	Create a new application.
void	deleteApplication(java.lang.String id)	Delete an application.
Application	getApplication(java.lang.String id)	Retrieve an application.
ApplicationList	listApplications()	List the first page of available applications.
ApplicationList	listApplications(ListApplicationRequest listApplicationRequest)	List the available applications.
Application	updateApplication(Application application)	Update an existing application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ApplicationClient

public ApplicationClient(HttpWrapper httpWrapper)

Method Details

createApplication

public Application createApplication(Application application) throws VonageResponseParseException, VonageClientException

Create a new application.

Parameters:

application - The application properties for the application to be created with.

Returns:

The application which has been created.

Throws:

VonageResponseParseException - if the response from the API could not be parsed.

VonageClientException - if there was a problem with the Vonage request.

updateApplication

public Application updateApplication(Application application) throws VonageResponseParseException, VonageClientException

Update an existing application.

Parameters:

application - The application properties for the application to be updated with.

Returns:

The application which has been updated.

Throws:

VonageResponseParseException - if the response from the API could not be parsed.

VonageClientException - if there was a problem with the Vonage request.

getApplication

public Application getApplication(java.lang.String id) throws VonageResponseParseException, VonageClientException

Retrieve an application.

Parameters:

id - The id of the application to retrieve.

Returns:

The corresponding application.

Throws:

VonageResponseParseException - if the response from the API could not be parsed.

VonageClientException - if there was a problem with the Vonage request.

deleteApplication

public void deleteApplication(java.lang.String id) throws VonageResponseParseException, VonageClientException

Delete an application.

Parameters:

id - The id of the application to delete.

Throws:

VonageResponseParseException - if the response from the API could not be parsed.

VonageClientException - if there was a problem with the Vonage request.

listApplications

public ApplicationList listApplications() throws VonageResponseParseException, VonageClientException

List the first page of available applications.

Returns:

The list of available applications.

Throws:

VonageResponseParseException - if the response from the API could not be parsed.

VonageClientException - if there was a problem with the Vonage request.

listApplications

public ApplicationList listApplications(ListApplicationRequest listApplicationRequest) throws VonageResponseParseException, VonageClientException

List the available applications.

Parameters:

listApplicationRequest - The page and number of applications per page to list.

Returns:

The list of available applications.

Throws:

VonageResponseParseException - if the response from the API could not be parsed.

VonageClientException - if there was a problem with the Vonage request.