epoc32/include/app/imlauncherplugin.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:  Interface for the IM application launching
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
#ifndef IMLAUNCHERPLUGIN_H
williamr@2
    21
#define IMLAUNCHERPLUGIN_H
williamr@2
    22
williamr@2
    23
//  INCLUDES
williamr@2
    24
#include <ecom/ecom.h>
williamr@2
    25
williamr@2
    26
// UID of this interface
williamr@2
    27
const TUid KImLauncherPluginUid = {0x101FB0CC};
williamr@2
    28
williamr@2
    29
/**
williamr@2
    30
*  Interface class for application launching
williamr@2
    31
*
williamr@2
    32
*  @since 2.6
williamr@2
    33
*/
williamr@2
    34
class CImLauncherPlugin : public CBase
williamr@2
    35
    {
williamr@2
    36
    public:  // Constructors and destructor
williamr@2
    37
williamr@2
    38
        /**
williamr@2
    39
        * Two-phased constructor.
williamr@2
    40
        * @param aApplicationId the Application ID of the application to be launched
williamr@2
    41
        * @return CImLauncherPlugin instance
williamr@2
    42
        */
williamr@2
    43
        static CImLauncherPlugin* NewL( const TDesC8& aApplicationId );
williamr@2
    44
williamr@2
    45
        /**
williamr@2
    46
        * Destructor.
williamr@2
    47
        */
williamr@2
    48
        virtual ~CImLauncherPlugin();
williamr@2
    49
williamr@2
    50
    public: // New functions
williamr@2
    51
williamr@2
    52
        /**
williamr@2
    53
        * Method for starting an application which can receive instant messages.
williamr@2
    54
        * Asynchronous function.
williamr@2
    55
        * @since 3.0
williamr@2
    56
        * @param aStatus Request status
williamr@2
    57
        * @param aSAP the remote SAP server from where the pending IM came
williamr@2
    58
        * @param aUserId the user ID who received the IM
williamr@2
    59
        */
williamr@2
    60
        virtual void StartApplicationL(
williamr@2
    61
            TRequestStatus& aStatus,
williamr@2
    62
            const TDesC& aSap,
williamr@2
    63
            const TDesC& aUserId ) = 0;
williamr@2
    64
williamr@2
    65
        /**
williamr@2
    66
        * Method for canceling the application start.
williamr@2
    67
        * @since 2.6
williamr@2
    68
        */
williamr@2
    69
        virtual void CancelStartApplication() = 0;
williamr@2
    70
williamr@2
    71
    protected:
williamr@2
    72
        //Default c'tor
williamr@2
    73
        inline CImLauncherPlugin();
williamr@2
    74
williamr@2
    75
    private:    // Data
williamr@2
    76
        /** iDtor_ID_Key Instance identifier key. When instance of an
williamr@2
    77
         *               implementation is created by ECOM framework, the
williamr@2
    78
         *               framework will assign UID for it. The UID is used in
williamr@2
    79
         *               destructor to notify framework that this instance is
williamr@2
    80
         *               being destroyed and resources can be released.
williamr@2
    81
         */
williamr@2
    82
        TUid iDtor_ID_Key;
williamr@2
    83
williamr@2
    84
    };
williamr@2
    85
williamr@2
    86
// This includes the implementation of the instantiation functions and
williamr@2
    87
// destructor
williamr@2
    88
#include "imlauncherplugin.inl"
williamr@2
    89
williamr@2
    90
#endif      // IMLAUNCHERPLUGIN_H   
williamr@2
    91
williamr@2
    92
// End of File