S60 3rd Edition API Reference: CSIPReferToHeader Class Reference

CSIPReferToHeader Class Reference

API published in: S60 3rd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <siprefertoheader.h>

Inherits CSIPAddressHeaderBase.

Detailed Description

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

Public Member Functions

virtual IMPORT_C ~CSIPReferToHeader ()
 Destructor, deletes the resources of CSIPReferToHeader.
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 CSIPReferToHeader * DecodeL (const TDesC8 &aValue)
 Constructs a CSIPReferToHeader from textual representation of the header's value part.
static IMPORT_C CSIPReferToHeader * NewL (CSIPAddress *aSIPAddress)
 Creates a new instance of CSIPReferToHeader.
static IMPORT_C CSIPReferToHeader * NewLC (CSIPAddress *aSIPAddress)
 Creates a new instance of CSIPReferToHeader and puts it to CleanupStack.
static IMPORT_C CSIPHeaderBase * InternalizeValueL (RReadStream &aReadStream)
 Constructs an instance of a CSIPReferToHeader from a RReadStream.
static RPointerArray< CSIPHeaderBase > BaseDecodeL (const TDesC8 &aValue)

Constructor & Destructor Documentation

virtual IMPORT_C CSIPReferToHeader::~CSIPReferToHeader (   )  [virtual]
 

Destructor, deletes the resources of CSIPReferToHeader.

Member Function Documentation

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

From CSIPHeaderBase CloneL.

Implements CSIPHeaderBase.

RStringF CSIPReferToHeader::CompactName (   )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

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

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

Parameters:
aValue a value part of a "Refer-To"-header (e.g. "User <user@host>")
Returns:
a new instance of CSIPReferToHeader
TBool CSIPReferToHeader::HasCompactName (   )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

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

Constructs an instance of a CSIPReferToHeader from a RReadStream.

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

From CSIPHeaderBase Name.

Implements CSIPHeaderBase.

static IMPORT_C CSIPReferToHeader* CSIPReferToHeader::NewL ( CSIPAddress *  aSIPAddress  )  [static]
 

Creates a new instance of CSIPReferToHeader.

Precondition:
aSIPAddress != 0
Parameters:
aSIPAddress a name-address, the ownership is transferred.
Returns:
a new instance of CSIPReferToHeader
static IMPORT_C CSIPReferToHeader* CSIPReferToHeader::NewLC ( CSIPAddress *  aSIPAddress  )  [static]
 

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

Precondition:
aSIPAddress != 0
Parameters:
aSIPAddress a name-address, the ownership is transferred,
Returns:
a new instance of CSIPReferToHeader
TPreferredPlace CSIPReferToHeader::PreferredPlaceInMessage (   )  const [virtual]
 

Implements CSIPHeaderBase.

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