Symbian^3 Application Developer Library >

MProtocolPresentityGroupsDataHost Class Reference

class MProtocolPresentityGroupsDataHost : public MXIMPBase

Interface for managing cached presentity group information.

Interface used by protocol adaptations to manage manage presentity group information and presentity group member information in XIMP Framework internal data cache.

This interface is implemented by XIMP Framework. Protocol adaptation can obtain reference to this interface from MXIMPProtocolConnectionHost interface.

For each separated protocol connection, protocol adaptation must use the specific MProtocolPresentityGroupsDataHost instance, what is received from the connection specific MXIMPProtocolConnectionHost instance.

Since
S60 v3.2

Inherits from

Public Member Functions
TXIMPRequestId HandlePresentityGroupContentL ( MXIMPIdentity *, MXIMPObjectCollection *)
TXIMPRequestId HandlePresentityGroupCreatedL ( MPresentityGroupInfo *)
TXIMPRequestId HandlePresentityGroupDeletedL ( MXIMPIdentity *)
TXIMPRequestId HandlePresentityGroupDisplayNameUpdatedL ( MPresentityGroupInfo *)
TXIMPRequestId HandlePresentityGroupListL ( MXIMPObjectCollection *)
TXIMPRequestId HandlePresentityGroupMemberAddedL ( MXIMPIdentity *, MPresentityGroupMemberInfo *)
TXIMPRequestId HandlePresentityGroupMemberDisplayNameUpdatedL ( MXIMPIdentity *, MPresentityGroupMemberInfo *)
TXIMPRequestId HandlePresentityGroupMemberRemovedL ( MXIMPIdentity *, MXIMPIdentity *)
const MXIMPDataSubscriptionState & PresentityGroupContentDataSubscriptionState (const MXIMPIdentity &)
const MXIMPDataSubscriptionState & PresentityGroupListDataSubscriptionState ()
TXIMPRequestId SetPresentityGroupContentDataSubscriptionStateL ( MXIMPIdentity *, MXIMPDataSubscriptionState *, MXIMPStatus *)
TXIMPRequestId SetPresentityGroupListDataSubscriptionStateL ( MXIMPDataSubscriptionState *, MXIMPStatus *)
Protected Member Functions
~MProtocolPresentityGroupsDataHost ()

Constructor & Destructor Documentation

~MProtocolPresentityGroupsDataHost()

~MProtocolPresentityGroupsDataHost ( ) [protected, inline, virtual]

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

Member Functions Documentation

HandlePresentityGroupContentL(MXIMPIdentity *, MXIMPObjectCollection *)

TXIMPRequestId HandlePresentityGroupContentL ( MXIMPIdentity * aGroupId,
MXIMPObjectCollection * aGroupMembers
) [pure virtual]

Notifies XIMP Framework from presentity group contents.

Protocol adaptation implementation can call this method to notify XIMP Framework from presentity group content. XIMP Framework calculates the changes (added and removed group members) compared to previous presentity group content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the object collection and all objects contained within, if the method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL argument(s) were provided.

Parameters

MXIMPIdentity * aGroupId MXIMPIdentity object identifying the presentity group of which content is notified here.
MXIMPObjectCollection * aGroupMembers MXIMPObjectCollection object containing zero or more MPresentityGroupMemberInfo objects. Each contained MPresentityGroupMemberInfo shall present single presentity group member, within the presentity group.

HandlePresentityGroupCreatedL(MPresentityGroupInfo *)

TXIMPRequestId HandlePresentityGroupCreatedL ( MPresentityGroupInfo * aGroupInfo ) [pure virtual]

Notifies XIMP Framework from new presentity group list entry.

Protocol adaptation implementation can call this method to notify XIMP Framework from new presentity group list entry. XIMP Framework calculates the change, from previous presentity group list content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the argument(s), if method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL argument(s) were provided.

Parameters

MPresentityGroupInfo * aGroupInfo MPresentityGroupInfo object holding information about new presentity group entry. New presentity group is added to the presentity group list.

HandlePresentityGroupDeletedL(MXIMPIdentity *)

TXIMPRequestId HandlePresentityGroupDeletedL ( MXIMPIdentity * aGroupId ) [pure virtual]

Notifies XIMP Framework from deletion of existing presentity group.

Protocol adaptation implementation can call this method to notify XIMP Framework from deletion of existing presentity group. XIMP Framework calculates the change, from previous presentity group list content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the argument(s), if method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL argument(s) were provided.

Parameters

MXIMPIdentity * aGroupId MXIMPIdentity object identifying the presentity group which were deleted and thus needs to be removed from presentity group list.

HandlePresentityGroupDisplayNameUpdatedL(MPresentityGroupInfo *)

TXIMPRequestId HandlePresentityGroupDisplayNameUpdatedL ( MPresentityGroupInfo * aGroupInfo ) [pure virtual]

Notifies XIMP Framework from update of existing presentity group displayname.

Protocol adaptation implementation can call this method to notify XIMP Framework from update of existing presentity group displayname. XIMP Framework calculates the change, from previous presentity group list content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the argument(s), if method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL argument(s) were provided.

Parameters

MPresentityGroupInfo * aGroupInfo MPresentityGroupInfo object identifying the presentity group and new displayname for the group.

HandlePresentityGroupListL(MXIMPObjectCollection *)

TXIMPRequestId HandlePresentityGroupListL ( MXIMPObjectCollection * aGroupList ) [pure virtual]

Notifies XIMP Framework from presentity group list contents.

