voipplugins/sipimresolver/inc/sipimresolver.h
changeset 0 a4daefaec16c
equal deleted inserted replaced
-1:000000000000 0:a4daefaec16c
       
     1 /*
       
     2 * Copyright (c) 2009 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:  header file for sipimresolver
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_SIPIMRESOLVER_H
       
    20 #define C_SIPIMRESOLVER_H
       
    21 
       
    22 
       
    23 #include <implementationproxy.h>
       
    24 #include <sipresolvedclient2.h>
       
    25 
       
    26 
       
    27 /**
       
    28  *  Class for aiding SIP Client Resolver component to route the incoming
       
    29  *  invites to Instant Messaging (IM) according to request headers and
       
    30  *  content. It also takes relevant phone state variables into account
       
    31  *  when resolving.
       
    32  *
       
    33  *  @code
       
    34  *   CSipImResolver* imResolver = CSipImResolver::NewL();
       
    35  *   TBool match = imResolver->MatchRequestL( method, *requestUri, headers,
       
    36  *       *content, contentType, resolvedClientUid );
       
    37  *  @endcode
       
    38  *
       
    39  *  @lib sipimresolver.lib
       
    40  *  @since S60 v5.0
       
    41  */
       
    42 class CSipImResolver : public CSIPResolvedClient2
       
    43     {
       
    44 
       
    45 public:
       
    46 
       
    47     /**
       
    48      * Two-phased constructor.
       
    49      */
       
    50     static CSipImResolver* NewL();
       
    51 
       
    52     /**
       
    53      * Destructor.
       
    54      */
       
    55 	virtual	~CSipImResolver();
       
    56 
       
    57 // from base class CSIPResolvedClient2
       
    58 
       
    59     /**
       
    60      * From CSIPResolvedClient2
       
    61      * Defined in a base class
       
    62      */
       
    63     TBool MatchAcceptContactsL( RStringF aMethod,
       
    64                                 const CUri8& aRequestUri,
       
    65                                 const RPointerArray<CSIPHeaderBase>& aHeaders,
       
    66                                 const TDesC8& aContent,
       
    67                                 const CSIPContentTypeHeader* aContentType,
       
    68                                 TUid& aClientUid );
       
    69 
       
    70     /**
       
    71      * From CSIPResolvedClient2
       
    72      * Defined in a base class
       
    73      */
       
    74     TBool MatchEventL( RStringF aMethod,
       
    75                        const CUri8& aRequestUri,
       
    76                        const RPointerArray<CSIPHeaderBase>& aHeaders,
       
    77                        const TDesC8& aContent,
       
    78                        const CSIPContentTypeHeader* aContentType,
       
    79                        TUid& aClientUid );
       
    80 
       
    81     /**
       
    82      * From CSIPResolvedClient2
       
    83      * Defined in a base class
       
    84      */
       
    85     TBool MatchRequestL( RStringF aMethod,
       
    86                          const CUri8& aRequestUri,
       
    87                          const RPointerArray<CSIPHeaderBase>& aHeaders,
       
    88                          const TDesC8& aContent,
       
    89                          const CSIPContentTypeHeader* aContentType,
       
    90                          TUid& aClientUid );
       
    91 
       
    92     /**
       
    93      * From CSIPResolvedClient2
       
    94      * Defined in a base class
       
    95      */
       
    96     TBool ConnectSupported();
       
    97 
       
    98     /**
       
    99      * From CSIPResolvedClient2
       
   100      * Defined in a base class
       
   101      */
       
   102     void ConnectL( const TUid& aClientUid );
       
   103 
       
   104     /**
       
   105      * From CSIPResolvedClient2
       
   106      * Defined in a base class
       
   107      */
       
   108     void CancelConnect( const TUid& aClientUid );
       
   109 
       
   110     /**
       
   111      * From CSIPResolvedClient2
       
   112      * Defined in a base class
       
   113      */
       
   114     RPointerArray<CSIPContentTypeHeader> SupportedContentTypesL();
       
   115 
       
   116     /**
       
   117      * From CSIPResolvedClient2
       
   118      * Defined in a base class
       
   119      */
       
   120     RPointerArray<CSdpMediaField> SupportedSdpMediasL();
       
   121 
       
   122     /**
       
   123      * From CSIPResolvedClient2
       
   124      * Defined in a base class
       
   125      */
       
   126     void AddClientSpecificHeadersForOptionsResponseL(
       
   127         RPointerArray<CSIPHeaderBase>& aHeaders );
       
   128 
       
   129 private:
       
   130 
       
   131     CSipImResolver();
       
   132 
       
   133 private: // data
       
   134 
       
   135     /**
       
   136      * Application UID
       
   137      */
       
   138     TUid iApplicationUID;
       
   139     };
       
   140 
       
   141 #endif // C_SIPIMRESOLVER_H