S60 3rd Edition API Reference: CSIPEventHeader Class Reference

CSIPEventHeader Class Reference

API published in: S60 2nd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <sipeventheader.h>

Inherits CSIPParameterHeaderBase.

Detailed Description

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

Public Member Functions

IMPORT_C ~CSIPEventHeader ()
 Destructor, deletes the resources of CSIPEventHeader.
IMPORT_C TBool operator== (const CSIPEventHeader &aHeader) const
 Compares this instance to another CSIPEventHeader instance.
IMPORT_C const TDesC8 & EventPackage () const
 Gets the Event-Package parameter from the "Event" header.
IMPORT_C void SetEventPackageL (const TDesC8 &aEventPackage)
 Sets the Event-Package parameter in the "Event" header;.
IMPORT_C void SetEventTemplatesL (const MDesC8Array &aEventTemplates)
 Sets the event templates overwriting all the existing ones.
IMPORT_C const MDesC8Array & EventTemplates () const
 Gets the event templates.
IMPORT_C CSIPHeaderBase * CloneL () const
 From CSIPHeaderBase CloneL.
IMPORT_C RStringF Name () const
 From CSIPHeaderBase Name.
TBool HasCompactName () const
RStringF CompactName () const
TPreferredPlace PreferredPlaceInMessage () const

Static Public Member Functions

static IMPORT_C CSIPEventHeader * DecodeL (const TDesC8 &aValue)
 Constructs a CSIPEventHeader from textual representation of the header's value part.
static IMPORT_C CSIPEventHeader * NewL (const TDesC8 &aEventPackage)
 Creates a new instance of CSIPEventHeader.
static IMPORT_C CSIPEventHeader * NewLC (const TDesC8 &aEventPackage)
 Creates a new instance of CSIPEventHeader and puts it to CleanupStack.
static IMPORT_C CSIPHeaderBase * InternalizeValueL (RReadStream &aReadStream)
 Constructs an instance of a CSIPEventHeader from a RReadStream.
static RPointerArray< CSIPHeaderBase > BaseDecodeL (const TDesC8 &aValue)

Constructor & Destructor Documentation

IMPORT_C CSIPEventHeader::~CSIPEventHeader (   ) 
 

Destructor, deletes the resources of CSIPEventHeader.

Member Function Documentation

static RPointerArray<CSIPHeaderBase> CSIPEventHeader::BaseDecodeL ( const TDesC8 &  aValue  )  [static]
 
IMPORT_C CSIPHeaderBase* CSIPEventHeader::CloneL (   )  const [virtual]
 

From CSIPHeaderBase CloneL.

Implements CSIPHeaderBase.

RStringF CSIPEventHeader::CompactName (   )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

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

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

Parameters:
aValue a value part of a "Event"-header
Returns:
a new instance of CSIPEventHeader
IMPORT_C const TDesC8& CSIPEventHeader::EventPackage (   )  const
 

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

Returns:
the Event-Package parameter
IMPORT_C const MDesC8Array& CSIPEventHeader::EventTemplates (   )  const
 

Gets the event templates.

Returns:
a reference to the currently set event templates.
TBool CSIPEventHeader::HasCompactName (   )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

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

Constructs an instance of a CSIPEventHeader from a RReadStream.

Parameters:
aReadStream a stream containing the value of the externalized object (header name not included).
Returns:
an instance of a CSIPEventHeader
IMPORT_C RStringF CSIPEventHeader::Name (   )  const [virtual]
 

From CSIPHeaderBase Name.

Implements CSIPHeaderBase.

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

Creates a new instance of CSIPEventHeader.

Parameters:
aEventPackage a Event-Package value
Returns:
a new instance of CSIPEventHeader
static IMPORT_C CSIPEventHeader* CSIPEventHeader::NewLC ( const TDesC8 &  aEventPackage  )  [static]
 

Creates a new instance of CSIPEventHeader and puts it to CleanupStack.

Parameters:
aEventPackage a Event-Package value
Returns:
a new instance of CSIPEventHeader
IMPORT_C TBool CSIPEventHeader::operator== ( const CSIPEventHeader &  aHeader  )  const
 

Compares this instance to another CSIPEventHeader instance.

Parameters:
aHeader a header to compare to
Returns:
ETrue if the objects are equal otherwise EFalse
TPreferredPlace CSIPEventHeader::PreferredPlaceInMessage (   )  const [virtual]
 

Implements CSIPHeaderBase.

IMPORT_C void CSIPEventHeader::SetEventPackageL ( const TDesC8 &  aEventPackage  ) 
 

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

Parameters:
aEventPackage a Event-Package parameter to set
IMPORT_C void CSIPEventHeader::SetEventTemplatesL ( const MDesC8Array &  aEventTemplates  ) 
 

Sets the event templates overwriting all the existing ones.

Parameters:
aEventTemplates an array of event templates
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top