CSIPAllowEventsHeader Class Reference

#include <mw/sipalloweventsheader.h>

Link against: sipcodec.lib

class CSIPAllowEventsHeader : public CSIPHeaderBase

Inherits from

CSIPAllowEventsHeader
- CSIPHeaderBase

Public Member Functions
	~CSIPAllowEventsHeader()
RPointerArray< CSIPHeaderBase >	BaseDecodeL(const TDesC8 &)
virtual IMPORT_C CSIPHeaderBase *	CloneL()
virtual RStringF	CompactName()
IMPORT_C RPointerArray< CSIPAllowEventsHeader >	DecodeL(const TDesC8 &)
IMPORT_C const TDesC8 &	EventPackage()
IMPORT_C const MDesC8Array &	EventTemplates()
virtual TBool	HasCompactName()
IMPORT_C CSIPHeaderBase *	InternalizeValueL(RReadStream &)
virtual TBool	MoreThanOneAllowed()
virtual IMPORT_C RStringF	Name()
IMPORT_C CSIPAllowEventsHeader *	NewL(const TDesC8 &)
IMPORT_C CSIPAllowEventsHeader *	NewLC(const TDesC8 &)
virtual TPreferredPlace	PreferredPlaceInMessage()
IMPORT_C void	SetEventPackageL(const TDesC8 &)
IMPORT_C void	SetEventTemplatesL(const MDesC8Array &)
virtual IMPORT_C HBufC8 *	ToTextValueL()

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::PushLC(RPointerArray< CSIPHeaderBase > *)
	CSIPHeaderBase::ToTextL()const
	CSIPHeaderBase::ToTextLC()const
	CSIPHeaderBase::ToTextValueLC()const
	CSIPHeaderBase::~CSIPHeaderBase()

Detailed Description

Class provides functions for setting and getting parameters in SIP "Allow-Events" header.

Constructor & Destructor Documentation

~CSIPAllowEventsHeader ( )

IMPORT_C

~CSIPAllowEventsHeader

(

)

Destructor. deletes the resources of CSIPAllowEventsHeader.

Member Function Documentation

BaseDecodeL ( const TDesC8 & )

RPointerArray< CSIPHeaderBase >

BaseDecodeL

(

const TDesC8 &

aValue

)

[static]

CloneL ( )

IMPORT_C CSIPHeaderBase *

CloneL

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::CloneL()const

From CSIPHeaderBase CloneL

CompactName ( )

RStringF

CompactName

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::CompactName()const

DecodeL ( const TDesC8 & )

IMPORT_C RPointerArray< CSIPAllowEventsHeader >

DecodeL

(

const TDesC8 &

aValue

)

[static]

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

Parameter	Description
aValue	a value part of a "Allow-Events"-header

Returns: An array containing one to many instances of CSIPAllowEventsHeader

EventPackage ( )

IMPORT_C const TDesC8 &

EventPackage

(

)

const

Gets the Event-Package parameter from the "Allow-Events" 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]

Reimplemented from CSIPHeaderBase::HasCompactName()const

InternalizeValueL ( RReadStream & )

IMPORT_C CSIPHeaderBase *

InternalizeValueL

(

RReadStream &

aReadStream

)

[static]

Constructs an instance of a CSIPAllowEventsHeader from a RReadStream

Parameter	Description
aReadStream	a stream containing the value of the externalized object (header name not included).

MoreThanOneAllowed ( )

TBool

MoreThanOneAllowed

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::MoreThanOneAllowed()const

Name ( )

IMPORT_C RStringF

Name

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::Name()const

From CSIPHeaderBase Name

NewL ( const TDesC8 & )

IMPORT_C CSIPAllowEventsHeader *

NewL

(

const TDesC8 &

aEventPackage

)

[static]

Creates a new instance of CSIPAllowEventsHeader

Parameter	Description
aEventPackage	a Event-Package value

Returns: a new instance of CSIPAllowEventsHeader

NewLC ( const TDesC8 & )

IMPORT_C CSIPAllowEventsHeader *

NewLC

(

const TDesC8 &

aEventPackage

)

[static]

Creates a new instance of CSIPAllowEventsHeader and puts it to CleanupStack

Parameter	Description
aEventPackage	a Event-Package value

Returns: a new instance of CSIPAllowEventsHeader

PreferredPlaceInMessage ( )

TPreferredPlace

PreferredPlaceInMessage

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::PreferredPlaceInMessage()const

SetEventPackageL ( const TDesC8 & )

IMPORT_C void

SetEventPackageL

(

const TDesC8 &

aEventPackage

)

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

Parameter	Description
aEventPackage	a Event-Package parameter to set

SetEventTemplatesL ( const MDesC8Array & )

IMPORT_C void

SetEventTemplatesL

(

const MDesC8Array &

aEventTemplates

)

Sets the event templates overwriting all the existing ones.

ToTextValueL ( )

IMPORT_C HBufC8 *

ToTextValueL

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::ToTextValueL()const

From CSIPHeaderBase ToTextValueL