Package com.vonage.client.common

Class Webhook

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.common.Webhook

All Implemented Interfaces:

Jsonable

@Deprecated
public class Webhook
extends JsonableBaseObject

Deprecated.

Will be moved to the com.vonage.client.application package.

Represents the "webhooks" field used in Application capabilities.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Webhook.Builder	Deprecated. Builder for configuring Webhook object.
static enum	Webhook.Type	Deprecated. Represents the webhook URL type.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Webhook()	Deprecated.
	Webhook(String address, HttpMethod method)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Webhook.Builder	builder()	Deprecated. Entrypoint for constructing an instance of this class.
String	getAddress()	Deprecated. The webhook's URL.
Integer	getConnectionTimeout()	Deprecated. If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint.
HttpMethod	getMethod()	Deprecated. The HTTP request method for this webhook.
Integer	getSocketTimeout()	Deprecated. If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint.

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Constructor Details

Webhook

protected Webhook()

Deprecated.

Webhook

public Webhook(String address,
 HttpMethod method)

Deprecated.

Method Details

getAddress

public String getAddress()

Deprecated.

The webhook's URL.

Returns:

The URL as a string.

getMethod

public HttpMethod getMethod()

Deprecated.

The HTTP request method for this webhook.

Returns:

The HTTP method as an enum.

getConnectionTimeout

public Integer getConnectionTimeout()

Deprecated.

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds. The minimum is 300, maximum 1000 and default is 1000.

Returns:

The connection timeout in milliseconds as an integer, or null if unspecified (the default) / not applicable.

getSocketTimeout

public Integer getSocketTimeout()

Deprecated.

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds. The minimum is 1000, maximum 5000 and default is 5000.

Returns:

The socket timeout in milliseconds as an integer, or null if unspecified (the default) / not applicable.

builder

public static Webhook.Builder builder()

Deprecated.

Entrypoint for constructing an instance of this class.

Returns:

A new Builder.

Since:

7.7.0