Package com.vonage.client.redact

Class RedactClient

java.lang.Object

com.vonage.client.redact.RedactClient

public class RedactClient
extends Object

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

Constructor Summary

Constructors

Constructor	Description
RedactClient(HttpWrapper wrapper)

Method Summary

Modifier and Type	Method	Description
void	redactTransaction(RedactRequest redactRequest)	Submit a request to the Redact API to redact a transaction.
void	redactTransaction(String id, RedactRequest.Product product)	Submit a request to the Redact API to redact a transaction.
void	redactTransaction(String id, RedactRequest.Product product, RedactRequest.Type type)	Submit a request to the Redact API to redact a transaction.

Methods inherited from class java.lang.Object

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

Constructor Details

RedactClient

public RedactClient(HttpWrapper wrapper)

Method Details

redactTransaction

public void redactTransaction(String id,
 RedactRequest.Product product)
                       throws VonageResponseParseException,
VonageClientException

Submit a request to the Redact API to redact a transaction.

Parameters:

id - The transaction id to redact.

product - The RedactRequest.Product which corresponds to the transaction.

Throws:

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

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

redactTransaction

public void redactTransaction(String id,
 RedactRequest.Product product,
 RedactRequest.Type type)
                       throws VonageResponseParseException,
VonageClientException

Submit a request to the Redact API to redact a transaction.

Parameters:

id - The transaction id to redact.

product - The RedactRequest.Product which corresponds to the transaction.

type - The RedactRequest.Type which is required if redacting SMS data.

Throws:

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

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

redactTransaction

public void redactTransaction(RedactRequest redactRequest)
                       throws VonageResponseParseException,
VonageClientException

Submit a request to the Redact API to redact a transaction.

Parameters:

redactRequest - a RedactRequest object which contains the request parameters.

Throws:

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

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