1 /*

     2 * Copyright (c) 2005-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:

    15 * Name          : MSipClient.h

    16 * Part of       : SIP Client Resolver

    17 * Version       : 1.0

    18 *

    19 */

    20 

    21 

    22 

    23 

    24 /**

    25  @internalComponent

    26 */

    27 

    28 #ifndef MSIPCLIENT_H

    29 #define MSIPCLIENT_H

    30 

    31 #include <e32std.h>

    32 

    33 class CSIPHeaderBase;

    34 class CSIPFeatureSet;

    35 class CSdpDocument;

    36 

    37 

    38 class MSipClient

    39     {

    40 public:

    41 

    42 	/**

    43 	 * Gets the UID of the client.

    44 	 *

    45      * @return a client UID

    46 	 */

    47 	virtual const TUid& ClientUid() const = 0;

    48 	

    49 	/**

    50 	 * Tells if the client is ROM based.

    51 	 *

    52      * @return ETrue application is ROM based, EFalse otherwise

    53 	 */

    54 	virtual TBool RomBased() const = 0;	

    55 	

    56 	/**

    57 	 * Tells if the application can be started by the SIP stack.

    58 	 *

    59      * @return ETrue application can be started, EFalse otherwise

    60 	 */

    61 	virtual TBool AllowStarting() const = 0;

    62 

    63 	/**

    64 	 * Gets the SIP Headers describing the capabilities of the client.

    65      *

    66 	 * @return an array of SIP Headers. 

    67 	 *         The ownership of the headers is NOT transferred.    

    68 	 */

    69     virtual RPointerArray<CSIPHeaderBase>& SIPHeaders() = 0;

    70 

    71 	/**

    72 	 * Gets the SIP feature sets supported by the client.

    73      *

    74 	 * @return the SIP feature set

    75 	 */

    76     virtual CSIPFeatureSet& SIPFeatureSet() = 0;

    77 

    78 	/**

    79 	 * Gets the SDP capabilities of the application.

    80 	 *

    81      * @return CSdpDocument instance, if present for the client, 

    82 	 *         otherwise NULL. The ownership of object is NOT transferred.

    83 	 */

    84 	virtual CSdpDocument& SdpDocument() = 0;

    85     };

    86 

    87 #endif // MSIPCLIENT_H

    88 

    89 // End of File