epoc32/include/mw/sipregistrationcontext.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     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        : 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