1 /*

     2 * Copyright (c) 2010 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:

    15 *    Declares functions needed to save message.

    16 *

    17 */

    18 

    19 

    20 #ifndef MSAVEMESSAGECONTROLLER_H

    21 #define MSAVEMESSAGECONTROLLER_H

    22 

    23 //  INCLUDES

    24 #include    <CbsCommon.h>

    25 

    26 

    27 

    28 // CLASS DECLARATION

    29 

    30 /**

    31 * Helper class for saving message.

    32 */

    33 class MSaveMessageController

    34     {

    35     public: // New functions

    36 

    37         /**

    38         *   Saves a message (the saved message won't be deleted to make 

    39         *   room for new messages).

    40         *

    41         *   Return codes:

    42         *   KErrNone            Message is saved.

    43         *   KErrGeneral         Message not saved -- total maximum of saved 

    44         *                       messages reached.

    45         *   KErrNotFound        Message not saved -- no message associated

    46         *                       with the given handle.

    47         *   KErrDiskFull        Message not saved -- FFS out of space.

    48         *

    49         *   @param  aHandle     Handle to the message to be saved.

    50         *   @return             Return code.

    51         */

    52         virtual TInt SaveMessage( const TCbsMessageHandle& aHandle ) = 0;

    53     };

    54 

    55 #endif // MSAVEMESSAGECONTROLLER_H

    56 

    57 // End of file