S60 3rd Edition API Reference: CSIPAcceptContactHeader Class Reference

CSIPAcceptContactHeader Class Reference

API published in: S60 3rd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None


#include <sipacceptcontactheader.h>

Inherits CSIPParameterHeaderBase.


Detailed Description

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

Public Member Functions

virtual IMPORT_C ~CSIPAcceptContactHeader ()
 Destructor, deletes the resources of CSIPAcceptContactHeader.
IMPORT_C TBool operator== (const CSIPAcceptContactHeader &aHeader) const
 Compares this instance to another "Accept-Contact" header object.
IMPORT_C CSIPHeaderBaseCloneL () const
 From CSIPHeaderBase CloneL.
IMPORT_C RStringF Name () const
 From CSIPHeaderBase Name.
TBool HasCompactName () const
RStringF CompactName () const
TBool MoreThanOneAllowed () const
TPreferredPlace PreferredPlaceInMessage () const

Static Public Member Functions

static IMPORT_C RPointerArray<
CSIPAcceptContactHeader
DecodeL (const TDesC8 &aValue)
 Constructs a CSIPAcceptContactHeader from textual representation of the header's value part.
static IMPORT_C CSIPAcceptContactHeaderNewL ()
 Creates a new instance of CSIPAcceptContactHeader.
static IMPORT_C CSIPAcceptContactHeaderNewLC ()
 Creates a new instance of CSIPAcceptContactHeader On return the new instance has left to the CleanupStack.
static IMPORT_C CSIPHeaderBaseInternalizeValueL (RReadStream &aReadStream)
 Constructs an instance of a CSIPAcceptContactHeader from a RReadStream.
static RPointerArray< CSIPHeaderBaseBaseDecodeL (const TDesC8 &aValue)

Constructor & Destructor Documentation

virtual IMPORT_C CSIPAcceptContactHeader::~CSIPAcceptContactHeader  )  [virtual]
 

Destructor, deletes the resources of CSIPAcceptContactHeader.


Member Function Documentation

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

From CSIPHeaderBase CloneL.

Implements CSIPHeaderBase.

RStringF CSIPAcceptContactHeader::CompactName  )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

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

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

Parameters:
aValue a value part of a "Accept-Contact"-header (e.g. "*;param=value")
Returns:
an array containing one to many instances of CSIPAcceptContactHeader
TBool CSIPAcceptContactHeader::HasCompactName  )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

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

Constructs an instance of a CSIPAcceptContactHeader from a RReadStream.

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

Reimplemented from CSIPHeaderBase.

IMPORT_C RStringF CSIPAcceptContactHeader::Name  )  const [virtual]
 

From CSIPHeaderBase Name.

Implements CSIPHeaderBase.

static IMPORT_C CSIPAcceptContactHeader* CSIPAcceptContactHeader::NewL  )  [static]
 

Creates a new instance of CSIPAcceptContactHeader.

Returns:
a new instance of CSIPAcceptContactHeader
static IMPORT_C CSIPAcceptContactHeader* CSIPAcceptContactHeader::NewLC  )  [static]
 

Creates a new instance of CSIPAcceptContactHeader On return the new instance has left to the CleanupStack.

Returns:
a new instance of CSIPAcceptContactHeader
IMPORT_C TBool CSIPAcceptContactHeader::operator== const CSIPAcceptContactHeader aHeader  )  const
 

Compares this instance to another "Accept-Contact" header object.

Two Accept-Contact-headers are equal, if both contain exactly the same parameters. The order of the parameters is not sufficient.

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

Implements CSIPHeaderBase.


The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2007
Back to top