MProtocolImFeatures Class Reference

class MProtocolImFeatures : public MXIMPBase

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().

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

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.

Inherits from

Constructor & Destructor Documentation

MProtocolImFeatures()

MProtocolImFeatures()[protected, inline]

Default constructor to zero initialize the iEcomDtorID member.

~MProtocolImFeatures()

~MProtocolImFeatures()[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:

ImGroup()

MProtocolImGroup &ImGroup()[inline, 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:

ImInvitation()

MProtocolImInvitation &ImInvitation()[inline, 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:

ImSearch()

MProtocolImSearch &ImSearch()[inline, 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:

NewL()

MProtocolImFeatures *NewL()[static, inline]

Factory method to instantiate MProtocolImFeatures.

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 *)

MProtocolImFeatures *NewL(TUidaImplementationUid,
TAny *aInitParams
)[static, inline]

Factory method to instantiate MProtocolImFeatures 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 aImplementationUidImplementation UID of the plugin to be loaded
TAny * aInitParamsInitialization parameters

SetHost(MProtocolImDataHost &)

voidSetHost(MProtocolImDataHost &aHost)[pure virtual]

Sets data host.

IM calls this method to specify datahost.

Since
S60 v5.0

Parameters

MProtocolImDataHost & aHostdata host

Member Data Documentation

TUid iEcomDtorID

TUid iEcomDtorID[private]

Unique instance identifier key