com.bandwidth.sdk.model

Class PhoneNumber

java.lang.Object

com.bandwidth.sdk.model.ModelBase

com.bandwidth.sdk.model.ResourceBase

com.bandwidth.sdk.model.PhoneNumber

public class PhoneNumber
extends ResourceBase

Information about your phone number.

Author:

vpotapenko

Field Summary

Fields inherited from class com.bandwidth.sdk.model.ResourceBase

client, id, properties

Fields inherited from class com.bandwidth.sdk.model.ModelBase

dateFormat

Constructor Summary

Constructors

Constructor and Description
PhoneNumber(BandwidthClient client, org.json.simple.JSONObject jsonObject)

Method Summary

Methods

Modifier and Type	Method and Description
void	commit() Makes changes to a number you have.
static PhoneNumber	create(BandwidthClient client, Map<String,Object> params) Factory method to allocate a phone number given a set of params.
static PhoneNumber	create(Map<String,Object> params) Factory method to allocate a phone number given a set of params.
void	delete() Removes a number from your account so you can no longer make or receive calls, or send or receive messages with it.
static PhoneNumber	get(BandwidthClient client, String phoneNumberId) Factory method for PhoneNumber.
static PhoneNumber	get(String phoneNumberId) Factory method for PhoneNumber.
String	getApplication()
String	getCity()
Date	getCreatedTime()
String	getFallbackNumber()
String	getName()
String	getNationalNumber()
String	getNumber()
String	getNumberState()
Double	getPrice()
String	getState()
String	getUri()
static ResourceList<PhoneNumber>	list() Factory method for PhoneNumber list, returns list of PhoneNumber objects with default page setting
static ResourceList<PhoneNumber>	list(BandwidthClient client, int page, int size) Factory method for PhoneNumber list, returns list of PhoneNumber objects with page, size preferences
static ResourceList<PhoneNumber>	list(int page, int size) Factory method for PhoneNumber list, returns list of PhoneNumber objects with page, size preferences
void	setApplicationId(String applicationId)
void	setFallbackNumber(String fallbackNumber)
void	setName(String name)
protected void	setUp(org.json.simple.JSONObject jsonObject)
String	toString()

Methods inherited from class com.bandwidth.sdk.model.ResourceBase

getClient, getId, getProperties, setId, toJSONArray, toJSONObject

Methods inherited from class com.bandwidth.sdk.model.ModelBase

getProperty, getPropertyAsBoolean, getPropertyAsDate, getPropertyAsDouble, getPropertyAsLong, getPropertyAsString, getPropertyAsStringArray, putProperty, toMap, updateProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

PhoneNumber

public PhoneNumber(BandwidthClient client,
           org.json.simple.JSONObject jsonObject)

Method Detail

setUp

protected void setUp(org.json.simple.JSONObject jsonObject)

Specified by:

setUp in class ResourceBase

get

public static PhoneNumber get(String phoneNumberId)
                       throws Exception

Factory method for PhoneNumber. Returns PhoneNumber object

Parameters:

phoneNumberId - the phone number id

Returns:

the PhoneNumber

Throws:

IOException - unexpected error.

Exception

get

public static PhoneNumber get(BandwidthClient client,
              String phoneNumberId)
                       throws Exception

Factory method for PhoneNumber. Returns PhoneNumber object

Parameters:

client - the client

phoneNumberId - the phone number id

Returns:

the PhoneNumber

Throws:

IOException - unexpected error.

Exception

create

public static PhoneNumber create(Map<String,Object> params)
                          throws Exception

Factory method to allocate a phone number given a set of params. Note that this assumes that the phone number has been previously search for as an AvailableNumber

Parameters:

params - the params

Returns:

the PhoneNumber

Throws:

IOException - unexpected error.

Exception

create

public static PhoneNumber create(BandwidthClient client,
                 Map<String,Object> params)
                          throws Exception

Factory method to allocate a phone number given a set of params. Note that this assumes that the phone number has been previously search for as an AvailableNumber

Parameters:

client - the client

params - the params

Returns:

the PhoneNumber

Throws:

IOException - unexpected error.

Exception

list

public static ResourceList<PhoneNumber> list()
                                      throws IOException

Factory method for PhoneNumber list, returns list of PhoneNumber objects with default page setting

Returns:

the PhoneNumber list.

Throws:

IOException - unexpected error.

list

public static ResourceList<PhoneNumber> list(int page,
                             int size)
                                      throws IOException

Factory method for PhoneNumber list, returns list of PhoneNumber objects with page, size preferences

Parameters:

page - the current page

size - the page size

Returns:

the PhoneNumber list

Throws:

IOException - unexpected error.

list

public static ResourceList<PhoneNumber> list(BandwidthClient client,
                             int page,
                             int size)
                                      throws IOException

Factory method for PhoneNumber list, returns list of PhoneNumber objects with page, size preferences

Parameters:

client - the client

page - the current page

size - the page size

Returns:

the PhoneNumber list

Throws:

IOException - unexpected error.

getUri

public String getUri()

Returns:

the URI.

commit

public void commit()
            throws Exception

Makes changes to a number you have.

Throws:

IOException - unexpected error.

Exception

delete

public void delete()
            throws IOException

Removes a number from your account so you can no longer make or receive calls, or send or receive messages with it. When you remove a number from your account, it will not immediately become available for re-use, so be careful.

Throws:

IOException - unexpected error.

getApplication

public String getApplication()

Returns:

the application.

getNumber

public String getNumber()

Returns:

the number.

getNationalNumber

public String getNationalNumber()

Returns:

the national number

getName

public String getName()

Returns:

the name

getCity

public String getCity()

Returns:

the city

getState

public String getState()

Returns:

the state

getNumberState

public String getNumberState()

Returns:

the number state

getFallbackNumber

public String getFallbackNumber()

Returns:

the fallback number

getPrice

public Double getPrice()

Returns:

the price

getCreatedTime

public Date getCreatedTime()

Returns:

the creation time

setApplicationId

public void setApplicationId(String applicationId)

Parameters:

applicationId - the application id

setName

public void setName(String name)

Parameters:

name - the name

setFallbackNumber

public void setFallbackNumber(String fallbackNumber)

Parameters:

fallbackNumber - the fallback number

toString

public String toString()

Overrides:

toString in class Object