Class CSIPAllowEventsHeader

class CSIPAllowEventsHeader : public CSIPHeaderBase;

Description

Class provides functions for setting and getting parameters in SIP "Allow-Events" 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

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

Members

Defined in CSIPAllowEventsHeader:
CloneL(), DecodeL(), EventPackage(), EventTemplates(), InternalizeValueL(), Name(), NewL(), NewLC(), SetEventPackageL(), SetEventTemplatesL(), ToTextValueL(), ~CSIPAllowEventsHeader()

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

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

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

Description

Creates a new instance of CSIPAllowEventsHeader

Parameters

const TDesC8 &aEventPackage a Event-Package value

Return value

CSIPAllowEventsHeader * a new instance of CSIPAllowEventsHeader

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

Description

Creates a new instance of CSIPAllowEventsHeader and puts it to CleanupStack

Parameters

const TDesC8 &aEventPackage a Event-Package value

Return value

CSIPAllowEventsHeader * a new instance of CSIPAllowEventsHeader

IMPORT_C ~CSIPAllowEventsHeader();

Description

Destructor. deletes the resources of CSIPAllowEventsHeader.

static IMPORT_C RPointerArray< CSIPAllowEventsHeader > DecodeL(const TDesC8 &aValue);

Description

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

Parameters

const TDesC8 &aValue a value part of a "Allow-Events"-header

Return value

RPointerArray< CSIPAllowEventsHeader > An array containing one to many instances of CSIPAllowEventsHeader

IMPORT_C const TDesC8 &EventPackage() const;

Description

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

Return value

const TDesC8 & the Event-Package parameter

IMPORT_C void SetEventPackageL(const TDesC8 &aEventPackage);

Description

Sets the Event-Package parameter in the "Allow-Events" 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

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 CSIPAllowEventsHeader from a RReadStream

Parameters

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

Return value

CSIPHeaderBase *

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

virtual IMPORT_C HBufC8 *ToTextValueL() const;

Description

From CSIPHeaderBase ToTextValueL

Return value

HBufC8 *