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:  Interface for presence grant request info object.

    15 *

    16 */

    17 

    18 #ifndef MXIMPFWPRESENCEGRANTREQUESTINFO_H

    19 #define MXIMPFWPRESENCEGRANTREQUESTINFO_H

    20 

    21 #include <e32std.h>

    22 #include <ximpbase.h>

    23 #include <presencedatamodelifids.hrh>

    24 

    25 

    26 class MXIMPIdentity;

    27 

    28 

    29 /**

    30  * Interface for presence grant request info object.

    31  *

    32  * Presence grant request info object presents single

    33  * presence grant request entry in the presence

    34  * grant request list. Presence grant request info

    35  * object holds the identity and display name information

    36  * for the presence grant request.

    37  *

    38  * @ingroup presencedatamodelapi

    39  * @since S60 v3.2

    40  */

    41 class MPresenceGrantRequestInfo : public MXIMPBase

    42     {

    43 public:

    44 

    45     /** Interface ID for the MPresenceGrantRequestInfo. */

    46     enum { KInterfaceId = PRES_IF_ID_PRESENCE_GRANT_REQUEST_INFO };

    47 

    48 

    49 public:

    50 

    51     /**

    52      * Public destructor.

    53      * Objects can be deleted through this interface.

    54      */

    55     virtual ~MPresenceGrantRequestInfo() {}

    56 

    57 

    58 

    59 public:

    60 

    61 

    62     /**

    63      * Returns presence requestor identity value.

    64      *

    65      * @return The presence requestor identity value.

    66      */

    67     virtual const MXIMPIdentity& RequestorId() const = 0;

    68 

    69 

    70 

    71     /**

    72      * Returns presence requestor displayname value.

    73      *

    74      * @return The presence requestor displayname value.

    75      */

    76     virtual const TDesC16& RequestorDisplayName() const = 0;

    77 

    78 

    79 

    80     /**

    81      * Sets presence requestor identity value.

    82      *

    83      * @param [in] aIdentity

    84      *        New presence requestor identity value.

    85      *        Ownership of the argument is transfered to

    86      *        callee, if method succeeds without a leave.

    87      *

    88      * @leave KErrNoMemory if failed to allocate memory.

    89      * @leave KErrArgument if NULL argument were provided.

    90      */

    91     virtual void SetRequestorIdL(

    92                 MXIMPIdentity* aIdentity ) = 0;

    93 

    94 

    95 

    96     /**

    97      * Sets presence requestor display name value.

    98      *

    99      * @param [in] aDisplayName

   100      *        New display name value.

   101      *

   102      * @leave KErrNoMemory if failed to allocate memory.

   103      */

   104     virtual void SetRequestorDisplayNameL(

   105                 const TDesC16& aDisplayName ) = 0;

   106 

   107 

   108     };

   109 

   110 

   111 #endif // MXIMPFWPRESENCEGRANTREQUESTINFO_H

   112 

   113 

   114