Package com.vonage.client.application

Class ApplicationClient

java.lang.Object

com.vonage.client.application.ApplicationClient

public class ApplicationClient
extends Object

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

Constructor Summary

Constructors

Constructor	Description
ApplicationClient(HttpWrapper wrapper)

Method Summary

Modifier and Type	Method	Description
Application	createApplication(Application application)	Create a new application.
void	deleteApplication(String applicationId)	Delete an application.
Application	getApplication(String applicationId)	Retrieve an application.
List<Application>	listAllApplications()	Lists the first 1000 available applications.
ApplicationList	listApplications()	Lists 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 wrapper)

Method Details

createApplication

public Application createApplication(Application application)
                              throws ApplicationResponseException

Create a new application.

Parameters:

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

Returns:

The application which has been created.

Throws:

ApplicationResponseException - If there was an error processing the request.

updateApplication

public Application updateApplication(Application application)
                              throws ApplicationResponseException

Update an existing application.

Parameters:

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

Returns:

The application which has been updated.

Throws:

ApplicationResponseException - If there was an error processing the request.

getApplication

public Application getApplication(String applicationId)
                           throws ApplicationResponseException

Retrieve an application.

Parameters:

applicationId - The UUID of the application to retrieve as a string.

Returns:

The corresponding application.

Throws:

ApplicationResponseException - If there was an error processing the request.

deleteApplication

public void deleteApplication(String applicationId)
                       throws ApplicationResponseException

Delete an application.

Parameters:

applicationId - The UUID of the application to delete as a string.

Throws:

ApplicationResponseException - If there was an error processing the request.

listAllApplications

public List<Application> listAllApplications()
                                      throws ApplicationResponseException

Lists the first 1000 available applications.

Returns:

The list of available applications.

Throws:

ApplicationResponseException - If there was an error processing the request.

Since:

7.7.0

listApplications

public ApplicationList listApplications()
                                 throws ApplicationResponseException

Lists the first page of available applications.

Returns:

The ApplicationList HAL response.

Throws:

ApplicationResponseException - If there was an error processing the request.

listApplications

public ApplicationList listApplications(ListApplicationRequest listApplicationRequest)
                                 throws ApplicationResponseException

List the available applications.

Parameters:

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

Returns:

The ApplicationList HAL response.

Throws:

ApplicationResponseException - If there was an error processing the request.