| 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().
MProtocolImGroup
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.
| Public Member Functions | |
|---|---|
| ~MProtocolImFeatures () | |
| MProtocolImConversation & | ImConversation () |
| MProtocolImGroup & | ImGroup () |
| MProtocolImInvitation & | ImInvitation () |
| MProtocolImSearch & | ImSearch () |
| MProtocolImFeatures * | NewL () |
| MProtocolImFeatures * | NewL ( TUid , TAny *) |
| void | SetHost ( MProtocolImDataHost &) |
| Protected Member Functions | |
|---|---|
| MProtocolImFeatures () | |
| Inherited Functions | |
|---|---|
| MXIMPBase::GetInterface(TInt32,TIfGetOps) | |
| MXIMPBase::GetInterface(TInt32,TIfGetOps)const | |
| MXIMPBase::GetInterfaceId()const | |
| MXIMPBase::~MXIMPBase() | |
| Inherited Enumerations | |
|---|---|
| MXIMPBase:@26 | |
| MXIMPBase:TIfGetOps | |
| Private Attributes | |
|---|---|
| TUid | iEcomDtorID |
| MProtocolImFeatures | ( | ) | [protected, inline] |
Default constructor to zero initialize the iEcomDtorID member.
| ~MProtocolImFeatures | ( | ) | [inline, virtual] |
Protected destructor. MXIMPProtocolConnection objects can't be deleted through this interface.
XIMP Framework disposes MXIMPProtocolConnection instances through MXIMPProtocolPlugin::ReleaseConnection().
| MProtocolImConversation & | ImConversation | ( | ) | [pure virtual] |
Gets reference to Im Conversation interface.
IM calls this method to retrieve a reference to protocols MProtocolImConversation interface implementation.
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() .
| MProtocolImGroup & | ImGroup | ( | ) | [inline, virtual] |
Gets reference to im group interface.
IM calls this method to retrieve a reference to protocols MProtocolImGroup interface implementation.
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() .
| MProtocolImInvitation & | ImInvitation | ( | ) | [inline, virtual] |
Gets reference to im groups interface.
IM calls this method to retrieve a reference to protocols MProtocolImInvitation interface implementation.
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() .
| MProtocolImSearch & | ImSearch | ( | ) | [inline, virtual] |
Gets reference to im search interface.
IM calls this method to retrieve a reference to protocols MProtocolImSearch interface implementation.
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() .
| 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.
| MProtocolImFeatures * | NewL | ( | TUid | aImplementationUid, |
| 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.
| void | SetHost | ( | MProtocolImDataHost & | aHost | ) | [pure virtual] |
Sets data host.
IM calls this method to specify datahost.
| MProtocolImDataHost & aHost | data host |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.