epoc32/include/sipregistrationcontext.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2005-2009 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:
williamr@2
    15
* Name        : sipregistrationcontext.h
williamr@2
    16
* Part of     : SIP Client
williamr@2
    17
* Interface   : SDK API, SIP API
williamr@2
    18
* Version     : 1.0
williamr@2
    19
*
williamr@2
    20
*/
williamr@2
    21
williamr@2
    22
williamr@2
    23
williamr@2
    24
williamr@2
    25
#ifndef MSIPREGISTRATIONCONTEXT_H
williamr@2
    26
#define MSIPREGISTRATIONCONTEXT_H
williamr@2
    27
williamr@2
    28
//  INCLUDES
williamr@2
    29
#include <e32base.h>
williamr@2
    30
williamr@2
    31
// CLASS DECLARATION
williamr@2
    32
williamr@2
    33
/**
williamr@2
    34
*  @publishedAll
williamr@2
    35
*  @released
williamr@2
    36
*
williamr@2
    37
*  The interface for providing
williamr@2
    38
*  information for the SIP request and
williamr@2
    39
*  dialog creation.
williamr@2
    40
*
williamr@2
    41
*  @lib n/a
williamr@2
    42
*/
williamr@2
    43
class MSIPRegistrationContext
williamr@2
    44
	{
williamr@2
    45
     public: // New functions
williamr@2
    46
        /**
williamr@2
    47
		* Destructor
williamr@2
    48
		*/
williamr@2
    49
        virtual ~MSIPRegistrationContext() {}
williamr@2
    50
williamr@2
    51
		/**
williamr@2
    52
		* Checks if the registration context can be
williamr@2
    53
		* used for creating SIP messages/dialogs
williamr@2
    54
        *
williamr@2
    55
		* @return ETrue if can be used, EFalse otherwise
williamr@2
    56
		*/
williamr@2
    57
		virtual TBool IsContextActive() const = 0;
williamr@2
    58
williamr@2
    59
		/**
williamr@2
    60
		* Gets the context id.
williamr@2
    61
        *
williamr@2
    62
		* @return Context id
williamr@2
    63
		* For internal use only
williamr@2
    64
		*/
williamr@2
    65
		virtual TUint32 ContextId() const = 0;
williamr@2
    66
	};
williamr@2
    67
williamr@2
    68
#endif