1 /*

     2 * Copyright (c) 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:  Used when inviting to chats.

    15 *

    16 */

    17 

    18 

    19 #ifndef MCAINVITATION_H

    20 #define MCAINVITATION_H

    21 

    22 //  INCLUDES

    23 #include <e32base.h>

    24 // CLASS DECLARATION

    25 

    26 // Helper class for observing if invite is read or not.

    27 class MCAInviteReadObserver

    28     {

    29     public: // Interface

    30 

    31         /**

    32          * Inform observer that invite is read.

    33          */

    34         virtual void HandleInviteReadL() const = 0;

    35     };

    36 

    37 /**

    38 *  Describes interface to one invitation .

    39 *  Used when inviting to chats.

    40 *

    41 *  @lib CAEngine.lib

    42 *  @since 3.0

    43 */

    44 class MCAInvitation

    45     {

    46     public: // New interface

    47 

    48         /**

    49         * Gets the invitation ID.

    50         * @return Invite ID.

    51         */

    52         virtual const TDesC& InviteID() const = 0;

    53 

    54         /**

    55         * Gets the user ID.

    56         * @return User ID ( WV ID ).

    57         */

    58         virtual const TDesC& UserID() const = 0;

    59 

    60         /**

    61         * Gets the screen name.

    62         * @return Screen name.

    63         */

    64         virtual const TDesC& ScreenName() const = 0;

    65 

    66         /**

    67         * Gets the group name.

    68         * @return Group name.

    69         */

    70         virtual const TDesC& GroupName() const = 0;

    71 

    72         /**

    73         * Gets the group ID.

    74         * @return Group name.

    75         */

    76         virtual const TDesC& GroupId() const = 0;

    77 

    78         /**

    79         * Gets the invitation message.

    80         * @return Message.

    81         */

    82         virtual const TDesC& Message() const = 0;

    83 

    84         /**

    85         * Gets the timeout value.

    86         * @return Timeout value.

    87         */

    88         virtual TInt Timeout() const = 0;

    89 

    90         /**

    91          * Gets the time this invite was received (created)

    92          * @since 2.1

    93          * @return Time and date of creation

    94          */

    95         virtual TTime ReceivedAt() const = 0;

    96 

    97         /**

    98          * Set invitation as read.

    99          * @since 3.0

   100          */

   101         virtual void SetInvitationAsReadL() = 0;

   102 

   103         /**

   104          * Is invitation read or not.

   105          * @return Read status on invitation message. ETrue, read, EFalse not.

   106          */

   107         virtual TBool IsRead() const = 0;

   108 

   109         /**

   110          * Invite can be deleted through this interface

   111          */

   112         virtual ~MCAInvitation() {};

   113 

   114     };

   115 

   116 #endif      // MCAINVITATION_H

   117 

   118 // End of File