Linphone.MagicSearch Class Reference

Inheritance diagram for Linphone.MagicSearch:

Public Member Functions
IEnumerable< Linphone.SearchResult >	GetContactsList (string filter, string domain, int sourceFlags, Linphone.MagicSearchAggregation aggregation)
void	GetContactsListAsync (string filter, string domain, int sourceFlags, Linphone.MagicSearchAggregation aggregation)
void	ResetSearchCache ()

Properties
MagicSearchListener	Listener [get, set]
string	Delimiter [get, set]
IEnumerable< Linphone.SearchResult >	LastSearch [get]
bool	LimitedSearch [get, set]
uint	MaxWeight [get, set]
uint	MinWeight [get, set]
uint	SearchLimit [get, set]
bool	UseDelimiter [get, set]

Additional Inherited Members
Protected Member Functions inherited from Linphone.LinphoneObject
static String	linphone_pointer_to_string (IntPtr ptr)
static IntPtr	linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)
IntPtr	StringArrayToBctbxList (IEnumerable< string > stringlist)
void	CleanStringArrayPtrs (IntPtr l)

Detailed Description

A Linphone.MagicSearch is used to search for contacts from various sources:

-Linphone.FriendList -Ldap connection (see Linphone.Ldap) -Remote CardDAV server (see Linphone.CardDavParams) -Call logs, conferences and existing chat rooms.

See : Linphone.MagicSearch.ContactsListAsync

Member Function Documentation

IEnumerable<Linphone.SearchResult> Linphone.MagicSearch.GetContactsList ( string  filter, string  domain, int  sourceFlags, Linphone.MagicSearchAggregation  aggregation  )

inline

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 Linphone.MagicSearch.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 : Linphone.MagicSearchSource
aggregation	a Linphone.MagicSearchAggregation mode to indicate how to merge results

Returns

sorted list of A list of Linphone.SearchResult objects.

void Linphone.MagicSearch.GetContactsListAsync ( string  filter, string  domain, int  sourceFlags, Linphone.MagicSearchAggregation  aggregation  )

inline

This is the asynchronous version of linphone_magic_search_get_contacts().

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 Linphone.MagicSearch.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 : Linphone.MagicSearchSource
aggregation	a Linphone.MagicSearchAggregation mode to indicate how to merge results

void Linphone.MagicSearch.ResetSearchCache ( )

inline

Reset the cache to begin a new search.

Property Documentation

string Linphone.MagicSearch.Delimiter

getset

Get the delimiter used for the search.

Returns

the delimiter used to find matched filter word

IEnumerable<Linphone.SearchResult> Linphone.MagicSearch.LastSearch

get

Returns

sorted list of A list of Linphone.SearchResult objects.

bool Linphone.MagicSearch.LimitedSearch

getset

Returns whether or not the search is limited or not.

If not limited, the Linphone.MagicSearch.SearchLimit won't be applied.

Returns

true if the search is limited, false otherwise

uint Linphone.MagicSearch.MaxWeight

getset

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

Returns

the maximum value used to calculate the weight in search

uint Linphone.MagicSearch.MinWeight

getset

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

Returns

the minimum value used to calculate the weight in search

uint Linphone.MagicSearch.SearchLimit

getset

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

The returned value doesn't take into account the "limited search" mode, so make sure to check Linphone.MagicSearch.LimitedSearch result as well.

Returns

the number of the maximum Linphone.SearchResult which will be returned if magic search is in limited mode.

bool Linphone.MagicSearch.UseDelimiter

getset

Returns whether the delimiter is being used for the search.

Returns

if the delimiter search is used

---

The documentation for this class was generated from the following file:

• LinphoneWrapper.cs