1 sipregistrationcontext.h

     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 * Name        : sipregistrationcontext.h

    16 * Part of     : SIP Client

    17 * Interface   : SDK API, SIP API

    18 * Version     : 1.0

    19 *

    20 */

    21 

    22 

    23 

    24 

    25 #ifndef MSIPREGISTRATIONCONTEXT_H

    26 #define MSIPREGISTRATIONCONTEXT_H

    27 

    28 //  INCLUDES

    29 #include <e32base.h>

    30 

    31 // CLASS DECLARATION

    32 

    33 /**

    34 *  @publishedAll

    35 *  @released

    36 *

    37 *  The interface for providing

    38 *  information for the SIP request and

    39 *  dialog creation.

    40 *

    41 *  @lib n/a

    42 */

    43 class MSIPRegistrationContext

    44 	{

    45      public: // New functions

    46         /**

    47 		* Destructor

    48 		*/

    49         virtual ~MSIPRegistrationContext() {}

    50 

    51 		/**

    52 		* Checks if the registration context can be

    53 		* used for creating SIP messages/dialogs

    54         *

    55 		* @return ETrue if can be used, EFalse otherwise

    56 		*/

    57 		virtual TBool IsContextActive() const = 0;

    58 

    59 		/**

    60 		* Gets the context id.

    61         *

    62 		* @return Context id

    63 		* For internal use only

    64 		*/

    65 		virtual TUint32 ContextId() const = 0;

    66 	};

    67 

    68 #endif