satengine/satserver/Commands/SendSmCmd/inc/CSendSmHandler.h
author hgs
Fri, 03 Sep 2010 13:59:20 +0300
changeset 46 2fa1fa551b0b
parent 33 8d5d7fcf9b59
permissions -rw-r--r--
201035
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2007 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:  SendSm command handler
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
#ifndef CSENDSMHANDLER_H
hgs
parents:
diff changeset
    20
#define CSENDSMHANDLER_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include <etelsat.h>
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
#include "CSatCommandHandler.h"
hgs
parents:
diff changeset
    25
#include "SatSTypes.h"
hgs
parents:
diff changeset
    26
#include "MSatSmsObserver.h"
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
class MSatUtils;
hgs
parents:
diff changeset
    29
class CSatSSendMessageNoLoggingHandler;
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
/**
hgs
parents:
diff changeset
    32
*  Command handler for SendSm command.
hgs
parents:
diff changeset
    33
*
hgs
parents:
diff changeset
    34
*  @lib SendSmCmd.lib
hgs
parents:
diff changeset
    35
*  @since S60 v3.0
hgs
parents:
diff changeset
    36
*/
hgs
parents:
diff changeset
    37
class CSendSmHandler : public CSatCommandHandler,
hgs
parents:
diff changeset
    38
                       public MSatSmsObserver
