Collapse all Symbian^3 Application Developer Library

MPresentityGroupListEvent Class Reference

class MPresentityGroupListEvent : public MXIMPBase

Event interface for presentity group list content.

This interface is implemented by the XIMP Framework and event object is signalled to registered client observers through MXIMPContextObserver observer interface. This event notifies clients about changes in presentity group list content.

Clients subscribe for this event with MPresentityGroups::SubscribePresentityGroupListL() .

XIMP Framework signals this event when:

New subscribed data is received from protocol.
Data item data subscription status is updated by protocol adaptation.
When client unsubscribes the data item.
XIMP Framework generates initial data notification to client automatically after clients subscription, when the initial data comes available from protocol.

Since: S60 v3.2

Inherits from

MPresentityGroupListEvent
- MXIMPBase

Public Member Functions
const MPresentityGroupInfo &	CurrentGroup ( TInt )
TInt	CurrentGroupsCount ()
const MXIMPDataSubscriptionState &	DataSubscriptionState ()
const MPresentityGroupInfo &	DisappearedGroup ( TInt )
TInt	DisappearedGroupsCount ()
const MPresentityGroupInfo &	NewGroup ( TInt )
TInt	NewGroupsCount ()
const MPresentityGroupInfo &	UpdatedGroup ( TInt )
TInt	UpdatedGroupsCount ()

Protected Member Functions
	~MPresentityGroupListEvent ()

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

Inherited Enumerations
	MXIMPBase:@186
	MXIMPBase:TIfGetOps

Constructor & Destructor Documentation

~MPresentityGroupListEvent()

~MPresentityGroupListEvent

(

)

[protected, inline, virtual]

Protected destructor. Object instancies can't be deleted via this interface.

Member Functions Documentation

CurrentGroup(TInt)

const MPresentityGroupInfo &

CurrentGroup

(

TInt

aIndex

)

const [pure virtual]

Gets presentity group entry by index.

Note that, current information is signalled only when the client refreshes the event data from XIMP Framework cache, by re-issuing the data subscription.

Parameters

TInt aIndex

The index of the presentity group entry to get.

CurrentGroupsCount()

TInt

CurrentGroupsCount

(

)

const [pure virtual]

Gets count of current presentity groups.

Note that, current information is signalled only when the client refreshes the event data from XIMP Framework cache, by re-issuing the data subscription.

DataSubscriptionState()

const MXIMPDataSubscriptionState &

DataSubscriptionState

(

)

const [pure virtual]

Returns subscription state object holding information about data items data subscription state.

DisappearedGroup(TInt)

const MPresentityGroupInfo &

DisappearedGroup

(

TInt

aIndex

)

const [pure virtual]

Gets presentity group entry by index.

Parameters

TInt aIndex

The index of the presentity group entry to get.

DisappearedGroupsCount()

TInt

DisappearedGroupsCount

(

)

const [pure virtual]

Gets count of disappeared presentity groups.

NewGroup(TInt)

const MPresentityGroupInfo &

NewGroup

(

TInt

aIndex

)

const [pure virtual]

Gets presentity group entry by index.

Parameters

TInt aIndex

The index of the presentity group entry to get.

NewGroupsCount()

TInt

NewGroupsCount

(

)

const [pure virtual]

Gets count of new presentity groups.

UpdatedGroup(TInt)

const MPresentityGroupInfo &

UpdatedGroup

(

TInt

aIndex

)

const [pure virtual]

Gets presentity group entry by index.

Parameters

TInt aIndex

The index of the presentity group entry to get.

UpdatedGroupsCount()

TInt

UpdatedGroupsCount

(

)

const [pure virtual]

Gets count of updated presentity groups.