1 /*

     2 * Copyright (c) 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: This file defines class MFSNotificationHandlerMgr.

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef M_FSNOTIFICATIONHANDLERMGR_H

    21 #define M_FSNOTIFICATIONHANDLERMGR_H

    22 

    23 #include "fsmailserverconst.h"

    24 

    25 

    26 class CFSMailClient;

    27 class CFSNotificationHandlerHSConnection;

    28 class CFsEmailGlobalDialogsAppUi;

    29 

    30 /**

    31  *  ?one_line_short_description

    32  *

    33  *  ?more_complete_description

    34  *  @code

    35  *   ?good_class_usage_example(s)

    36  *  @endcode

    37  *

    38  *  @lib ?library

    39  *  @since S60 ?S60_version *** for example, S60 v3.0

    40  */

    41 class MFSNotificationHandlerMgr

    42     {

    43 

    44 public:

    45 

    46     /**

    47      * Function that returns a reference to the mail client which

    48      * is used to access email framework.

    49      *

    50      * @since S60 ?S60_version

    51      * @return Pointer to framework object.

    52      */

    53     virtual CFSMailClient& MailClient() const = 0;

    54 

    55     /**

    56      * Gets pointer to object that provides information

    57      * about the current Home Screen status. NULL is returned

    58      * if the software is not a preinstalled version.

    59      *

    60      * Ownership IS NOT transferred.

    61      *

    62      * Notice that UpdateStatusL() is called on the HS

    63      * connection object in case notification handler manager

    64      * has just received an event of type TFSEventNewMail from

    65      * FSEmailFramework. In that case it is not necessary

    66      * to update the status again.

    67      *

    68      *

    69      * @since S60 ?S60_version

    70      * @return Pointer to HS connection object. NULL if this

    71      *         software is a postinstalled version. Ownership is

    72      *         not transferred.

    73      */     

    74     virtual CFSNotificationHandlerHSConnection* HSConnection() const = 0;

    75 

    76     //<cmail>

    77     virtual void MessageQueryL( TDesC& aMailboxName,

    78                                 TRequestStatus& aStatus,

    79                                 const TDesC& aCustomMessageText,

    80                                 TFsEmailNotifierSystemMessageType aMessageType ) = 0;

    81     

    82     virtual TInt AuthenticateL( TDes& aPassword,

    83                                 TDesC& aMailboxName, 

    84                                 TRequestStatus& aStatus ) = 0;

    85     //</cmail>

    86 

    87     /**

    88      * Increases the active dialog count.

    89      */

    90     virtual void IncreaseDialogCount() = 0;

    91 

    92     /**

    93      * Decreases the active dialog count.

    94      */

    95     virtual void DecreaseDialogCount() = 0;

    96 

    97     /**

    98      * Gets the active dialog count.

    99      *

   100      * @return Number of active dialogs.

   101      */

   102     virtual TInt GetDialogCount() = 0;

   103 

   104     //<cmail>

   105     /**

   106      * If AppUi pointer is available, send app ui to background

   107      * 

   108      * @since S60 5.0

   109      */

   110     virtual void SendAppUiToBackground() = 0;

   111     

   112     /**

   113      * If AppUi pointer is available, bring app ui to foreground

   114      *

   115      * @since S60 5.0

   116      */

   117     virtual void BringAppUiToForeground() = 0;

   118     //</cmail>

   119 

   120 protected:

   121 

   122     };

   123 

   124 

   125 #endif // M_FSNOTIFICATIONHANDLERMGR_H