bluetoothengine/btnotif/btnotifsrv/inc/btnotificationresult.h
branchRCL_3
changeset 55 613943a21004
equal deleted inserted replaced
54:0ba996a9b75d 55:613943a21004
       
     1 /*
       
     2 * ============================================================================
       
     3 *  Name        : btnotificationresult.h
       
     4 *  Part of     : bluetoothengine / btnotif
       
     5 *  Description : Abstract interface for receiving the result of a user query.
       
     6 *
       
     7 *  Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     8 *  All rights reserved.
       
     9 *  This component and the accompanying materials are made available
       
    10 *  under the terms of "Eclipse Public License v1.0"
       
    11 *  which accompanies this distribution, and is available
       
    12 *  at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
    13 *
       
    14 *  Initial Contributors:
       
    15 *  Nokia Corporation - initial contribution.
       
    16 *
       
    17 *  Contributors:
       
    18 *  Nokia Corporation
       
    19 * ============================================================================
       
    20 * Template version: 4.2
       
    21 */
       
    22 
       
    23 #ifndef BTNOTIFICATIONRESULT_H
       
    24 #define BTNOTIFICATIONRESULT_H
       
    25 
       
    26 class CHbSymbianVariantMap;
       
    27 
       
    28 /**
       
    29  *  MBTNotificationResult returns the result from a user query.
       
    30  *
       
    31  *
       
    32  *  @since Symbian^4
       
    33  */
       
    34 class MBTNotificationResult
       
    35     {
       
    36 
       
    37 public:
       
    38 
       
    39     /**
       
    40      * Handle an intermediate result from a user query.
       
    41      * This function is called if the user query passes information
       
    42      * back before it has finished i.e. is dismissed. The final acceptance/
       
    43      * denial of a query is passed back in MBRNotificationClosed.
       
    44      *
       
    45      * @since Symbian^4
       
    46      * @param aData the returned data. The actual format 
       
    47      *              is dependent on the actual notifier.
       
    48      */
       
    49     virtual void MBRDataReceived( CHbSymbianVariantMap& aData ) = 0;
       
    50 
       
    51     
       
    52     /**
       
    53      * The notification is finished. The resulting data (e.g. user input or
       
    54      * acceptance/denial of the query) is passed back here.
       
    55      *
       
    56      * @since Symbian^4
       
    57      * @param aErr KErrNone or one of the system-wide error codes.
       
    58      * @param aData the returned data. The actual format 
       
    59      *              is dependent on the actual notifier.
       
    60      */
       
    61     virtual void MBRNotificationClosed( TInt aError, const TDesC8& aData ) = 0;
       
    62 
       
    63     };
       
    64 
       
    65 
       
    66 #endif // BTNOTIFICATIONRESULT_H