phoneapp/silenceactionplugin/src/silenceactionplugin.cpp
changeset 37 ba76fc04e6c2
child 51 f39ed5e045e0
equal deleted inserted replaced
36:2eacb6118286 37:ba76fc04e6c2
       
     1 /*
       
     2 * Copyright (c) 2006-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:  A plug-in for silencing the rigning tones.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 // INCLUDE FILES
       
    20 #include <badesca.h>
       
    21 #include <cfactionindication.h>
       
    22 
       
    23 #include "silenceactionplugin.h"
       
    24 #include "logger.h"
       
    25 #include "silenceaction.h"
       
    26 
       
    27 // LOCAL CONSTANTS AND MACROS
       
    28 
       
    29 // Supported action identifiers.
       
    30 _LIT( KPhoneId,     "Phone" );
       
    31 
       
    32 _LIT( KActionIdCommand,     "Command" );
       
    33 
       
    34 _LIT( KActionCommand,     "Silence" );
       
    35 
       
    36 // Capabilities
       
    37 _LIT_SECURITY_POLICY_PASS( KSecurityPolicy );
       
    38 
       
    39 // ============================ MEMBER FUNCTIONS ===============================
       
    40 
       
    41 // -----------------------------------------------------------------------------
       
    42 // CSilenceActionPlugIn::CSilenceActionPlugIn
       
    43 // C++ default constructor can NOT contain any code, that might leave.
       
    44 // -----------------------------------------------------------------------------
       
    45 //
       
    46 CSilenceActionPlugIn::CSilenceActionPlugIn( ) 
       
    47                                 : CCFActionPlugIn()                                  
       
    48     {
       
    49     }
       
    50 
       
    51 // -----------------------------------------------------------------------------
       
    52 // CSilenceActionPlugIn::NewL
       
    53 // Two-phased constructor.
       
    54 // -----------------------------------------------------------------------------
       
    55 //
       
    56 CSilenceActionPlugIn* CSilenceActionPlugIn::NewL( )
       
    57     {
       
    58     CSilenceActionPlugIn* self = CSilenceActionPlugIn::NewLC();
       
    59     CleanupStack::Pop();
       
    60     return self;
       
    61     }
       
    62   
       
    63 // -----------------------------------------------------------------------------
       
    64 // CSilenceActionPlugIn::NewLC
       
    65 // Two-phased constructor.
       
    66 // -----------------------------------------------------------------------------
       
    67 //
       
    68 CSilenceActionPlugIn* CSilenceActionPlugIn::NewLC( )
       
    69     {
       
    70     CSilenceActionPlugIn* self = new( ELeave ) CSilenceActionPlugIn();
       
    71     CleanupStack::PushL( self );
       
    72     return self;
       
    73     }
       
    74   
       
    75 
       
    76 // -----------------------------------------------------------------------------
       
    77 // CSilenceActionPlugIn::~CSilenceActionPlugIn
       
    78 // Destructor
       
    79 // -----------------------------------------------------------------------------
       
    80 //
       
    81 CSilenceActionPlugIn::~CSilenceActionPlugIn()
       
    82     {
       
    83     if ( iSilence )
       
    84         {
       
    85         delete iSilence;
       
    86         iSilence = NULL;   
       
    87         }
       
    88     }
       
    89 
       
    90 // METHODS
       
    91 
       
    92 //-----------------------------------------------------------------------------
       
    93 // CSilenceActionPlugIn::InitializeL
       
    94 //-----------------------------------------------------------------------------
       
    95 //
       
    96 void CSilenceActionPlugIn::InitializeL()
       
    97     {
       
    98     LOG_1( _L("CSilenceActionPlugIn::InitializeL: START") );
       
    99     iSilence = CSilenceAction::NewL( *this );
       
   100     LOG_1( _L("CSilenceActionPlugIn::InitializeL: END") );
       
   101     }
       
   102 
       
   103 //-----------------------------------------------------------------------------
       
   104 // CSilenceActionPlugIn::ExecuteL
       
   105 // Triggers an action.
       
   106 //-----------------------------------------------------------------------------
       
   107 //
       
   108 CCFActionPlugIn::TExecutionTime CSilenceActionPlugIn::ExecuteL(
       
   109     CCFActionIndication* aActionIndication )
       
   110     {
       
   111     LOG_1( _L("CSilenceActionPlugIn::ExecuteL: START") );
       
   112     
       
   113     CCFActionPlugIn::TExecutionTime time = CCFActionPlugIn::ENone;
       
   114     const RKeyValueArray& parameters = aActionIndication->Parameters();
       
   115     
       
   116     TInt count = parameters.Count();
       
   117     
       
   118     for( TInt i = 0; i < count; i++ )
       
   119         {
       
   120         TPtrC actionId( KNullDesC );
       
   121         TPtrC commandId( KNullDesC );
       
   122         
       
   123         actionId.Set( parameters[i]->Key() );
       
   124         commandId.Set( parameters[i]->Value() );
       
   125 
       
   126         if( ( actionId.CompareF( KActionIdCommand ) == KErrNone ) && 
       
   127             ( commandId.CompareF( KActionCommand ) == KErrNone ) )
       
   128             {
       
   129             LOG_1( _L("CSilenceActionPlugIn::ExecuteL->ActionMuteRingingTone") );
       
   130             iSilence->ActionMuteRingingTone();
       
   131             time = CCFActionPlugIn::ESmall;
       
   132             }
       
   133         else
       
   134             {
       
   135             LOG_1( _L("CSilenceActionPlugIn::ExecuteL->Do nothing") );
       
   136             time = CCFActionPlugIn::ENone;
       
   137             }
       
   138         }
       
   139         
       
   140     LOG_1( _L("CSilenceActionPlugIn::ExecuteL: END") );
       
   141     return time;
       
   142     }
       
   143 
       
   144 //-----------------------------------------------------------------------------
       
   145 // CSilenceActionPlugIn::MuteActionCompleted
       
   146 // Notifies CCFActionPlugIn base class that async request has been completed. 
       
   147 //-----------------------------------------------------------------------------
       
   148 //
       
   149 void CSilenceActionPlugIn::MuteActionCompleted()
       
   150     {
       
   151     AsyncExecutionCompleted();
       
   152     }
       
   153 
       
   154 //-----------------------------------------------------------------------------
       
   155 // CSilenceActionPlugIn::GetActionsL
       
   156 // Gets all the actions the plugin can perform.
       
   157 //-----------------------------------------------------------------------------
       
   158 //
       
   159 void CSilenceActionPlugIn::GetActionsL( CDesCArray& aActionList ) const
       
   160     {
       
   161     LOG_1( _L("CSilenceActionPlugIn::GetActionsL: START") );
       
   162     aActionList.AppendL( KPhoneId );
       
   163     LOG_1( _L("CSilenceActionPlugIn::GetActionsL: END") );
       
   164     }
       
   165 
       
   166 //-----------------------------------------------------------------------------
       
   167 // CSilenceActionPlugIn::SecurityPolicy
       
   168 // Returns the capabilities required by the plugin.
       
   169 //-----------------------------------------------------------------------------
       
   170 //
       
   171 const TSecurityPolicy& CSilenceActionPlugIn::SecurityPolicy() const
       
   172     {
       
   173     LOG_1( _L("CSilenceActionPlugIn::SecurityPolicy") );
       
   174     return KSecurityPolicy;
       
   175     }
       
   176     
       
   177 // End of File