Protocol adaptation implementation can call this method to notify XIMP Framework from complete presentity group list content. XIMP Framework calculates the changes (new and removed presentity groups) compared to previous presence presentity group list content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the object collection and all objects contained within, if the method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL argument(s) were provided.

Parameters

MXIMPObjectCollection * aGroupList MXIMPObjectCollection object containing zero or more MPresentityGroupInfo objects. Each contained MPresentityGroupInfo shall present single presentity group within the presentity group list.

HandlePresentityGroupMemberAddedL(MXIMPIdentity *, MPresentityGroupMemberInfo *)

TXIMPRequestId HandlePresentityGroupMemberAddedL ( MXIMPIdentity * aGroupId,
MPresentityGroupMemberInfo * aGroupMember
) [pure virtual]

Notifies XIMP Framework from new presentity group member entry.

Protocol adaptation implementation can call this method to notify XIMP Framework from new presentity group member entry. XIMP Framework calculates the change, from previous presentity group content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the argument(s), if method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL argument(s) were provided.

Parameters

MXIMPIdentity * aGroupId MXIMPIdentity object identifying the presentity group to where the group member is added.
MPresentityGroupMemberInfo * aGroupMember MPresentityGroupMemberInfo object holding information about new presentity group member entry. New presentity group member is added to the presentity group content.

HandlePresentityGroupMemberDisplayNameUpdatedL(MXIMPIdentity *, MPresentityGroupMemberInfo *)

TXIMPRequestId HandlePresentityGroupMemberDisplayNameUpdatedL ( MXIMPIdentity * aGroupId,
MPresentityGroupMemberInfo * aGroupMember
) [pure virtual]

Notifies XIMP Framework from displayname update of existing presentity group member.

Protocol adaptation implementation can call this method to notify XIMP Framework from displayname update of existing presentity group member. XIMP Framework calculates the change, from previous presentity group content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the argument(s), if method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL argument(s) were provided.

Parameters

MXIMPIdentity * aGroupId MXIMPIdentity object identifying the presentity group which member displayname to update.
MPresentityGroupMemberInfo * aGroupMember MPresentityGroupMemberInfo object identifying the presentity group member and its new displayname.

HandlePresentityGroupMemberRemovedL(MXIMPIdentity *, MXIMPIdentity *)

TXIMPRequestId HandlePresentityGroupMemberRemovedL ( MXIMPIdentity * aGroupId,
MXIMPIdentity * aGroupMemberId
) [pure virtual]

Notifies XIMP Framework from remove of existing presentity group member.

Protocol adaptation implementation can call this method to notify XIMP Framework from remove of existing presentity group member. XIMP Framework calculates the change, from previous presentity group content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the argument(s), if method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL argument(s) were provided.

Parameters

MXIMPIdentity * aGroupId MXIMPIdentity object identifying the presentity group from where to remove the group member.
MXIMPIdentity * aGroupMemberId MXIMPIdentity object identifying the presentity group member which to remove from the presentity group.

PresentityGroupContentDataSubscriptionState(const MXIMPIdentity &)

const MXIMPDataSubscriptionState & PresentityGroupContentDataSubscriptionState ( const MXIMPIdentity & aGroupId ) const [pure virtual]

Gets data subscription state for presentity group.

Protocol adaptation can call this method to retrieve given presentity groups content subscription state. Protocol adaptation can use data subscription state information, to optimize its own processing and network trafic amount.

Parameters

const MXIMPIdentity & aGroupId

PresentityGroupListDataSubscriptionState()

const MXIMPDataSubscriptionState & PresentityGroupListDataSubscriptionState ( ) const [pure virtual]

Gets data subscription state for presentity group list.

Protocol adaptation can call this method to retrieve presentity group lists data subscription state. Protocol adaptation can use data subscription state information, to optimize its own processing and network trafic amount.

SetPresentityGroupContentDataSubscriptionStateL(MXIMPIdentity *, MXIMPDataSubscriptionState *, MXIMPStatus *)

TXIMPRequestId SetPresentityGroupContentDataSubscriptionStateL ( MXIMPIdentity * aGroupId,
MXIMPDataSubscriptionState * aSubscriptionState,
MXIMPStatus * aStatus
) [pure virtual]

Updates data subscription state for presentity group content.

Updates data subscription state for presentity group content. XIMP Framework calculates the subscription state change, from previous presentity group content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the argument(s), if method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL subscription state argument was provided.

Parameters

MXIMPIdentity * aGroupId MXIMPIdentity object identifying the presentity group of which data subscription state is updated here.
MXIMPDataSubscriptionState * aSubscriptionState New data subscription state for presentity group .
MXIMPStatus * aStatus Optional status object describing the the reason, why protocol adaptation updated data item subscription state. Given status object is passed to clients through data item specific data change event. NULL value is accepted.

SetPresentityGroupListDataSubscriptionStateL(MXIMPDataSubscriptionState *, MXIMPStatus *)

TXIMPRequestId SetPresentityGroupListDataSubscriptionStateL ( MXIMPDataSubscriptionState * aSubscriptionState,
MXIMPStatus * aStatus
) [pure virtual]

Updates data subscription state for presentity group list.

Updates data subscription state for presentity group list. XIMP Framework calculates the subscription state change, from previous presentity group list, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the argument(s), if method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL subscription state argument was provided.

Parameters

MXIMPDataSubscriptionState * aSubscriptionState New data subscription state for presentity group list.
MXIMPStatus * aStatus Optional status object describing the the reason, why protocol adaptation updated data item subscription state. Given status object is passed to clients through data item specific data change event. NULL value is accepted.

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.