S60 3rd Edition API Reference: CSIPAllowEventsHeader Class Reference

CSIPAllowEventsHeader Class Reference

API published in: S60 2nd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <sipalloweventsheader.h>

Inherits CSIPHeaderBase.

Detailed Description

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

Public Member Functions

IMPORT_C ~CSIPAllowEventsHeader ()
 Destructor.
IMPORT_C const TDesC8 & EventPackage () const
 Gets the Event-Package parameter from the "Allow-Events" header.
IMPORT_C void SetEventPackageL (const TDesC8 &aEventPackage)
 Sets the Event-Package parameter in the "Allow-Events" 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.
IMPORT_C HBufC8 * ToTextValueL () const
 From CSIPHeaderBase ToTextValueL.
TBool MoreThanOneAllowed () const
TBool HasCompactName () const
RStringF CompactName () const
TPreferredPlace PreferredPlaceInMessage () const

Static Public Member Functions

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

Constructor & Destructor Documentation

IMPORT_C CSIPAllowEventsHeader::~CSIPAllowEventsHeader (   ) 
 

Destructor.

deletes the resources of CSIPAllowEventsHeader.

Member Function Documentation

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

From CSIPHeaderBase CloneL.

Implements CSIPHeaderBase.

RStringF CSIPAllowEventsHeader::CompactName (   )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

static IMPORT_C RPointerArray<CSIPAllowEventsHeader> CSIPAllowEventsHeader::DecodeL ( const TDesC8 &  aValue  )  [static]
 

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

Parameters:
aValue a value part of a "Allow-Events"-header
Returns:
An array containing one to many instances of CSIPAllowEventsHeader
IMPORT_C const TDesC8& CSIPAllowEventsHeader::EventPackage (   )  const
 

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

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

Gets the event templates.

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

Reimplemented from CSIPHeaderBase.

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

Constructs an instance of a CSIPAllowEventsHeader from a RReadStream.

Parameters:
aReadStream a stream containing the value of the externalized object (header name not included).
TBool CSIPAllowEventsHeader::MoreThanOneAllowed (   )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

IMPORT_C RStringF CSIPAllowEventsHeader::Name (   )  const [virtual]
 

From CSIPHeaderBase Name.

Implements CSIPHeaderBase.

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

Creates a new instance of CSIPAllowEventsHeader.

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

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

Parameters:
aEventPackage a Event-Package value
Returns:
a new instance of CSIPAllowEventsHeader
TPreferredPlace CSIPAllowEventsHeader::PreferredPlaceInMessage (   )  const [virtual]
 

Implements CSIPHeaderBase.

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

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

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

Sets the event templates overwriting all the existing ones.

Parameters:
aEventTemplates 
IMPORT_C HBufC8* CSIPAllowEventsHeader::ToTextValueL (   )  const [virtual]
 

From CSIPHeaderBase ToTextValueL.

Implements CSIPHeaderBase.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top