1 siprefertoheader.h

     1 /*

     2 * Copyright (c) 2004-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        : siprefertoheader.h

    16 * Part of     : SIP Codec

    17 * Interface   : SDK API, SIP Codec API

    18 * Version     : SIP/4.0 

    19 *

    20 */

    21 

    22 

    23 

    24 

    25 #ifndef CSIPREFERTOHEADER_H

    26 #define CSIPREFERTOHEADER_H

    27 

    28 //  INCLUDES

    29 #include "sipaddressheaderbase.h"

    30 #include "_sipcodecdefs.h"

    31 

    32 // FORWARD DECLARATIONS

    33 class CSIPAddress;

    34 class CSIPHeaderGenericParams;

    35 

    36 // CLASS DECLARATION

    37 /**

    38 * @publishedAll

    39 * @released

    40 *

    41 * Class provides functions for setting and getting parameters in SIP 

    42 * "Refer-To" header.

    43 *

    44 *  @lib sipcodec.lib

    45 */

    46 class CSIPReferToHeader : public CSIPAddressHeaderBase

    47 	{

    48 	public:	// Constructors and destructor

    49 

    50 		/**

    51 		* Constructs a CSIPReferToHeader from textual representation 

    52 		* of the header's value part.

    53 		* @param aValue a value part of a "Refer-To"-header 

    54 		*        (e.g. "User <user@host>")

    55 		* @return a new instance of CSIPReferToHeader   

    56 		*/

    57 		IMPORT_C static CSIPReferToHeader* DecodeL(const TDesC8& aValue);

    58 

    59 		/**

    60 		* Creates a new instance of CSIPReferToHeader

    61 		* @pre aSIPAddress != 0

    62 		* @param aSIPAddress a name-address, the ownership is transferred.

    63 		* @return a new instance of CSIPReferToHeader

    64 		*/

    65 		IMPORT_C static CSIPReferToHeader* NewL(CSIPAddress* aSIPAddress);

    66 

    67 		/**

    68 		* Creates a new instance of CSIPReferToHeader and puts it to CleanupStack

    69 		* @pre aSIPAddress != 0

    70 		* @param aSIPAddress a name-address, the ownership is transferred,

    71 		* @return a new instance of CSIPReferToHeader

    72 		*/

    73 		IMPORT_C static CSIPReferToHeader* NewLC(CSIPAddress* aSIPAddress);

    74 

    75 		/**

    76 		* Destructor, deletes the resources of CSIPReferToHeader.

    77 		*/

    78 		IMPORT_C virtual ~CSIPReferToHeader();

    79 

    80 

    81 	public: // New functions

    82 

    83 		/**

    84 		* Constructs an instance of a CSIPReferToHeader from a RReadStream

    85 		* @param aReadStream a stream containing the value of the

    86 		*        externalized object (header name not included). 

    87 		* @return an instance of a CSIPReferToHeader

    88 		*/

    89 		IMPORT_C static CSIPHeaderBase* InternalizeValueL(RReadStream& aReadStream);

    90 

    91 

    92 	public: // From CSIPHeaderBase

    93 

    94 		/**

    95 		* From CSIPHeaderBase CloneL

    96 		*/

    97 		IMPORT_C CSIPHeaderBase* CloneL() const;

    98 

    99 		/**

   100 		* From CSIPHeaderBase Name

   101 		*/

   102 		IMPORT_C RStringF Name() const;

   103 

   104 

   105 	public: // From CSIPHeaderBase, for internal use

   106 

   107         /**

   108         * @internalComponent

   109         */

   110 		TBool HasCompactName() const;

   111 		

   112         /**

   113         * @internalComponent

   114         */		

   115 		RStringF CompactName() const;

   116 		

   117         /**

   118         * @internalComponent

   119         */		

   120 		TPreferredPlace PreferredPlaceInMessage() const;

   121 

   122 	public: // New functions, for internal use

   123 

   124 		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);

   125 

   126 	private: // Constructors

   127 

   128 		CSIPReferToHeader();

   129 

   130     private: // For testing purposes

   131 	

   132 		UNIT_TEST(CSIPReferToHeaderTest)

   133 	};

   134 

   135 #endif // end of CSIPREFERTOHEADER_H

   136 

   137 // End of File