Package com.vonage.client.voice.ncco

Class SipEndpoint

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.voice.ncco.SipEndpoint

All Implemented Interfaces:

Jsonable, Endpoint

public class SipEndpoint
extends JsonableBaseObject
implements Endpoint

Represents a SIP endpoint used in a ConnectAction. See the documentation for an example.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SipEndpoint.Builder

Method Summary

Modifier and Type	Method	Description
static SipEndpoint.Builder	builder(String uri)	Entry point for constructing an instance of this class.
static SipEndpoint.Builder	builder(URI uri)	Entry point for constructing an instance of this class.
Map<String,?>	getHeaders()	Defines custom headers to be sent as part of the SIP INVITE request.
Map<SipHeader,String>	getStandardHeaders()	Headers that are RFC standards, i.e. not prepended with X-.
String	getType()
URI	getUri()	URI of the SIP 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

Method Details

getType

public String getType()

Specified by:

getType in interface Endpoint

getUri

public URI getUri()

URI of the SIP endpoint.

Returns:

The URI.

getHeaders

public Map<String,?> getHeaders()

Defines custom headers to be sent as part of the SIP INVITE request. All keys will be prepended with the X- prefix.

Returns:

The custom headers as a Map, or null if unspecified.

getStandardHeaders

public Map<SipHeader,String> getStandardHeaders()

Headers that are RFC standards, i.e. not prepended with X-.

Returns:

The standard headers, or null if unspecified.

Since:

8.9.0

builder

public static SipEndpoint.Builder builder(String uri)

Entry point for constructing an instance of this class.

Parameters:

uri - The SIP URI as a string.

Returns:

A new Builder.

builder

public static SipEndpoint.Builder builder(URI uri)

Entry point for constructing an instance of this class.

Parameters:

uri - The SIP URI.

Returns:

A new Builder.