pressrv_plat/simple_instant_msg_api/inc/simpleinstantmessage.h
changeset 0 c8caa15ef882
equal deleted inserted replaced
-1:000000000000 0:c8caa15ef882
       
     1 /*
       
     2 * Copyright (c) 2009 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: IM API for Simple Engine
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef M_SIMPLEINSTANTMESSAGE_H
       
    20 #define M_SIMPLEINSTANTMESSAGE_H
       
    21 
       
    22 
       
    23 #include <e32std.h>
       
    24 
       
    25 
       
    26 /**
       
    27  *  Class for sending instant messages.
       
    28  *
       
    29  *  @code
       
    30  *   MSimpleInstantMessage* im = 
       
    31  *      TSimpleFactory::NewInstantMessageL( conn, connObs );
       
    32  *   TInt result = im->SendInstantMessage( text8, recipientsPtr8 );
       
    33  *  @endcode
       
    34  *
       
    35  *  @lib simpleengine.lib
       
    36  *  @since S60 v5.1
       
    37  */
       
    38 class MSimpleInstantMessage
       
    39     { 
       
    40 
       
    41 public:
       
    42 
       
    43     /**
       
    44      * Send instant message.
       
    45      *
       
    46      * @since S60 v5.1
       
    47      * @param aMsgContent message content
       
    48      * @param aRecipient  recipient ID
       
    49      * @return Operation ID
       
    50      */
       
    51     virtual TInt SendInstantMessage( TPtrC8 aMsgContent, 
       
    52         TPtrC8 aRecipient ) = 0;
       
    53 
       
    54     /**
       
    55      * Destroy this entity.
       
    56      *
       
    57      * @since S60 v5.1
       
    58      */
       
    59     virtual void Close() = 0;
       
    60     };
       
    61 
       
    62 
       
    63 #endif // M_SIMPLEINSTANTMESSAGE_H