Package org.linphone.core

Interface SearchResult

public interface SearchResult

The LinphoneSearchResult object represents a result of a search.

Method Summary

Modifier and Type	Method	Description
Address	getAddress()	Gets the address of the search result if any.
int	getCapabilities()	Returns the capabilities mask of the search result.
Friend	getFriend()	Gets the friend of the search result if any.
long	getNativePointer()	Gets the native pointer used by this class to make native method calls.
java.lang.String	getPhoneNumber()	Gets the phone number of the search result if any.
int	getSourceFlags()	Gets source flags of the search result.
java.lang.Object	getUserData()	Gets the object stored in this object user's data
int	getWeight()	Gets the weight of the search result.
boolean	hasCapability(FriendCapability capability)	Returns whether or not the search result has the given capability.
void	setUserData(java.lang.Object data)	Sets the object to store in this object user's data
java.lang.String	toString()

Method Detail

getAddress

@Nullable
Address getAddress()

Gets the address of the search result if any.

Returns:

The associed Address or null.

getCapabilities

int getCapabilities()

Returns the capabilities mask of the search result.

Returns:

the capabilities mask associated to the search result

getFriend

@Nullable
Friend getFriend()

Gets the friend of the search result if any.

Returns:

The associated Friend or null.

getPhoneNumber

@Nullable
java.lang.String getPhoneNumber()

Gets the phone number of the search result if any.

Returns:

The associed phone number or null.

getSourceFlags

int getSourceFlags()

Gets source flags of the search result.

Returns:

the source flags from MagicSearchSource

getWeight

int getWeight()

Gets the weight of the search result.

Returns:

the result weight

hasCapability

boolean hasCapability(FriendCapability capability)

Returns whether or not the search result has the given capability.

Parameters:

capability - the FriendCapability to check

Returns:

true if it has the capability, false otherwise.

setUserData

void setUserData(java.lang.Object data)

Sets the object to store in this object user's data

Parameters:

data - the object to store

getUserData

java.lang.Object getUserData()

Gets the object stored in this object user's data

Returns:

the object store if any, null otherwise

getNativePointer

long getNativePointer()

Gets the native pointer used by this class to make native method calls.

Returns:

the nativer pointer, as long

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object