|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TelURL
This class represents Tel URLs, which are used for addressing. The Tel URL
starts with the scheme tel:
. This tells the
local entity that what follows is a URL that should be parsed as described
in RFC2806. After that,
the URL contains the phone number of the remote entity.
Within a SIP Message, TelURLs can be used to indicate the source and intended destination of a Request, redirection addresses and the current destination of a Request. All these Headers may contain TelURLs.
The TelURL interface extends the generic URI interface and provides additional convenience methods for the following components of a TelURL address, above the generic URI class:
Method Summary | |
---|---|
java.lang.String |
getIsdnSubAddress()
Returns the value of the isdnSubAddress parameter, or null
if it is not set. |
java.lang.String |
getPhoneContext()
Returns the value of the phoneContext parameter, or null
if it is not set. |
java.lang.String |
getPhoneNumber()
Returns the value of the phoneNumber parameter. |
java.lang.String |
getPostDial()
Returns the value of the postDial parameter, or null if it
is not set. |
boolean |
isGlobal()
Returns true if this TelURL is global i.e. if the TelURI
has a global phone user. |
void |
setGlobal(boolean global)
Sets phone user of this TelURL to be either global or local. |
void |
setIsdnSubAddress(java.lang.String isdnSubAddress)
Sets ISDN subaddress of this TelURL. |
void |
setPhoneContext(java.lang.String phoneContext)
Sets the phone context of this TelURL. |
void |
setPhoneNumber(java.lang.String phoneNumber)
Sets phone number of this TelURL. |
void |
setPostDial(java.lang.String postDial)
Sets post dial of this TelURL. |
java.lang.String |
toString()
This method returns the URI as a string. |
Methods inherited from interface javax.sip.address.URI |
---|
clone, getScheme, isSipURI |
Methods inherited from interface javax.sip.header.Parameters |
---|
getParameter, getParameterNames, removeParameter, setParameter |
Method Detail |
---|
boolean isGlobal()
true
if this TelURL is global i.e. if the TelURI
has a global phone user.
true
if this TelURL represents a global phone user,
and false
otherwise.void setGlobal(boolean global)
global
- - the boolean value indicating if the TelURL has a global
phone user.void setPostDial(java.lang.String postDial) throws java.text.ParseException
postDial
- - new value of the postDial
parameter
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the postDial value.java.lang.String getPostDial()
postDial
parameter, or null if it
is not set.
postDial
parametervoid setPhoneNumber(java.lang.String phoneNumber) throws java.text.ParseException
phoneNumber
- - new value of the phoneNumber
parameter
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the phoneNumber value.java.lang.String getPhoneNumber()
phoneNumber
parameter. This method
will not return the "+" associated with telephone numbers.
phoneNumber
parametervoid setIsdnSubAddress(java.lang.String isdnSubAddress) throws java.text.ParseException
isdnSubAddress
- - new value of the isdnSubAddress
parameter
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the isdnSubAddress value.java.lang.String getIsdnSubAddress()
isdnSubAddress
parameter, or null
if it is not set.
isdnSubAddress
parametervoid setPhoneContext(java.lang.String phoneContext) throws java.text.ParseException
phoneContext
- - new value of the phoneContext
parameter
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the phoneContext value.java.lang.String getPhoneContext()
phoneContext
parameter, or null
if it is not set.
phoneContext
parameterjava.lang.String toString()
toString
in interface URI
toString
in class java.lang.Object
|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |