CSIPEventHeader Class Reference

#include <mw/sipeventheader.h>

Link against: sipcodec.lib

class CSIPEventHeader : public CSIPParameterHeaderBase

Inherits from

Public Member Functions
~CSIPEventHeader()
RPointerArray< CSIPHeaderBase >BaseDecodeL(const TDesC8 &)
virtual IMPORT_C CSIPHeaderBase *CloneL()
virtual RStringF CompactName()
IMPORT_C CSIPEventHeader *DecodeL(const TDesC8 &)
IMPORT_C const TDesC8 &EventPackage()
IMPORT_C const MDesC8Array &EventTemplates()
virtual TBool HasCompactName()
IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &)
virtual IMPORT_C RStringFName()
IMPORT_C CSIPEventHeader *NewL(const TDesC8 &)
IMPORT_C CSIPEventHeader *NewLC(const TDesC8 &)
virtual TPreferredPlace PreferredPlaceInMessage()
IMPORT_C voidSetEventPackageL(const TDesC8 &)
IMPORT_C voidSetEventTemplatesL(const MDesC8Array &)
IMPORT_C TBooloperator==(const CSIPEventHeader &)
Inherited Attributes
CSIPHeaderBase::iLink
Inherited Enumerations
CSIPHeaderBase:TPreferredPlace
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CSIPHeaderBase::CSIPHeaderBase()
CSIPHeaderBase::EncodeMultipleToOneLine()const
CSIPHeaderBase::ExternalizeL(RWriteStream &,TBool)const
CSIPHeaderBase::ExternalizeNameL(RWriteStream &)const
CSIPHeaderBase::ExternalizeSupported()const
CSIPHeaderBase::IsExtensionHeader()const
CSIPHeaderBase::MoreThanOneAllowed()const
CSIPHeaderBase::PushLC(RPointerArray< CSIPHeaderBase > *)
CSIPHeaderBase::ToTextL()const
CSIPHeaderBase::ToTextLC()const
CSIPHeaderBase::ToTextValueLC()const
CSIPHeaderBase::~CSIPHeaderBase()
CSIPParameterHeaderBase::CSIPParameterHeaderBase(const TChar &)
CSIPParameterHeaderBase::DeleteParam(RStringF)
CSIPParameterHeaderBase::HasParam(RStringF)const
CSIPParameterHeaderBase::Param(TInt,RStringF &)const
CSIPParameterHeaderBase::ParamCount()const
CSIPParameterHeaderBase::ParamInsertionAllowed()const
CSIPParameterHeaderBase::ParamValue(RStringF)const
CSIPParameterHeaderBase::ParseL(const TDesC8 &,TBool,TBool)
CSIPParameterHeaderBase::SetParamL(RStringF)
CSIPParameterHeaderBase::SetParamL(RStringF,RStringF)
CSIPParameterHeaderBase::ToTextValueL()const
CSIPParameterHeaderBase::~CSIPParameterHeaderBase()

Detailed Description

Class provides functions for setting and getting parameters in SIP "Event" header.

Constructor & Destructor Documentation

~CSIPEventHeader ( )

IMPORT_C~CSIPEventHeader()

Destructor, deletes the resources of CSIPEventHeader.

Member Function Documentation

BaseDecodeL ( const TDesC8 & )

RPointerArray< CSIPHeaderBase >BaseDecodeL(const TDesC8 &aValue)[static]

CloneL ( )

IMPORT_C CSIPHeaderBase *CloneL()const [virtual]

From CSIPHeaderBase CloneL

CompactName ( )

RStringF CompactName()const [virtual]

DecodeL ( const TDesC8 & )

IMPORT_C CSIPEventHeader *DecodeL(const TDesC8 &aValue)[static]

Constructs a CSIPEventHeader from textual representation of the header's value part.

ParameterDescription
aValuea value part of a "Event"-header

Returns: a new instance of CSIPEventHeader

EventPackage ( )

IMPORT_C const TDesC8 &EventPackage()const

Gets the Event-Package parameter from the "Event" header

Returns: the Event-Package parameter

EventTemplates ( )

IMPORT_C const MDesC8Array &EventTemplates()const

Gets the event templates.

Returns: a reference to the currently set event templates.

HasCompactName ( )

TBool HasCompactName()const [virtual]

InternalizeValueL ( RReadStream & )

IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &aReadStream)[static]

Constructs an instance of a CSIPEventHeader from a RReadStream

ParameterDescription
aReadStreama stream containing the value of the externalized object (header name not included).

Returns: an instance of a CSIPEventHeader

Name ( )

IMPORT_C RStringFName()const [virtual]

Reimplemented from CSIPHeaderBase::Name()const

From CSIPHeaderBase Name

NewL ( const TDesC8 & )

IMPORT_C CSIPEventHeader *NewL(const TDesC8 &aEventPackage)[static]

Creates a new instance of CSIPEventHeader

ParameterDescription
aEventPackagea Event-Package value

Returns: a new instance of CSIPEventHeader

NewLC ( const TDesC8 & )

IMPORT_C CSIPEventHeader *NewLC(const TDesC8 &aEventPackage)[static]

Creates a new instance of CSIPEventHeader and puts it to CleanupStack

ParameterDescription
aEventPackagea Event-Package value

Returns: a new instance of CSIPEventHeader

PreferredPlaceInMessage ( )

TPreferredPlace PreferredPlaceInMessage()const [virtual]

SetEventPackageL ( const TDesC8 & )

IMPORT_C voidSetEventPackageL(const TDesC8 &aEventPackage)

Sets the Event-Package parameter in the "Event" header;

ParameterDescription
aEventPackagea Event-Package parameter to set

SetEventTemplatesL ( const MDesC8Array & )

IMPORT_C voidSetEventTemplatesL(const MDesC8Array &aEventTemplates)

Sets the event templates overwriting all the existing ones.

ParameterDescription
aEventTemplatesan array of event templates

operator== ( const CSIPEventHeader & )

IMPORT_C TBooloperator==(const CSIPEventHeader &aHeader)const

Compares this instance to another CSIPEventHeader instance

ParameterDescription
aHeadera header to compare to

Returns: ETrue if the objects are equal otherwise EFalse