Interface for accounts supporting IM search. More...

#include "ihavesearch.h"

Public Member Functions
virtual	~IHaveSearch ()

virtual QObject *	CreateSearchSession ()=0
	Creates a new search session. More...

virtual QString	GetDefaultSearchServer () const =0
	Returns a default search server for this account. More...

Detailed Description

Interface for accounts supporting IM search.

Some protocols may support searching users or other data via IM services themselves. XEP-0055 (Jabber Search), or typical ICQ oor Skype users search are the examples of this.

This interface should be implemented by accounts that support this feature if they want to provide it for Azoth users in an uniform way.

Definition at line 82 of file ihavesearch.h.

Constructor & Destructor Documentation

◆ ~IHaveSearch()

virtual LC::Azoth::IHaveSearch::~IHaveSearch ( )

inlinevirtual

Definition at line 85 of file ihavesearch.h.

Member Function Documentation

◆ CreateSearchSession()

virtual QObject* LC::Azoth::IHaveSearch::CreateSearchSession ( )

pure virtual

Creates a new search session.

This function is called by Azoth core or other plugins whenever a new search session is required. This function is expected to return an object implementing ISDSession.

The ownership of the returned object is passed to the caller.

Returns: An object implementing ISearchSession.

See also: ISearchSession

◆ GetDefaultSearchServer()

virtual QString LC::Azoth::IHaveSearch::GetDefaultSearchServer ( ) const

pure virtual

Returns a default search server for this account.

This function returns the default search server for this account. For example, an XMPP implementation would want to return the same server as the user uses.

Returns: The default search server for this account.

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