Collapse all Symbian^3 Application Developer Library

CProtocolImFeatures Class Reference

class CProtocolImFeatures : public CBase

Interface for IM protocol connection object. Interface must be implemented by a XIMP Framework plug-ins.

This interface models a connection from XIMP Framework to single remote IM service, over certain IM protocol implementation. XIMP Framework calls methods on this interface based on XIMP Framework client requests.

XIMP Framework retrieves MXIMPProtocolConnection instances through MXIMPProtocolPlugin::AcquireConnectionL(). Same MXIMPProtocolConnection instance may be returned by multiple MXIMPProtocolPlugin::AcquireConnectionL() calls. In this case XIMP Framework shares MXIMPProtocolConnection instance by multiple clients, and MXIMPProtocolConnection lifetime is extended over utilizing client sessions. When last utilizing client session is succesfully closed with MXIMPProtocolConnection::CloseSession() , XIMP Framework disposes the MXIMPProtocolConnection instance with MXIMPProtocolPlugin::ReleaseConnection().

CProtocolImFeatures implementation must provide access following feature specific sub-interfaces:

MProtocolImGroup
MProtocolImConversation
MProtocolImInvitation
MProtocolImSearch

Each provided sub-interface defines a set of its own im managements requests, relating to im groups,search,im and im invitation. IM calls these sub-interfaces to request on spesific im requests from protocol connection.

MXIMPProtocolConnectionHost

Since: S60

Inherits from

CProtocolImFeatures
- CBase

Public Member Functions
	~CProtocolImFeatures ()
MProtocolImConversation &	ImConversation ()
MProtocolImGroup &	ImGroup ()
MProtocolImInvitation &	ImInvitation ()
MProtocolImSearch &	ImSearch ()
CProtocolImFeatures *	NewL ()
CProtocolImFeatures *	NewL ( TUid , TAny *)
void	SetHost ( MProtocolImDataHost &)
TInt	SupportedSubInterfaces ()

Protected Member Functions
	CProtocolImFeatures ()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Public Member Enumerations
enum	KImFeatureSubInterfaces { EProtocolImGroup = 1, EProtocolImConversation = 2, EProtocolImInvitation = 4, EProtocolImSearch = 8 }

Private Attributes
TUid	iEcomDtorID

Constructor & Destructor Documentation

CProtocolImFeatures()

CProtocolImFeatures

(

)

[protected, inline]

Default constructor to zero initialize the iEcomDtorID member.

~CProtocolImFeatures()

~CProtocolImFeatures

(

)

[inline, virtual]

Protected destructor. MXIMPProtocolConnection objects can't be deleted through this interface.

XIMP Framework disposes MXIMPProtocolConnection instances through MXIMPProtocolPlugin::ReleaseConnection().

Member Functions Documentation

ImConversation()

MProtocolImConversation &

ImConversation

(

)

[pure virtual]

Gets reference to Im Conversation interface.

IM calls this method to retrieve a reference to protocols MProtocolImConversation interface implementation.

Call and interface lifetime convention:

This method isn't called before protocol has signalled MXIMPProtocolConnection::OpenSessionL() succesfully completed.

XIMP Framework may call this method multiple times for for one MXIMPProtocolConnection instance.

Each call per one MXIMPProtocolConnection instance, must return reference to same interface instance.

Returned interface instance must remain valid (usable) untill last client session, using originating im protocol connection is successfully closed with MXIMPProtocolConnection::CloseSession() .

ImGroup()

MProtocolImGroup &

ImGroup

(

)

[pure virtual]

Gets reference to im group interface.

IM calls this method to retrieve a reference to protocols MProtocolImGroup interface implementation.

Call and interface lifetime convention:

This method isn't called before protocol has signalled MXIMPProtocolConnection::OpenSessionL() succesfully completed.

XIMP Framework may call this method multiple times for for one MXIMPProtocolConnection instance.

Each call per one MXIMPProtocolConnection instance, must return reference to same interface instance.

Returned interface instance must remain valid (usable) untill last client session, using originating im protocol connection is successfully closed with MXIMPProtocolConnection::CloseSession() .

ImInvitation()

MProtocolImInvitation &

ImInvitation

(

)

[pure virtual]

Gets reference to im groups interface.

IM calls this method to retrieve a reference to protocols MProtocolImInvitation interface implementation.

Call and interface lifetime convention:

This method isn't called before protocol has signalled MXIMPProtocolConnection::OpenSessionL() succesfully completed.

XIMP Framework may call this method multiple times for for one MXIMPProtocolConnection instance.

Each call per one MXIMPProtocolConnection instance, must return reference to same interface instance.

Returned interface instance must remain valid (usable) untill last client session, using originating im protocol connection is successfully closed with MXIMPProtocolConnection::CloseSession() .

ImSearch()

MProtocolImSearch &

ImSearch

(

)

[pure virtual]

Gets reference to im search interface.

IM calls this method to retrieve a reference to protocols MProtocolImSearch interface implementation.

Call and interface lifetime convention:

This method isn't called before protocol has signalled MXIMPProtocolConnection::OpenSessionL() succesfully completed.

XIMP Framework may call this method multiple times for for one MXIMPProtocolConnection instance.

Each call per one MXIMPProtocolConnection instance, must return reference to same interface instance.

Returned interface instance must remain valid (usable) untill last client session, using originating im protocol connection is successfully closed with MXIMPProtocolConnection::CloseSession() .

NewL()

CProtocolImFeatures *

NewL

(

)

[static, inline]

Factory method to instantiate CProtocolImFeatures .

Factory method to instantiate platform default MXIMPClient implementation through the ECom. If the default IM Feature isn't supported in the platform, leaves with errorcode signalled from ECom.

NewL(TUid, TAny *)

CProtocolImFeatures *	NewL	(	TUid	aImplementationUid,
			TAny *	aInitParams
		)	[static, inline]

Factory method to instantiate CProtocolImFeatures with initial parameters and specified implementation UID.

If the specified IM Feature isn't supported in the platform, leaves with errorcode signalled from ECom.

Since: S60 v5.0

Parameters

TUid aImplementationUid	Implementation UID of the plugin to be loaded
TAny * aInitParams	Initialization parameters

SetHost(MProtocolImDataHost &)

void

SetHost

(

MProtocolImDataHost &

aHost

)

[pure virtual]

Sets data host.

IM calls this method to specify datahost.

Since: S60 v5.0

Parameters

MProtocolImDataHost & aHost

data host

SupportedSubInterfaces()

TInt

SupportedSubInterfaces

(

)

const [pure virtual]

Returns bitfield representing supported sub-interfaces. Sub-interfaces are defined with KImFeatureSubInterfaces. If client tries to access non-supported sub-interface, panic will occur.

Member Enumerations Documentation

Enum KImFeatureSubInterfaces

All possible subinterfaces plugin may support.

Enumerators

EProtocolImGroup = 1
EProtocolImConversation = 2
EProtocolImInvitation = 4
EProtocolImSearch = 8

Member Data Documentation

TUid iEcomDtorID

TUid

iEcomDtorID

[private]

Unique instance identifier key