org.linphone.core

Interface MagicSearch

public interface MagicSearch

A MagicSearch is used to do specifics searchs.

Method Summary

Modifier and Type	Method and Description
void	addListener(MagicSearchListener listener)
SearchResult[]	getContactListFromFilter(java.lang.String filter, java.lang.String domain) Deprecated. 22/03/2022 Use getContacts(java.lang.String, java.lang.String, int) instead.
void	getContactListFromFilterAsync(java.lang.String filter, java.lang.String domain) Deprecated. 22/03/2022 Use getContactsAsync(java.lang.String, java.lang.String, int) instead.
SearchResult[]	getContacts(java.lang.String filter, java.lang.String domain, int sourceFlags) Deprecated. 08/04/2022 Use getContactsList(java.lang.String, java.lang.String, int, org.linphone.core.MagicSearchAggregation) instead.
void	getContactsAsync(java.lang.String filter, java.lang.String domain, int sourceFlags) Deprecated. 08/04/2022 Use getContactsListAsync(java.lang.String, java.lang.String, int, org.linphone.core.MagicSearchAggregation) instead.
SearchResult[]	getContactsList(java.lang.String filter, java.lang.String domain, int sourceFlags, MagicSearchAggregation aggregation) Create a sorted list of SearchResult which match with a filter word, from SipUri in this order : Contact's display name, address username, address domain and phone number.
void	getContactsListAsync(java.lang.String filter, java.lang.String domain, int sourceFlags, MagicSearchAggregation aggregation) This is the asynchronous version of getContacts(java.lang.String, java.lang.String, int).
java.lang.String	getDelimiter() Get the delimiter used for the search.
SearchResult[]	getLastSearch()
boolean	getLimitedSearch() Return whether or not the search is limited.
int	getMaxWeight() Get the maximum value used to calculate the weight in search.
int	getMinWeight() Get the minimum value used to calculate the weight in search.
long	getNativePointer() Gets the native pointer used by this class to make native method calls.
int	getSearchLimit() Get the number of maximum search result the search will return.
boolean	getUseDelimiter() Returns whether the delimiter is being used for the search.
java.lang.Object	getUserData() Gets the object stored in this object user's data
void	removeListener(MagicSearchListener listener)
void	resetSearchCache() Reset the cache to begin a new search.
void	setDelimiter(java.lang.String delimiter) Set the delimiter used to find matched filter word.
void	setLimitedSearch(boolean limited) Enable or disable the limited search.
void	setMaxWeight(int weight) Set the maximum value used to calculate the weight in search.
void	setMinWeight(int weight) Set the minimum value used to calculate the weight in search.
void	setSearchLimit(int limit) Set the number of the maximum SearchResult which will be returned.
void	setUseDelimiter(boolean enable) Enable or disable the delimiter in search.
void	setUserData(java.lang.Object data) Sets the object to store in this object user's data
java.lang.String	toString()

Method Detail

getDelimiter

@Nullable
java.lang.String getDelimiter()

Get the delimiter used for the search.

Returns:

the delimiter used to find matched filter word

setDelimiter

void setDelimiter(@Nullable
                  java.lang.String delimiter)

Set the delimiter used to find matched filter word.

Parameters:

delimiter - delimiter (example "-_.,")

getLastSearch

@NonNull
SearchResult[] getLastSearch()

Returns:

sorted list of

getLimitedSearch

boolean getLimitedSearch()

Return whether or not the search is limited.

Returns:

true if the search is limited, false otherwise

setLimitedSearch

void setLimitedSearch(boolean limited)

Enable or disable the limited search.

Parameters:

limited - true to limit the search, false otherwise

getMaxWeight

int getMaxWeight()

Get the maximum value used to calculate the weight in search.

Returns:

the maximum value used to calculate the weight in search

setMaxWeight

void setMaxWeight(int weight)

Set the maximum value used to calculate the weight in search.

Parameters:

weight - maximum weight

getMinWeight

int getMinWeight()

Get the minimum value used to calculate the weight in search.

Returns:

the minimum value used to calculate the weight in search

setMinWeight

void setMinWeight(int weight)

Set the minimum value used to calculate the weight in search.

Parameters:

weight - minimum weight

getSearchLimit

int getSearchLimit()

Get the number of maximum search result the search will return.

Returns:

the number of the maximum SearchResult which will be returned

setSearchLimit

void setSearchLimit(int limit)

Set the number of the maximum SearchResult which will be returned.

Parameters:

limit - the maximum number of SearchResult the search will return

getUseDelimiter

boolean getUseDelimiter()

Returns whether the delimiter is being used for the search.

Returns:

if the delimiter search is used

setUseDelimiter

void setUseDelimiter(boolean enable)

Enable or disable the delimiter in search.

Parameters:

enable - true to use the delimiter, false otherwise

getContactListFromFilter

@Deprecated
 @NonNull
