williamr@2: /*
williamr@2: * Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * 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: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:
williamr@2: * Name        : siprefertoheader.h
williamr@2: * Part of     : SIP Codec
williamr@2: * Interface   : SDK API, SIP Codec API
williamr@2: * Version     : SIP/4.0 
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef CSIPREFERTOHEADER_H
williamr@2: #define CSIPREFERTOHEADER_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include "sipaddressheaderbase.h"
williamr@2: #include "_sipcodecdefs.h"
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: class CSIPAddress;
williamr@2: class CSIPHeaderGenericParams;
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: /**
williamr@2: * @publishedAll
williamr@2: * @released
williamr@2: *
williamr@2: * Class provides functions for setting and getting parameters in SIP 
williamr@2: * "Refer-To" header.
williamr@2: *
williamr@2: *  @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPReferToHeader : public CSIPAddressHeaderBase
williamr@2: 	{
williamr@2: 	public:	// Constructors and destructor
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs a CSIPReferToHeader from textual representation 
williamr@2: 		* of the header's value part.
williamr@2: 		* @param aValue a value part of a "Refer-To"-header 
williamr@2: 		*        (e.g. "User <user@host>")
williamr@2: 		* @return a new instance of CSIPReferToHeader   
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPReferToHeader* DecodeL(const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPReferToHeader
williamr@2: 		* @pre aSIPAddress != 0
williamr@2: 		* @param aSIPAddress a name-address, the ownership is transferred.
williamr@2: 		* @return a new instance of CSIPReferToHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPReferToHeader* NewL(CSIPAddress* aSIPAddress);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPReferToHeader and puts it to CleanupStack
williamr@2: 		* @pre aSIPAddress != 0
williamr@2: 		* @param aSIPAddress a name-address, the ownership is transferred,
williamr@2: 		* @return a new instance of CSIPReferToHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPReferToHeader* NewLC(CSIPAddress* aSIPAddress);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Destructor, deletes the resources of CSIPReferToHeader.
williamr@2: 		*/
williamr@2: 		IMPORT_C virtual ~CSIPReferToHeader();
williamr@2: 
williamr@2: 
williamr@2: 	public: // New functions
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs an instance of a CSIPReferToHeader from a RReadStream
williamr@2: 		* @param aReadStream a stream containing the value of the
williamr@2: 		*        externalized object (header name not included). 
williamr@2: 		* @return an instance of a CSIPReferToHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPHeaderBase* InternalizeValueL(RReadStream& aReadStream);
williamr@2: 
williamr@2: 
williamr@2: 	public: // From CSIPHeaderBase
williamr@2: 
williamr@2: 		/**
williamr@2: 		* From CSIPHeaderBase CloneL
williamr@2: 		*/
williamr@2: 		IMPORT_C CSIPHeaderBase* CloneL() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* From CSIPHeaderBase Name
williamr@2: 		*/
williamr@2: 		IMPORT_C RStringF Name() const;
williamr@2: 
williamr@2: 
williamr@2: 	public: // From CSIPHeaderBase, for internal use
williamr@2: 
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */
williamr@2: 		TBool HasCompactName() const;
williamr@2: 		
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */		
williamr@2: 		RStringF CompactName() const;
williamr@2: 		
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */		
williamr@2: 		TPreferredPlace PreferredPlaceInMessage() const;
williamr@2: 
williamr@2: 	public: // New functions, for internal use
williamr@2: 
williamr@2: 		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
williamr@2: 
williamr@2: 	private: // Constructors
williamr@2: 
williamr@2: 		CSIPReferToHeader();
williamr@2: 
williamr@2:     private: // For testing purposes
williamr@2: 	
williamr@2: 		UNIT_TEST(CSIPReferToHeaderTest)
williamr@2: 	};
williamr@2: 
williamr@2: #endif // end of CSIPREFERTOHEADER_H
williamr@2: 
williamr@2: // End of File