Class CSIPEventHeader

class CSIPEventHeader : public CSIPParameterHeaderBase;

Description

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

sipcodec.lib

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CSIPHeaderBase - Class provides a generic interface for all the SIP headers

• CSIPParameterHeaderBase - A base class for SIP headers that have structure "mandatory part"delimiter"parameters"

• CSIPEventHeader - Class provides functions for setting and getting parameters in SIP "Event" header

Members

Defined in CSIPEventHeader:
CloneL(), DecodeL(), EventPackage(), EventTemplates(), InternalizeValueL(), Name(), NewL(), NewLC(), SetEventPackageL(), SetEventTemplatesL(), operator==(), ~CSIPEventHeader()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CSIPHeaderBase:
ExternalizeL(), ExternalizeSupported(), PushLC(), ToTextL(), ToTextLC(), ToTextValueLC()

Inherited from CSIPParameterHeaderBase:
DeleteParam(), HasParam(), Param(), ParamCount(), ParamValue(), SetParamL(), ToTextValueL()

static IMPORT_C CSIPEventHeader *NewL(const TDesC8 &aEventPackage);

Description

Creates a new instance of CSIPEventHeader

Parameters

const TDesC8 &aEventPackage a Event-Package value

Return value

CSIPEventHeader * a new instance of CSIPEventHeader

static IMPORT_C CSIPEventHeader *NewLC(const TDesC8 &aEventPackage);

Description

Creates a new instance of CSIPEventHeader and puts it to CleanupStack

Parameters

const TDesC8 &aEventPackage a Event-Package value

Return value

CSIPEventHeader * a new instance of CSIPEventHeader

IMPORT_C ~CSIPEventHeader();

Description

Destructor, deletes the resources of CSIPEventHeader.

static IMPORT_C CSIPEventHeader *DecodeL(const TDesC8 &aValue);

Description

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

Parameters

const TDesC8 &aValue a value part of a "Event"-header

Return value

CSIPEventHeader * a new instance of CSIPEventHeader

IMPORT_C TBool operator==(const CSIPEventHeader &aHeader) const;

Description

Compares this instance to another CSIPEventHeader instance

Parameters

const CSIPEventHeader &aHeader a header to compare to

Return value

TBool ETrue if the objects are equal otherwise EFalse

IMPORT_C const TDesC8 &EventPackage() const;

Description

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

Return value

const TDesC8 & the Event-Package parameter

IMPORT_C void SetEventPackageL(const TDesC8 &aEventPackage);

Description

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

Parameters

const TDesC8 &aEventPackage a Event-Package parameter to set

IMPORT_C void SetEventTemplatesL(const MDesC8Array &aEventTemplates);

Description

Sets the event templates overwriting all the existing ones.

Parameters

const MDesC8Array &aEventTemplates an array of event templates

IMPORT_C const MDesC8Array &EventTemplates() const;

Description

Gets the event templates.

Return value

const MDesC8Array & a reference to the currently set event templates.

static IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &aReadStream);

Description

Constructs an instance of a CSIPEventHeader from a RReadStream

Parameters

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

Return value

CSIPHeaderBase * an instance of a CSIPEventHeader

virtual IMPORT_C CSIPHeaderBase *CloneL() const;

Description

From CSIPHeaderBase CloneL

Return value

CSIPHeaderBase *

virtual IMPORT_C RStringF Name() const;

Description

From CSIPHeaderBase Name

Return value

RStringF