SearchResult[] getContactListFromFilter(@Nullable
                                                              java.lang.String filter,
                                                              @Nullable
                                                              java.lang.String domain)

Deprecated. 22/03/2022 Use getContacts(java.lang.String, java.lang.String, int) instead.

Create a sorted list of SearchResult from SipUri, Contact name, Contact
displayname, Contact phone number, which match with a filter word The last item
list will be an address formed with "filter" if a proxy config exist During the
first search, a cache is created and used for the next search Use resetSearchCache()
to begin a new search.

Parameters:

filter - word we search

domain - domain which we want to search only

Returns:

sorted list of

getContactListFromFilterAsync

@Deprecated
void getContactListFromFilterAsync(@Nullable
                                               java.lang.String filter,
                                               @Nullable
                                               java.lang.String domain)

Deprecated. 22/03/2022 Use getContactsAsync(java.lang.String, java.lang.String, int) instead.

Create a sorted list of SearchResult asynchronous from SipUri, Contact name,
Contact displayname, Contact phone number, which match with a filter word The
last item list will be an address formed with "filter" if a proxy config exist
During the first search, a cache is created and used for the next search Use
resetSearchCache() to begin a new search.

Parameters:

filter - word we search

domain - domain which we want to search only null or "" for searching in
all contact "*" for searching in contact with sip SipUri "yourdomain" for
searching in contact from "yourdomain" domain

getContacts

@Deprecated
 @NonNull
SearchResult[] getContacts(@Nullable
                                                 java.lang.String filter,
                                                 @Nullable
                                                 java.lang.String domain,
                                                 int sourceFlags)

Deprecated. 08/04/2022 Use getContactsList(java.lang.String, java.lang.String, int, org.linphone.core.MagicSearchAggregation) instead.

Create a sorted list of SearchResult which match with a filter word, from
SipUri in this order : Contact's display name, address username, address domain
and phone number.

The last item list will be an address formed with "filter" if a proxy config
exist and requested in sourceFlags During the first search, a cache is created
and used for the next search Use resetSearchCache() to begin a new
search

Parameters:

filter - word we search

domain - domain which we want to search only

sourceFlags - Flags that specify where to search : MagicSearchSource

Returns:

sorted list of

getContactsAsync

@Deprecated
void getContactsAsync(@Nullable
                                  java.lang.String filter,
                                  @Nullable
                                  java.lang.String domain,
                                  int sourceFlags)

Deprecated. 08/04/2022 Use getContactsListAsync(java.lang.String, java.lang.String, int, org.linphone.core.MagicSearchAggregation) instead.

This is the asynchronous version of getContacts(java.lang.String, java.lang.String, int).

Create a sorted list of SearchResult which match with a filter word, from
SipUri in this order : Contact's display name, address username, address domain
and phone number. The last item list will be an address formed with "filter" if
a proxy config exist and requested in sourceFlags During the first search, a
cache is created and used for the next search Use resetSearchCache() to
begin a new search

Parameters:

filter - word we search

domain - domain which we want to search only

sourceFlags - Flags that specify where to search : MagicSearchSource

getContactsList

@NonNull
SearchResult[] getContactsList(@Nullable
                                        java.lang.String filter,
                                        @Nullable
                                        java.lang.String domain,
                                        int sourceFlags,
                                        MagicSearchAggregation aggregation)

Create a sorted list of SearchResult which match with a filter word, from
SipUri in this order : Contact's display name, address username, address domain
and phone number.

The last item list will be an address formed with "filter" if a proxy config
exist and requested in sourceFlags During the first search, a cache is created
and used for the next search Use resetSearchCache() to begin a new
search

Parameters:

filter - word we search

domain - domain which we want to search only

sourceFlags - Flags that specify where to search : MagicSearchSource

aggregation - a MagicSearchAggregation mode to indicate how to
merge results

Returns:

sorted list of

getContactsListAsync

void getContactsListAsync(@Nullable
                          java.lang.String filter,
                          @Nullable
                          java.lang.String domain,
                          int sourceFlags,
                          MagicSearchAggregation aggregation)

This is the asynchronous version of getContacts(java.lang.String, java.lang.String, int).

Create a sorted list of SearchResult which match with a filter word, from
SipUri in this order : Contact's display name, address username, address domain
and phone number. The last item list will be an address formed with "filter" if
a proxy config exist and requested in sourceFlags During the first search, a
cache is created and used for the next search Use resetSearchCache() to
begin a new search

Parameters:

filter - word we search

domain - domain which we want to search only

sourceFlags - Flags that specify where to search : MagicSearchSource

aggregation - a MagicSearchAggregation mode to indicate how to
merge results

resetSearchCache

void resetSearchCache()

Reset the cache to begin a new search.

addListener

void addListener(MagicSearchListener listener)

removeListener

void removeListener(MagicSearchListener listener)

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