1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/sippassociateduriheader.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,137 @@
1.4 +/*
1.5 +* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* 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
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +* Name : sippassociateduriheader.h
1.19 +* Part of : SIP Codec
1.20 +* Interface : SDK API, SIP Codec API
1.21 +* Version : SIP/4.0
1.22 +*
1.23 +*/
1.24 +
1.25 +
1.26 +
1.27 +
1.28 +#ifndef CSIPPASSOCIATEDURIHEADER_H
1.29 +#define CSIPPASSOCIATEDURIHEADER_H
1.30 +
1.31 +// INCLUDES
1.32 +#include "sipaddressheaderbase.h"
1.33 +#include "_sipcodecdefs.h"
1.34 +
1.35 +// FORWARD DECLARATIONS
1.36 +class CSIPAddress;
1.37 +class CSIPHeaderGenericParams;
1.38 +
1.39 +// CLASS DECLARATION
1.40 +/**
1.41 +* @publishedAll
1.42 +* @released
1.43 +*
1.44 +* Class provides functions for setting and getting parameters in SIP
1.45 +* "P-Associated-URI" header.
1.46 +*
1.47 +* @lib sipcodec.lib
1.48 +*/
1.49 +class CSIPPAssociatedURIHeader : public CSIPAddressHeaderBase
1.50 + {
1.51 + public: // Constructors and destructor
1.52 +
1.53 + /**
1.54 + * Constructs a CSIPPAssociatedURIHeader from textual representation
1.55 + * of the header's value part.
1.56 + * @param aValue a value part of a "P-Associated-URI"-header
1.57 + * (e.g. "User <user@host>;param=value")
1.58 + * @return an array containing one to many instances
1.59 + * of CSIPPAssociatedURIHeader
1.60 + */
1.61 + IMPORT_C static RPointerArray<CSIPPAssociatedURIHeader>
1.62 + DecodeL(const TDesC8& aValue);
1.63 +
1.64 + /**
1.65 + * Creates a new instance of CSIPPAssociatedURIHeader
1.66 + * @pre aSIPAddress != 0
1.67 + * @param aSIPAddress a name-address, the ownership is transferred.
1.68 + * @return a new instance of CSIPPAssociatedURIHeader
1.69 + */
1.70 + IMPORT_C static CSIPPAssociatedURIHeader*
1.71 + NewL(CSIPAddress* aSIPAddress);
1.72 +
1.73 + /**
1.74 + * Creates a new instance of CSIPPAssociatedURIHeader and
1.75 + * puts it to CleanupStack
1.76 + * @pre aSIPAddress != 0
1.77 + * @param aSIPAddress a name-address, the ownership is transferred,
1.78 + * @return a new instance of CSIPPAssociatedURIHeader
1.79 + */
1.80 + IMPORT_C static CSIPPAssociatedURIHeader*
1.81 + NewLC(CSIPAddress* aSIPAddress);
1.82 +
1.83 + /**
1.84 + * Destructor, deletes the resources of CSIPPAssociatedURIHeader.
1.85 + */
1.86 + IMPORT_C virtual ~CSIPPAssociatedURIHeader();
1.87 +
1.88 +
1.89 + public: // New functions
1.90 +
1.91 + /**
1.92 + * Constructs an instance of a CSIPPAssociatedURIHeader from
1.93 + * a RReadStream
1.94 + * @param aReadStream a stream containing the value of the
1.95 + * externalized object (header name not included).
1.96 + * @return an instance of a CSIPPAssociatedURIHeader
1.97 + */
1.98 + IMPORT_C static CSIPHeaderBase*
1.99 + InternalizeValueL(RReadStream& aReadStream);
1.100 +
1.101 + public: // From CSIPHeaderBase
1.102 +
1.103 + /**
1.104 + * From CSIPHeaderBase CloneL
1.105 + */
1.106 + IMPORT_C CSIPHeaderBase* CloneL() const;
1.107 +
1.108 + /**
1.109 + * From CSIPHeaderBase Name
1.110 + */
1.111 + IMPORT_C RStringF Name() const;
1.112 +
1.113 + public: // From CSIPHeaderBase, for internal use
1.114 +
1.115 + /**
1.116 + * @internalComponent
1.117 + */
1.118 + TPreferredPlace PreferredPlaceInMessage() const;
1.119 +
1.120 + /**
1.121 + * @internalComponent
1.122 + */
1.123 + TBool MoreThanOneAllowed() const;
1.124 +
1.125 + public: // New functions, for internal use
1.126 +
1.127 + static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
1.128 +
1.129 + private: // Constructors
1.130 +
1.131 + CSIPPAssociatedURIHeader();
1.132 +
1.133 + private: // For testing purposes
1.134 +
1.135 + UNIT_TEST(CSIPPAssociatedURIHeaderTest)
1.136 + };
1.137 +
1.138 +#endif // end of CSIPPASSOCIATEDURIHEADER_H
1.139 +
1.140 +// End of File