hgs
parents:
diff changeset
    39
    {
hgs
parents:
diff changeset
    40
    
hgs
parents:
diff changeset
    41
public:
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
    static CSendSmHandler* NewL( MSatUtils* aUtils );
hgs
parents:
diff changeset
    44
hgs
parents:
diff changeset
    45
    virtual ~CSendSmHandler();
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
// from base class MSatCommand
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
    /**
hgs
parents:
diff changeset
    50
     * From MSatCommand. 
hgs
parents:
diff changeset
    51
     * Query response.
hgs
parents:
diff changeset
    52
     *
hgs
parents:
diff changeset
    53
     */
hgs
parents:
diff changeset
    54
    void ClientResponse();
hgs
parents:
diff changeset
    55
    
hgs
parents:
diff changeset
    56
// from base class MSatSmsObserver
hgs
parents:
diff changeset
    57
hgs
parents:
diff changeset
    58
    /**
hgs
parents:
diff changeset
    59
     * From MSatEventObserver.
hgs
parents:
diff changeset
    60
     * Event notification
hgs
parents:
diff changeset
    61
     *
hgs
parents:
diff changeset
    62
     * @param aEvent An event that is occured.
hgs
parents:
diff changeset
    63
     */
hgs
parents:
diff changeset
    64
    void Event( TInt aEvent );
hgs
parents:
diff changeset
    65
hgs
parents:
diff changeset
    66
    /**
hgs
parents:
diff changeset
    67
     * From MSatSmsObserver.
hgs
parents:
diff changeset
    68
     * Notification that sms was sent.
hgs
parents:
diff changeset
    69
     *
hgs
parents:
diff changeset
    70
     * @param aErrorCode Error code indicating a possible error.
hgs
parents:
diff changeset
    71
     */
hgs
parents:
diff changeset
    72
    void SmsSent( TInt aErrorCode );
hgs
parents:
diff changeset
    73
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
protected:
hgs
parents:
diff changeset
    76
hgs
parents:
diff changeset
    77
    /**
hgs
parents:
diff changeset
    78
     * Sets the sca number to the iSendSmData.
hgs
parents:
diff changeset
    79
     *
hgs
parents:
diff changeset
    80
     * @param aScaNumber SCA number.
hgs
parents:
diff changeset
    81
     * @return Boolean indicating SCA number successfully set.
hgs
parents:
diff changeset
    82
     */
hgs
parents:
diff changeset
    83
    TBool SetScaNumber( const RSat::TSatTelNumber& aScaNumber );
hgs
parents:
diff changeset
    84
    
hgs
parents:
diff changeset
    85
// from base class CActive
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
    /**
hgs
parents:
diff changeset
    88
     * From CActive
hgs
parents:
diff changeset
    89
     * Cancels the usat request.
hgs
parents:
diff changeset
    90
     *
hgs
parents:
diff changeset
    91
     */
hgs
parents:
diff changeset
    92
    void DoCancel();
hgs
parents:
diff changeset
    93
hgs
parents:
diff changeset
    94
// from base class CSatCommandHandler
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
    /**
hgs
parents:
diff changeset
    97
     * From CSatCommandHandler
hgs
parents:
diff changeset
    98
     * Requests the command notification.
hgs
parents:
diff changeset
    99
     *
hgs
parents:
diff changeset
   100
     * @param aStatus Request status to active object notification
hgs
parents:
diff changeset
   101
     */
hgs
parents:
diff changeset
   102
    void IssueUSATRequest( TRequestStatus& aStatus );
hgs
parents:
diff changeset
   103
hgs
parents:
diff changeset
   104
    /**
hgs
parents:
diff changeset
   105
     * From CSatCommandHandler
hgs
parents:
diff changeset
   106
     * Precheck before executing the command.
hgs
parents:
diff changeset
   107
     *
hgs
parents:
diff changeset
   108
     * @return Boolean indicating is this command allowed to execute.
hgs
parents:
diff changeset
   109
     */
hgs
parents:
diff changeset
   110
    TBool CommandAllowed();
hgs
parents:
diff changeset
   111
hgs
parents:
diff changeset
   112
    /**
hgs
parents:
diff changeset
   113
     * From CSatCommandHandler
hgs
parents:
diff changeset
   114
     * Need for ui session.
hgs
parents:
diff changeset
   115
     *
hgs
parents:
diff changeset
   116
     * @return Boolean indicating does this command need UI session.
hgs
parents:
diff changeset
   117
     */
hgs
parents:
diff changeset
   118
    TBool NeedUiSession();
hgs
parents:
diff changeset
   119
hgs
parents:
diff changeset
   120
    /**
hgs
parents:
diff changeset
   121
     * From CSatCommandHandler
hgs
parents:
diff changeset
   122
     * Called when USAT API notifies that command.
hgs
parents:
diff changeset
   123
     *
hgs
parents:
diff changeset
   124
     */
hgs
parents:
diff changeset
   125
    void HandleCommand();
hgs
parents:
diff changeset
   126
hgs
parents:
diff changeset
   127
    /**
hgs
parents:
diff changeset
   128
     * From CSatCommandHandler
hgs
parents:
diff changeset
   129
     * Called when UI launch fails
hgs
parents:
diff changeset
   130
     *
hgs
parents:
diff changeset
   131
     */
hgs
parents:
diff changeset
   132
    void UiLaunchFailed();
hgs
parents:
diff changeset
   133
hgs
parents:
diff changeset
   134
private:
hgs
parents:
diff changeset
   135
hgs
parents:
diff changeset
   136
    CSendSmHandler();
hgs
parents:
diff changeset
   137
hgs
parents:
diff changeset
   138
    void ConstructL();
hgs
parents:
diff changeset
   139
hgs
parents:
diff changeset
   140
    /**
hgs
parents:
diff changeset
   141
     * Checks is the command transparent or not
hgs
parents:
diff changeset
   142
     *
hgs
parents:
diff changeset
   143
     */
hgs
parents:
diff changeset
   144
    TBool TransparentSmsSending() const;
hgs
parents:
diff changeset
   145
hgs
parents:
diff changeset
   146
    /**
hgs
parents:
diff changeset
   147
     * Checks is the SCA available
hgs
parents:
diff changeset
   148
     *
hgs
parents:
diff changeset
   149
     */
hgs
parents:
diff changeset
   150
    TBool IsSCAAvailable();
hgs
parents:
diff changeset
   151
hgs
parents:
diff changeset
   152
private: // data
hgs
parents:
diff changeset
   153
hgs
parents:
diff changeset
   154
    /**
hgs
parents:
diff changeset
   155
     * SendSm command data.
hgs
parents:
diff changeset
   156
     */
hgs
parents:
diff changeset
   157
    RSat::TSendSmV1 iSendSmData;
hgs
parents:
diff changeset
   158
hgs
parents:
diff changeset
   159
    /**
hgs
parents:
diff changeset
   160
     * SendSm command package.
hgs
parents:
diff changeset
   161
     */
hgs
parents:
diff changeset
   162
    RSat::TSendSmV1Pckg iSendSmPckg;
hgs
parents:
diff changeset
   163
hgs
parents:
diff changeset
   164
    /**
hgs
parents:
diff changeset
   165
     * SendSm response data
hgs
parents:
diff changeset
   166
     */
hgs
parents:
diff changeset
   167
    RSat::TSendSmRspV1 iSendSmRsp;
hgs
parents:
diff changeset
   168
hgs
parents:
diff changeset
   169
    /**
hgs
parents:
diff changeset
   170
     * SendSm response package.
hgs
parents:
diff changeset
   171
     */
hgs
parents:
diff changeset
   172
    RSat::TSendSmRspV1Pckg iSendSmRspPckg;
hgs
parents:
diff changeset
   173
hgs
parents:
diff changeset
   174
    /**
hgs
parents:
diff changeset
   175
     * Query command data.
hgs
parents:
diff changeset
   176
     */
hgs
parents:
diff changeset
   177
    TSatQueryV1 iQueryData;
hgs
parents:
diff changeset
   178
hgs
parents:
diff changeset
   179
    /**
hgs
parents:
diff changeset
   180
     * Query package.
hgs
parents:
diff changeset
   181
     */
hgs
parents:
diff changeset
   182
    TSatQueryV1Pckg iQueryPckg;
hgs
parents:
diff changeset
   183
hgs
parents:
diff changeset
   184
    /**
hgs
parents:
diff changeset
   185
     * Query response.
hgs
parents:
diff changeset
   186
     */
hgs
parents:
diff changeset
   187
    TSatQueryRspV1 iQueryRsp;
hgs
parents:
diff changeset
   188
hgs
parents:
diff changeset
   189
    /**
hgs
parents:
diff changeset
   190
     * Query rsp package.
hgs
parents:
diff changeset
   191
     */
hgs
parents:
diff changeset
   192
    TSatQueryRspV1Pckg iQueryRspPckg;
hgs
parents:
diff changeset
   193
hgs
parents:
diff changeset
   194
    /**
hgs
parents:
diff changeset
   195
     * SendSm notification send data
hgs
parents:
diff changeset
   196
     */
hgs
parents:
diff changeset
   197
    TSatNotificationV1 iNotificationData;
hgs
parents:
diff changeset
   198
hgs
parents:
diff changeset
   199
    /**
hgs
parents:
diff changeset
   200
     * SendSm notification package
hgs
parents:
diff changeset
   201
     */
hgs
parents:
diff changeset
   202
    TSatNotificationV1Pckg iNotificationDataPckg;
hgs
parents:
diff changeset
   203
hgs
parents:
diff changeset
   204
    /**
hgs
parents:
diff changeset
   205
     * SendSm notification Response data
hgs
parents:
diff changeset
   206
     */
hgs
parents:
diff changeset
   207
    TSatNotificationRspV1 iNotificationRsp;
hgs
parents:
diff changeset
   208
hgs
parents:
diff changeset
   209
    /**
hgs
parents:
diff changeset
   210
     * SendSm notification Response package
hgs
parents:
diff changeset
   211
     */
hgs
parents:
diff changeset
   212
    TSatNotificationRspV1Pckg iNotificationRspPckg;
hgs
parents:
diff changeset
   213
hgs
parents:
diff changeset
   214
    /**
hgs
parents:
diff changeset
   215
     * Is MoSmControl active.
hgs
parents:
diff changeset
   216
     */
hgs
parents:
diff changeset
   217
    TBool iMoSmControlActive;
hgs
parents:
diff changeset
   218
hgs
parents:
diff changeset
   219
    /**
hgs
parents:
diff changeset
   220
     * Message sender.
hgs
parents:
diff changeset
   221
     */
hgs
parents:
diff changeset
   222
    CSatSSendMessageNoLoggingHandler* iMsgSender;
hgs
parents:
diff changeset
   223
hgs
parents:
diff changeset
   224
    /**
hgs
parents:
diff changeset
   225
     * Indicates does this command need UI session ot not
hgs
parents:
diff changeset
   226
     */
hgs
parents:
diff changeset
   227
    TBool iNeedUiSession;
hgs
parents:
diff changeset
   228
hgs
parents:
diff changeset
   229
    /**
hgs
parents:
diff changeset
   230
     * Indicates if KPartialComprehension is needed instead of KSuccess
hgs
parents:
diff changeset
   231
     */
hgs
parents:
diff changeset
   232
    TBool iPartialComprehension;
hgs
parents:
diff changeset
   233
hgs
parents:
diff changeset
   234
    /**
hgs
parents:
diff changeset
   235
     * Indicates is SCA number available at all
hgs
parents:
diff changeset
   236
     */
hgs
parents:
diff changeset
   237
    TBool iSCANumberAvailable;
hgs
parents:
diff changeset
   238
hgs
parents:
diff changeset
   239
    /**
hgs
parents:
diff changeset
   240
     * Indicates is notification already sent
hgs
parents:
diff changeset
   241
     */
hgs
parents:
diff changeset
   242
    TBool iNotificationSent;
hgs
parents:
diff changeset
   243
        
hgs
parents:
diff changeset
   244
    /**
hgs
parents:
diff changeset
   245
     * Flag to signal that command has icon data
hgs
parents:
diff changeset
   246
     * To be removed when icons are allowed in this command
hgs
parents:
diff changeset
   247
     */
hgs
parents:
diff changeset
   248
    TBool iIconCommand;
hgs
parents:
diff changeset
   249
hgs
parents:
diff changeset
   250
    };
hgs
parents:
diff changeset
   251
hgs
parents:
diff changeset
   252
#endif      // CSENDSMHANDLER_H
hgs
parents:
diff changeset
   253