1 /*

     2 * Copyright (c) 2006, 2007 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Presentity group handling interface for clients use.

    15 *

    16 */

    17 #ifndef MyPresentityGroupsStub_H

    18 #define MyPresentityGroupsStub_H

    19 

    20 #include <e32std.h>

    21 #include <ximpbase.h>

    22 #include <presentitygroups.h>

    23 

    24 class MXIMPIdentity;

    25 

    26 

    27 /**

    28  * Presentity group handling interface for clients use.

    29  * Interface is implemented by the XIMP Framework.

    30  *

    31  * MPresentityGroups provides services for

    32  * XIMP Framework clients to manage presentity groups

    33  * and presentity group members. It provides also services

    34  * to subscribe notifications from presentity group list changes

    35  * and from individual presentity group changes.

    36  *

    37  * Client can retrieve MPresentityGroups interface from

    38  * MXIMPContext interface.

    39  *

    40  * @ingroup ximppresmanagementapi

    41  * @since S60 v3.2

    42  */

    43 class MyPresentityGroupsStub : public MPresentityGroups, public CBase

    44     {

    45 

    46 public:		

    47     /**

    48      * Protected destructor.

    49      * Object instancies can't be deleted via this interface.

    50      */

    51     ~MyPresentityGroupsStub();

    52 

    53 

    54     /**

    55      * Subscribes presentity group list notifications.

    56      *

    57      * @return The request ID identifying the issued request.

    58      */

    59     TXIMPRequestId SubscribePresentityGroupListL() ;

    60 

    61 

    62 

    63     /**

    64      * Unsubscribes presentity group list notifications.

    65      *

    66      * @return The request ID identifying the issued request.

    67      */

    68     TXIMPRequestId UnsubscribePresentityGroupListL() ;

    69 

    70 

    71 

    72     /**

    73      * Creates presentity group.

    74      *

    75      * Note: Remote service may alter given presentity group ID and

    76      *       display name. Altered ID and display names are signalled back

    77      *       to client through MXIMPRequestCompleteEvent.

    78      *

    79      * @param [in] aGroupId

    80      *        Identification for presentity group.

    81      *

    82      * @param [in] aDisplayName

    83      *        Presentity group display name.

    84      *

    85      *

    86      * @return The request ID identifying the issued request.

    87      */

    88     TXIMPRequestId CreatePresentityGroupL(

    89                     const MXIMPIdentity& aGroupId,

    90                     const TDesC16& aDisplayName ) ;

    91 

    92 

    93     /**

    94      * Deletes presentity group.

    95      *

    96      * @param [in] aGroupId

    97      *        Identification for presentity group.

    98      *

    99      * @return The request ID identifying the issued request.

   100      */

   101     TXIMPRequestId DeletePresentityGroupL(

   102                     const MXIMPIdentity& aGroupId ) ;

   103 

   104 

   105 

   106     /**

   107      * Updates presentity group display name.

   108      *

   109      * Note: Remote service may alter given presentity group display name.

   110      *       Altered display name is signalled back to client through

   111      *       MXIMPRequestCompleteEvent.

   112      *

   113      * @param [in] aGroupId

   114      *        Identification for presentity group.

   115      *

   116      * @param [in] aDisplayName

   117      *        New display name for the presentity group.

   118      *

   119      * @return The request ID identifying the issued request.

   120      */

   121     TXIMPRequestId UpdatePresentityGroupDisplayNameL(

   122                     const MXIMPIdentity& aGroupId,

   123                     const TDesC16& aDisplayName ) ;

   124 

   125 

   126 

   127 public: //Prototypes for presentity group member management requests

   128 

   129 

   130     /**

   131      * Subscribes presentity group content notifications.

   132      *

   133      * @param [in] aGroupId

   134      *        Identification for presentity group for which

   135      *        to subscribe content notifications.

   136      *

   137      * @return The request ID identifying the issued request.

   138      */

   139     TXIMPRequestId SubscribePresentityGroupContentL(

   140                     const MXIMPIdentity& aGroupId ) ;

   141 

   142 

   143     /**

   144      * Unsubscribes presentity group content notifications.

   145      *

   146      * @param [in] aGroupId

   147      *        Identification for presentity group for which

   148      *        content notification subscription to terminate.

   149      *

   150      * @return The request ID identifying the issued request.

   151      */

   152     TXIMPRequestId UnsubscribePresentityGroupContentL(

   153                     const MXIMPIdentity& aGroupId ) ;

   154 

   155 

   156     /**

   157      * Requests the protocol to add new member to

   158      * identified presentity group.

   159      *

   160      *

   161      * Note: Remote service may alter given member and

   162      *       display name. Altered ID and display names

   163      *       are signalled back to client through MXIMPRequestCompleteEvent.

   164      *

   165      * @param [in] aGroupId

   166      *        Identification of the presentity group where to

   167      *        add new member.

   168      *

   169      * @param [in] aMemberId

   170      *        Identification of the new member.

   171      *

   172      * @param [in] aMemberDisplayName

   173      *        Display name for the added member.

   174      *

   175      * @return The request ID identifying the issued request.

   176      */

   177     TXIMPRequestId AddPresentityGroupMemberL(

   178                     const MXIMPIdentity& aGroupId,

   179                     const MXIMPIdentity& aMemberId,

   180                     const TDesC16& aMemberDisplayName ) ;

   181 

   182 

   183     /**

   184      * Requests the XIMPFw to remove member from

   185      * identified presentity group.

   186      *

   187      * @param [in] aGroupId

   188      *        Identification of the presentity group from

   189      *        where to remove member.

   190      *

   191      * @param [in] aMemberId

   192      *        Identification of the member to remove.

   193      *

   194      * @return The request ID identifying the issued request.

   195      */

   196     TXIMPRequestId RemovePresentityGroupMemberL(

   197                     const MXIMPIdentity& aGroupId,

   198                     const MXIMPIdentity& aMemberId ) ;

   199 

   200 

   201 

   202     /**

   203      * Requests the XIMPFw to update presentity group

   204      * member display name.

   205      *

   206      * Note: Remote service may alter given presentity group member

   207      *       display name. Altered display name is signalled back

   208      *       to client through MXIMPRequestCompleteEvent.

   209      *

   210      * @param [in] aGroupId

   211      *        Identification for presentity group.

   212      *

   213      * @param [in] aMemberId

   214      *        Identification of the member which display

   215      *        name to update.

   216      *

   217      * @param [in] aMemberDisplayName

   218      *        New display name for the member.

   219      *

   220      * @return The request ID identifying the issued request.

   221      */

   222     TXIMPRequestId UpdatePresentityGroupMemberDisplayNameL(

   223                     const MXIMPIdentity& aGroupId,

   224                     const MXIMPIdentity& aMemberId,

   225                     const TDesC16& aMemberDisplayName ) ;

   226                     

   227 	const TAny* GetInterface(

   228                         TInt32 aInterfaceId,

   229                         TIfGetOps aOps ) const;

   230 

   231     TAny* GetInterface(

   232                         TInt32 aInterfaceId,

   233                         TIfGetOps aOps );

   234 

   235     TInt32 GetInterfaceId() const;                    

   236 

   237     };

   238 

   239 

   240 

   241 #endif // MyPresentityGroupsStub_H

   242 

   243 

   244