Collapse all Symbian^3 Product Developer Library

MProtocolPresenceFeatures Class Reference

class MProtocolPresenceFeatures : public MXIMPBase

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

This interface models a connection from XIMP Framework to single remote presence service, over certain presence 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().

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

Each provided sub-interface defines a set of its own presence managements requests, relating to presence watching and subscribing, presence publication, presentity groups and presentity group member management and to presence authorizations. XIMP Framework calls these sub-interfaces to request on spesific presence requests from protocol connection.

MXIMPProtocolConnectionHost

Since: S60 v3.2

Inherits from

MProtocolPresenceFeatures
- MXIMPBase

Public Member Functions
MProtocolPresenceAuthorization &	PresenceAuthorization()
MProtocolPresencePublishing &	PresencePublishing()
MProtocolPresenceWatching &	PresenceWatching()
MProtocolPresentityGroups &	PresentityGroups()

Protected Member Functions
	~MProtocolPresenceFeatures()

Inherited Functions
	MXIMPBase::GetInterface(TInt32,TIfGetOps)
	MXIMPBase::GetInterface(TInt32,TIfGetOps)const
	MXIMPBase::GetInterfaceId()const
	MXIMPBase::~MXIMPBase()

Inherited Enumerations
	MXIMPBase:@26
	MXIMPBase:TIfGetOps

Constructor & Destructor Documentation

~MProtocolPresenceFeatures()

~MProtocolPresenceFeatures

(

)

[protected, inline, virtual]

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

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

Member Functions Documentation

PresenceAuthorization()

MProtocolPresenceAuthorization &

PresenceAuthorization

(

)

[pure virtual]

Gets reference to presence authorization interface.

XIMP Framework calls this method to retrieve a reference to protocols MProtocolPresenceAuthorization 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 presence protocol connection is successfully closed with MXIMPProtocolConnection::CloseSession().

PresencePublishing()

MProtocolPresencePublishing &

PresencePublishing

(

)

[pure virtual]

Gets reference to presence publishing interface.

XIMP Framework calls this method to retrieve a reference to protocols MProtocolPresencePublishing 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 presence protocol connection is successfully closed with MXIMPProtocolConnection::CloseSession().

PresenceWatching()

MProtocolPresenceWatching &

PresenceWatching

(

)

[pure virtual]

Gets reference to presence watching interface.

XIMP Framework calls this method to retrieve a reference to protocols MProtocolPresenceWatching 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 presence protocol connection is successfully closed with MXIMPProtocolConnection::CloseSession().

PresentityGroups()

MProtocolPresentityGroups &

PresentityGroups

(

)

[pure virtual]

Gets reference to presentity groups interface.

XIMP Framework calls this method to retrieve a reference to protocols MProtocolPresentityGroups 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 presence protocol connection is successfully closed with MXIMPProtocolConnection::CloseSession().