cbs/cbsserver/ServerInc/MCbsEtelMessaging.h
author hgs
Fri, 06 Aug 2010 13:08:23 +0300
changeset 36 7c428525956b
parent 33 8d5d7fcf9b59
permissions -rw-r--r--
201031
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  This file contains the header file of the MCbsEtelMessaging class.
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#ifndef MCBSETELMESSAGING_H
hgs
parents:
diff changeset
    21
#define MCBSETELMESSAGING_H
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
//  INCLUDES
hgs
parents:
diff changeset
    24
		/*****************************************************
hgs
parents:
diff changeset
    25
		*	Series 60 Customer / ETel
hgs
parents:
diff changeset
    26
		*	Series 60  ETel API
hgs
parents:
diff changeset
    27
		*****************************************************/
hgs
parents:
diff changeset
    28
#include <etelmm.h>        
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
//  FORWARD DECLARATIONS
hgs
parents:
diff changeset
    31
class MCbsEtelPhone;
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
//  CLASS DECLARATION 
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
/**
hgs
parents:
diff changeset
    36
*   MCbsEtelMessaging is the interface for EPOC Telephony server connections.
hgs
parents:
diff changeset
    37
*   
hgs
parents:
diff changeset
    38
*/
hgs
parents:
diff changeset
    39
class MCbsEtelMessaging
hgs
parents:
diff changeset
    40
    {
hgs
parents:
diff changeset
    41
    public:
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
        /**
hgs
parents:
diff changeset
    44
        *   Virtual destructor
hgs
parents:
diff changeset
    45
        */
hgs
parents:
diff changeset
    46
        virtual ~MCbsEtelMessaging() { }
hgs
parents:
diff changeset
    47
hgs
parents:
diff changeset
    48
        /**
hgs
parents:
diff changeset
    49
        *   Opens the connection to EPOC Telephony server       
hgs
parents:
diff changeset
    50
        *
hgs
parents:
diff changeset
    51
        *   @param  aPhone      A reference to the phone
hgs
parents:
diff changeset
    52
        *   @return             Error code
hgs
parents:
diff changeset
    53
        */
hgs
parents:
diff changeset
    54
        virtual TInt Open( RMobilePhone& aPhone ) = 0;
hgs
parents:
diff changeset
    55
hgs
parents:
diff changeset
    56
        /**
hgs
parents:
diff changeset
    57
        *   Closes the connection to EPOC Telephony server
hgs
parents:
diff changeset
    58
        */
hgs
parents:
diff changeset
    59
        virtual void Close() = 0;
hgs
parents:
diff changeset
    60
hgs
parents:
diff changeset
    61
        /**
hgs
parents:
diff changeset
    62
        *   Requests to receive next incoming CB message
hgs
parents:
diff changeset
    63
        *
hgs
parents:
diff changeset
    64
        *   @param  aReqStatus      Return: Async request status
hgs
parents:
diff changeset
    65
        *   @param  aMsgData        Return: CB message data
hgs
parents:
diff changeset
    66
        *   @param  aMsgAttributes  Return: CB message attributes
hgs
parents:
diff changeset
    67
        */
hgs
parents:
diff changeset
    68
        virtual void ReceiveMessage( TRequestStatus& aReqStatus, 
hgs
parents:
diff changeset
    69
            TDes8& aMsgData, TDes8& aMsgAttributes ) = 0;
hgs
parents:
diff changeset
    70
hgs
parents:
diff changeset
    71
        /**
hgs
parents:
diff changeset
    72
        *   Gets the filter setting from EPOC Telephony server
hgs
parents:
diff changeset
    73
        *
hgs
parents:
diff changeset
    74
        *   @param  aSetting        Return: Current filter setting
hgs
parents:
diff changeset
    75
        */
hgs
parents:
diff changeset
    76
        virtual TInt GetFilterSetting( 
hgs
parents:
diff changeset
    77
            RMobileBroadcastMessaging::TMobilePhoneBroadcastFilter& aSetting ) = 0;
hgs
parents:
diff changeset
    78
hgs
parents:
diff changeset
    79
        /**
hgs
parents:
diff changeset
    80
        *   Sets the filter setting to EPOC Telephony server
hgs
parents:
diff changeset
    81
        *
hgs
parents:
diff changeset
    82
        *   @param  aReqStatus      Return: Async request status
hgs
parents:
diff changeset
    83
        *   @param  aSetting        New filter setting
hgs
parents:
diff changeset
    84
        */
hgs
parents:
diff changeset
    85
        virtual void SetFilterSetting( TRequestStatus& aReqStatus, 
hgs
parents:
diff changeset
    86
            RMobileBroadcastMessaging::TMobilePhoneBroadcastFilter aSetting ) const = 0;        
hgs
parents:
diff changeset
    87
hgs
parents:
diff changeset
    88
        /**
hgs
parents:
diff changeset
    89
        *   Cancel ReceiveMessage
hgs
parents:
diff changeset
    90
        *
hgs
parents:
diff changeset
    91
        */
hgs
parents:
diff changeset
    92
        virtual void ReceiveMessageCancel() = 0;
hgs
parents:
diff changeset
    93
hgs
parents:
diff changeset
    94
        /**
hgs
parents:
diff changeset
    95
        *   Cancel SetFilterSetting
hgs
parents:
diff changeset
    96
        *
hgs
parents:
diff changeset
    97
        */
hgs
parents:
diff changeset
    98
        virtual void SetFilterSettingCancel() = 0;
hgs
parents:
diff changeset
    99
        };
hgs
parents:
diff changeset
   100
hgs
parents:
diff changeset
   101
#endif      //  MCBSETELMESSAGING_H
hgs
parents:
diff changeset
   102
            
hgs
parents:
diff changeset
   103
// End of File
hgs
parents:
diff changeset
   104
hgs
parents:
diff changeset
   105