org.linphone.core

Interface LinphoneAddress

public interface LinphoneAddress

Object that represents a SIP address. The LinphoneAddress is an opaque object to represents SIP addresses, ie the content of SIP's 'from' and 'to' headers. A SIP address is made of display name, username, domain name, port, and various uri headers (such as tags). It looks like 'Alice <sip:alice@example.net>'. The LinphoneAddress has methods to extract and manipulate all parts of the address. When some part of the address (for example the username) is empty, the accessor methods return null.
Can be instanciated using both LinphoneCoreFactory.createLinphoneAddress(String, String, String) or LinphoneCoreFactory.createLinphoneAddress(String)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LinphoneAddress.TransportType

Method Summary

Methods

Modifier and Type	Method and Description
String	asString()
String	asStringUriOnly()
void	clean() Removes address's tags and uri headers so that it is displayable to the user.
String	getDisplayName() Human display name
String	getDomain() Domain name
int	getPort() Port
LinphoneAddress.TransportType	getTransport() Gets the transport set in the address
String	getUserName() userinfo
void	setDisplayName(String name) set display name
void	setDomain(String domain) set domain name
void	setPort(int port) set port
void	setTransport(LinphoneAddress.TransportType transport) Sets the transport in the address
void	setUserName(String username) set user name
String	toString() same as asString()

Method Detail

getDisplayName

String getDisplayName()

Human display name

Returns:

null if not set

getUserName

String getUserName()

userinfo

Returns:

null if not set

getDomain

String getDomain()

Domain name

Returns:

null if not set

getPort

int getPort()

Port

Returns:

0 if not set

setDisplayName

void setDisplayName(String name)

set display name

Parameters:

name -

setUserName

void setUserName(String username)

set user name

Parameters:

username -

setDomain

void setDomain(String domain)

set domain name

Parameters:

domain -

setPort

void setPort(int port)

set port

Parameters:

port, - 0 if not set

clean

void clean()

Removes address's tags and uri headers so that it is displayable to the user.

asString

String asString()

Returns:

the address as a string.

asStringUriOnly

String asStringUriOnly()

Returns:

the address without display name as a string.

toString

String toString()

same as asString()

Overrides:

toString in class Object

getTransport

LinphoneAddress.TransportType getTransport()

Gets the transport set in the address

Returns:

the transport

setTransport

void setTransport(LinphoneAddress.TransportType transport)

Sets the transport in the address

Parameters:

transport - the transport to set