cbs/CbsServer/ServerInc/MCbsEtelMessaging.h
changeset 46 2fa1fa551b0b
parent 42 35488577e233
child 48 78df25012fda
equal deleted inserted replaced
42:35488577e233 46:2fa1fa551b0b
     1 /*
       
     2 * Copyright (c) 2003 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 contains the header file of the MCbsEtelMessaging class.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef MCBSETELMESSAGING_H
       
    21 #define MCBSETELMESSAGING_H
       
    22 
       
    23 //  INCLUDES
       
    24 		/*****************************************************
       
    25 		*	Series 60 Customer / ETel
       
    26 		*	Series 60  ETel API
       
    27 		*****************************************************/
       
    28 #include <etelmm.h>        
       
    29 
       
    30 //  FORWARD DECLARATIONS
       
    31 class MCbsEtelPhone;
       
    32 
       
    33 //  CLASS DECLARATION 
       
    34 
       
    35 /**
       
    36 *   MCbsEtelMessaging is the interface for EPOC Telephony server connections.
       
    37 *   
       
    38 */
       
    39 class MCbsEtelMessaging
       
    40     {
       
    41     public:
       
    42 
       
    43         /**
       
    44         *   Virtual destructor
       
    45         */
       
    46         virtual ~MCbsEtelMessaging() { }
       
    47 
       
    48         /**
       
    49         *   Opens the connection to EPOC Telephony server       
       
    50         *
       
    51         *   @param  aPhone      A reference to the phone
       
    52         *   @return             Error code
       
    53         */
       
    54         virtual TInt Open( RMobilePhone& aPhone ) = 0;
       
    55 
       
    56         /**
       
    57         *   Closes the connection to EPOC Telephony server
       
    58         */
       
    59         virtual void Close() = 0;
       
    60 
       
    61         /**
       
    62         *   Requests to receive next incoming CB message
       
    63         *
       
    64         *   @param  aReqStatus      Return: Async request status
       
    65         *   @param  aMsgData        Return: CB message data
       
    66         *   @param  aMsgAttributes  Return: CB message attributes
       
    67         */
       
    68         virtual void ReceiveMessage( TRequestStatus& aReqStatus, 
       
    69             TDes8& aMsgData, TDes8& aMsgAttributes ) = 0;
       
    70 
       
    71         /**
       
    72         *   Gets the filter setting from EPOC Telephony server
       
    73         *
       
    74         *   @param  aSetting        Return: Current filter setting
       
    75         */
       
    76         virtual TInt GetFilterSetting( 
       
    77             RMobileBroadcastMessaging::TMobilePhoneBroadcastFilter& aSetting ) = 0;
       
    78 
       
    79         /**
       
    80         *   Sets the filter setting to EPOC Telephony server
       
    81         *
       
    82         *   @param  aReqStatus      Return: Async request status
       
    83         *   @param  aSetting        New filter setting
       
    84         */
       
    85         virtual void SetFilterSetting( TRequestStatus& aReqStatus, 
       
    86             RMobileBroadcastMessaging::TMobilePhoneBroadcastFilter aSetting ) const = 0;        
       
    87 
       
    88         /**
       
    89         *   Cancel ReceiveMessage
       
    90         *
       
    91         */
       
    92         virtual void ReceiveMessageCancel() = 0;
       
    93 
       
    94         /**
       
    95         *   Cancel SetFilterSetting
       
    96         *
       
    97         */
       
    98         virtual void SetFilterSettingCancel() = 0;
       
    99         };
       
   100 
       
   101 #endif      //  MCBSETELMESSAGING_H
       
   102             
       
   103 // End of File
       
   104 
       
   105