Class RedactClient

Namespace

Vonage.Redaction

Assembly

Vonage.dll

Represents a client for the Vonage Redact API, enabling removal of personal data from the Vonage platform.

public class RedactClient : IRedactClient

Inheritance

object

RedactClient

Implements

IRedactClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

RedactClient(Credentials)

Initializes a new instance of the RedactClient class.

public RedactClient(Credentials creds = null)

Parameters

creds Credentials

Optional credentials to use for authentication.

Properties

Credentials

Gets or sets the credentials used for authenticating API requests.

public Credentials Credentials { get; set; }

Property Value

Credentials

Methods

RedactAsync(RedactRequest, Credentials)

Redacts a specific transaction record from the Vonage platform.

public Task<bool> RedactAsync(RedactRequest request, Credentials creds = null)

Parameters

request RedactRequest

The redaction request containing the transaction ID, product, and type. See RedactRequest.

creds Credentials

Optional credentials to override the default client credentials.

Returns

Task<bool>

true if the redaction was successful.

Examples

var request = new RedactRequest
{
    Id = "00A0B0C0",
    Product = RedactionProduct.Sms,
    Type = RedactionType.Outbound
};
var success = await client.RedactClient.RedactAsync(request);

See Also

More examples in the snippets repository