1 /*

     2 * Copyright (c) 2002-2005 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:  Describes one invitation request

    15 *

    16 */

    17 

    18 

    19 #ifndef CCAINVITATIONREQUEST_H

    20 #define CCAINVITATIONREQUEST_H

    21 

    22 //  INCLUDES

    23 #include <badesca.h>

    24 

    25 const TInt KInviteDefaultTimeout = 1800;    // default timeout value (seconds)

    26 

    27 // CLASS DECLARATION

    28 

    29 /**

    30 *  Describes one invitation request.

    31 *

    32 *

    33 *  @lib CAEngine.lib

    34 *  @since 1.2

    35 */

    36 class CCAInvitationRequest : public CBase

    37     {

    38     public:  // Constructors and destructor

    39 

    40         /**

    41         * Two-phased constructor.

    42         * @param aUserIDs specifies the user IDs who are going to receive

    43         *        this invitation.

    44         * @param aGroupID is the group WV ID.

    45         * @param aMessage is the invitation message.

    46         * @param aTimeout is the invitation timeout in seconds.

    47         */

    48         IMPORT_C static CCAInvitationRequest* NewL(

    49             const CDesCArray& aUserIDs,

    50             const TDesC&      aGroupID,

    51             const TDesC&      aMessage,

    52             const TInt        aTimeout = KInviteDefaultTimeout );

    53 

    54         /**

    55         * Destructor.

    56         */

    57         IMPORT_C virtual ~CCAInvitationRequest();

    58 

    59     public: // New methods

    60 

    61         /**

    62         * Gets the invitation message.

    63         * @return The invitation message.

    64         */

    65         IMPORT_C const TDesC& Message() const;

    66 

    67         /**

    68         * Gets the group ID.

    69         * @return The group ID.

    70         */

    71         IMPORT_C const TDesC& GroupID() const;

    72 

    73         /**

    74         * Gets the list on invited user IDs.

    75         * @return Invite list.

    76         */

    77         IMPORT_C const CDesCArray& Invitees() const;

    78 

    79         /**

    80         * Gets the list timeout value.

    81         * @return Timeout value.

    82         */

    83         IMPORT_C TInt Timeout() const;

    84 

    85     private:

    86 

    87         /**

    88         * C++ default constructor.

    89         * @param aTimeout is the invitation timeout.

    90         */

    91         CCAInvitationRequest( const TInt aTimeout );

    92 

    93         /**

    94         * By default Symbian OS constructor is private.

    95         * @see CCAInvitationRequest::NewL.

    96         */

    97         void ConstructL( const CDesCArray& aUserIDs,

    98                          const TDesC&      aGroupID,

    99                          const TDesC&      aMessage );

   100 

   101     private:    // Data

   102 

   103         // Timeout value

   104         TInt iTimeout;

   105         // Owns: Invitation message.

   106         HBufC* iMessage;

   107         // Owns: Group ID

   108         HBufC* iGroupID;

   109         // Owns: Invitee list

   110         CDesCArray* iInvitees;

   111 

   112     };

   113 

   114 #endif      // CCAINVITATIONREQUEST_H

   115 

   116 // End of File