com.nexmo.client.applications

Class ApplicationClient

java.lang.Object

com.nexmo.client.applications.ApplicationClient

public class ApplicationClient
extends java.lang.Object

A client for talking to the Nexmo Number Applications API. The standard way to obtain an instance of this class is to use NexmoClient.getApplicationClient().

Field Summary

Fields

Modifier and Type	Field and Description
protected ApplicationsEndpoint	applications

Constructor Summary

Constructors

Constructor and Description
ApplicationClient(HttpWrapper httpWrapper) Constructor.

Method Summary

Modifier and Type	Method and Description
ApplicationDetails	createApplication(CreateApplicationRequest request) Create a new Application.
void	deleteApplication(java.lang.String applicationId) Delete an application.
ApplicationDetails	getApplication(java.lang.String applicationId) Obtain the details of an existing application.
ListApplicationsResponse	listApplications(ListApplicationsRequest request) List the applications associated with the authenticated account.
ApplicationDetails	updateApplication(UpdateApplicationRequest request) Update an existing application with the provided details.

Methods inherited from class java.lang.Object

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

Field Detail

applications

protected ApplicationsEndpoint applications

Constructor Detail

ApplicationClient

public ApplicationClient(HttpWrapper httpWrapper)

Constructor.

Parameters:

httpWrapper - (required) shared HTTP wrapper object used for making REST calls.

Method Detail

createApplication

public ApplicationDetails createApplication(CreateApplicationRequest request)
                                     throws java.io.IOException,
                                            NexmoClientException

Create a new Application.

Parameters:

request - A CreateApplicationRequest describing the application to be created.

Returns:

An ApplicationDetails object describing the newly created application, including generated private and public keys.

Throws:

java.io.IOException

NexmoClientException

updateApplication

public ApplicationDetails updateApplication(UpdateApplicationRequest request)
                                     throws java.io.IOException,
                                            NexmoClientException

Update an existing application with the provided details.

Parameters:

request - An UpdateApplicationRequest describing the new application details.

Returns:

An ApplicationDetails object describing the newly modified application.

Throws:

java.io.IOException

NexmoClientException

listApplications

public ListApplicationsResponse listApplications(ListApplicationsRequest request)
                                          throws java.io.IOException,
                                                 NexmoClientException

List the applications associated with the authenticated account. By default returns the first page of application objects.

Parameters:

request - A ListApplicationsRequest object containing the required paging information.

Returns:

A ListApplicationsResponse, which is an Iterator of ApplicationDetails objects.

Throws:

java.io.IOException

NexmoClientException

getApplication

public ApplicationDetails getApplication(java.lang.String applicationId)
                                  throws java.io.IOException,
                                         NexmoClientException

Obtain the details of an existing application.

Parameters:

applicationId - The id of the application

Returns:

An ApplicationDetails object describing the requested application.

Throws:

java.io.IOException

NexmoClientException

deleteApplication

public void deleteApplication(java.lang.String applicationId)
                       throws java.io.IOException,
                              NexmoClientException

Delete an application.

Parameters:

applicationId - The ID of the application to be deleted.

Throws:

java.io.IOException

NexmoClientException