org.linphone.core

Interface LinphoneFriend

public interface LinphoneFriend

Represents a buddy, all presence actions like subscription and status change notification are performed on this object

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LinphoneFriend.SubscribePolicy Enum controlling behavior for incoming subscription request.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAddress(LinphoneAddress addr)
void	addPhoneNumber(String phone)
void	done() Commits modification made to the friend configuration.
void	edit() Starts editing a friend configuration.
void	enableSubscribes(boolean enable) Configure LinphoneFriend to subscribe to presence information
LinphoneAddress	getAddress() get address of this friend
LinphoneAddress[]	getAddresses()
String	getFamilyName() get a family name of this friend
String	getGivenName() get a given name of this friend
LinphoneFriend.SubscribePolicy	getIncSubscribePolicy() get current subscription policy for this LinphoneFriend
String	getName() get a name of this friend
long	getNativePtr() Return the native pointer for this object
String	getOrganization() Get organization of this friend
String[]	getPhoneNumbers()
PresenceModel	getPresenceModel() Deprecated. Use getPresenceModelForUri() instead
PresenceModel	getPresenceModelForUri(String uri) Get the presence information for a specific uri (phone number or sip address)
String	getRefKey() Get the reference key of a friend.
OnlineStatus	getStatus() Deprecated. Use getPresenceModelForUri() instead
boolean	isAlreadyPresentInFriendList() Returns true if friend has already been added in a LinphoneFriendList, false otherwise
boolean	isPresenceReceived() get presence received status if already setted
boolean	isSubscribesEnabled() get subscription flag value
void	removeAddress(LinphoneAddress addr)
void	removePhoneNumber(String phone)
void	setAddress(LinphoneAddress anAddress) Set a LinphoneAddress for this friend
void	setFamilyName(String name) Set a family name for this friend
void	setGivenName(String name) Set a given name for this friend
void	setIncSubscribePolicy(LinphoneFriend.SubscribePolicy policy) Configure incoming subscription policy for this friend.
void	setName(String name) Set a name for this friend
void	setOrganization(String organization) Set an organization for this friend
void	setPresenceModel(PresenceModel presenceModel) Set the presence information of a friend
void	setRefKey(String key) Set the reference key of a friend.
String	toString() Human readable representation of this friend

Method Detail

setAddress

void setAddress(LinphoneAddress anAddress)

Set a LinphoneAddress for this friend

Parameters:

anAddress -

getAddress

LinphoneAddress getAddress()

get address of this friend

Returns:

setIncSubscribePolicy

void setIncSubscribePolicy(LinphoneFriend.SubscribePolicy policy)

Configure incoming subscription policy for this friend.

Parameters:

policy - to apply

getIncSubscribePolicy

LinphoneFriend.SubscribePolicy getIncSubscribePolicy()

get current subscription policy for this LinphoneFriend

Returns:

enableSubscribes

void enableSubscribes(boolean enable)

Configure LinphoneFriend to subscribe to presence information

Parameters:

enable - if true this friend will receive subscription message

isSubscribesEnabled

boolean isSubscribesEnabled()

get subscription flag value

Returns:

true is subscription is activated for this friend.

isPresenceReceived

boolean isPresenceReceived()

get presence received status if already setted

Returns:

true if presence is received from this friend.

getStatus

@Deprecated
OnlineStatus getStatus()

Deprecated. Use getPresenceModelForUri() instead

Get the status of a friend

Returns:

OnlineStatus

getPresenceModel

@Deprecated
PresenceModel getPresenceModel()

Deprecated. Use getPresenceModelForUri() instead

Get the presence information of a friend

Returns:

A #PresenceModel object, or null if the friend do not have presence information (in which case he is considered offline)

getPresenceModelForUri

PresenceModel getPresenceModelForUri(String uri)

Get the presence information for a specific uri (phone number or sip address)

Returns:

A #PresenceModel object or null

setPresenceModel

void setPresenceModel(PresenceModel presenceModel)

Set the presence information of a friend

Parameters:

presenceModel - A #PresenceModel object

edit

void edit()

Starts editing a friend configuration.
Because friend configuration must be consistent, applications MUST call edit() before doing any attempts to modify friend configuration (such as address or subscription policy and so on). Once the modifications are done, then the application must call done() to commit the changes.

done

void done()

Commits modification made to the friend configuration.

toString

String toString()

Human readable representation of this friend

Overrides:

toString in class Object

Returns:

getNativePtr

long getNativePtr()

Return the native pointer for this object

setRefKey

void setRefKey(String key)

Set the reference key of a friend.

Parameters:

key - The reference key to use for the friend.

getRefKey

String getRefKey()

Get the reference key of a friend.

Returns:

The reference key of the friend.

setName

void setName(String name)

Set a name for this friend

Parameters:

name -

getName

String getName()

get a name of this friend

Returns:

setFamilyName

void setFamilyName(String name)

Set a family name for this friend

Parameters:

name -

getFamilyName

String getFamilyName()

get a family name of this friend

Returns:

setGivenName

void setGivenName(String name)

Set a given name for this friend

Parameters:

name -

getGivenName

String getGivenName()

get a given name of this friend

Returns:

setOrganization

void setOrganization(String organization)

Set an organization for this friend

Parameters:

organization -

getOrganization

String getOrganization()

Get organization of this friend

Returns:

getAddresses

LinphoneAddress[] getAddresses()

addAddress

void addAddress(LinphoneAddress addr)

removeAddress

void removeAddress(LinphoneAddress addr)

getPhoneNumbers

String[] getPhoneNumbers()

addPhoneNumber

void addPhoneNumber(String phone)

removePhoneNumber

void removePhoneNumber(String phone)

isAlreadyPresentInFriendList

boolean isAlreadyPresentInFriendList()

Returns true if friend has already been added in a LinphoneFriendList, false otherwise