com.plivo.api.models.endpoint

Class Endpoint

java.lang.Object

com.plivo.api.models.base.BaseResource

com.plivo.api.models.endpoint.Endpoint

public class Endpoint
extends BaseResource

Field Summary

Fields inherited from class com.plivo.api.models.base.BaseResource

plivoClient

Constructor Summary

Constructors

Constructor and Description
Endpoint()

Method Summary

Modifier and Type	Method and Description
static EndpointCreator	creator(java.lang.String username, java.lang.String password, java.lang.String alias)
EndpointDeleter	deleter()
static EndpointDeleter	deleter(java.lang.String id)
java.lang.String	getAlias()
java.lang.String	getApplication()
java.lang.String	getEndpointId()
java.lang.String	getId()
java.lang.String	getPassword()
java.lang.String	getResourceUri()
java.lang.String	getSipContact()
java.lang.String	getSipExpires()
java.lang.String	getSipRegistered()
java.lang.String	getSipUri()
java.lang.String	getSipUserAgent()
java.lang.String	getSubAccount()
static EndpointGetter	getter(java.lang.String id)
java.lang.String	getUsername()
static EndpointLister	lister()
EndpointUpdater	updater()
static EndpointUpdater	updater(java.lang.String id)

Methods inherited from class com.plivo.api.models.base.BaseResource

getApiId, getPlivoClient, setPlivoClient, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Endpoint

public Endpoint()

Method Detail

creator

public static EndpointCreator creator(java.lang.String username,
                                      java.lang.String password,
                                      java.lang.String alias)

lister

public static EndpointLister lister()

getter

public static EndpointGetter getter(java.lang.String id)

updater

public static EndpointUpdater updater(java.lang.String id)

deleter

public static EndpointDeleter deleter(java.lang.String id)

getSipContact

public java.lang.String getSipContact()

Returns:

The contact field contains the address at which the callee can reach the caller for future requests. It is the IP on which the SIP client is registered.

getAlias

public java.lang.String getAlias()

Returns:

Friendly name for your endpoint.

getApplication

public java.lang.String getApplication()

getEndpointId

public java.lang.String getEndpointId()

Returns:

A unique ID for your endpoint. All API operations will be performed with this ID.

getResourceUri

public java.lang.String getResourceUri()

getSipExpires

public java.lang.String getSipExpires()

Returns:

Time when the SIP registration will expire. Major SIP clients, Plivo WebSDK and Plivo mobile SDKs will re-register the endpoint before the registration expires.

getSipRegistered

public java.lang.String getSipRegistered()

Returns:

true if the SIP endpoint is registered on a SIP client.

getSipUri

public java.lang.String getSipUri()

Returns:

The SIP URI of the endpoint. External users will be able to call this endpoint on this SIP URI.

getSipUserAgent

public java.lang.String getSipUserAgent()

Returns:

The User Agent of SIP client used to register this endpoint. In the case of WebSDK this field will be plivo-websdk.

getSubAccount

public java.lang.String getSubAccount()

Returns:

The sub account in your Plivo account, if this endpoint belongs to a Plivo sub account.

getUsername

public java.lang.String getUsername()

Returns:

Username of your endpoint. Plivo appends a 12 digit code in front your username.

getPassword

public java.lang.String getPassword()

updater

public EndpointUpdater updater()

deleter

public EndpointDeleter deleter()

getId

public java.lang.String getId()

Specified by:

getId in class BaseResource