CSIPContactHeader Class Reference

API published in: S60 2nd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <sipcontactheader.h>

Inherits CSIPParameterHeaderBase.

Detailed Description

PublishedAll

Released

Class provides functions for setting and getting SIP "Contact" header fields.


Public Member Functions
IMPORT_C�	~CSIPContactHeader ()
�	Destructor, deletes the resources of CSIPContactHeader.
IMPORT_C TBool�	operator== (const CSIPContactHeader &aHeader) const
�	Compares this object to another instance of CSIPContactHeader.
IMPORT_C TBool�	Star () const
�	Checks if the address is set to a STAR ("*").
IMPORT_C TInt�	ExpiresParameter () const
�	Gets the value of the "expires"-parameter.
IMPORT_C void�	SetExpiresParameterL (TInt aExpiresParam)
�	Sets the "expires"-parameter.
IMPORT_C TReal�	QParameter () const
�	Gets the value of "q"-parameter.
IMPORT_C void�	SetQParameterL (TReal aQValue)
�	Sets the "q"-parameter value in the "Contact" header.
IMPORT_C const CSIPAddress *�	SIPAddress () const
�	Gets the name-address as const.
IMPORT_C CSIPAddress *�	SIPAddress ()
�	Gets the name-address.
IMPORT_C void�	SetSIPAddressL (CSIPAddress *aSIPAddress)
�	Sets the name-address.
IMPORT_C CSIPHeaderBase *�	CloneL () const
�	From CSIPHeaderBase CloneL.
IMPORT_C RStringF�	Name () const
�	From CSIPHeaderBase Name.
TBool�	MoreThanOneAllowed () const
TBool�	HasCompactName () const
RStringF�	CompactName () const
TPreferredPlace�	PreferredPlaceInMessage () const
Static Public Member Functions
static IMPORT_C RPointerArray< CSIPContactHeader >�	DecodeL (const TDesC8 &aValue)
�	Constructs a CSIPContactHeader from textual representation of the header's value part.
static IMPORT_C CSIPContactHeader *�	NewL (CSIPAddress *aSIPAddress)
�	Creates a new instance of CSIPContactHeader.
static IMPORT_C CSIPContactHeader *�	NewLC (CSIPAddress *aSIPAddress)
�	Creates a new instance of CSIPContactHeader and puts it to CleanupStack.
static IMPORT_C CSIPHeaderBase *�	InternalizeValueL (RReadStream &aReadStream)
�	Constructs an instance of a CSIPContactHeader from a RReadStream.
static RPointerArray< CSIPHeaderBase >�	BaseDecodeL (const TDesC8 &aValue)

Constructor & Destructor Documentation

IMPORT_C CSIPContactHeader::~CSIPContactHeader

(�

�)�

�	Destructor, deletes the resources of CSIPContactHeader.

Member Function Documentation

static RPointerArray<CSIPHeaderBase> CSIPContactHeader::BaseDecodeL (� const TDesC8 &� aValue �)� [static]

�

IMPORT_C CSIPHeaderBase* CSIPContactHeader::CloneL (� �)� const [virtual]

�	From CSIPHeaderBase CloneL. Implements CSIPHeaderBase.

RStringF CSIPContactHeader::CompactName (� �)� const [virtual]

�	Reimplemented from CSIPHeaderBase.

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

�

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

Note that "Contact: *" can be only created using this function.

Parameters:

aValue�

a value part of a "Contact"-header

Returns:: an array containing 1..n instances of CSIPContactHeader

IMPORT_C TInt CSIPContactHeader::ExpiresParameter

(�

�)�

const

�	Gets the value of the "expires"-parameter. Returns: the "expires"-parameter, or KErrNotFound if the parameter is not present.

TBool CSIPContactHeader::HasCompactName (� �)� const [virtual]

�	Reimplemented from CSIPHeaderBase.

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

�

Constructs an instance of a CSIPContactHeader from a RReadStream.

Parameters:

aReadStream�

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

Returns:: an instance of a CSIPContactHeader

TBool CSIPContactHeader::MoreThanOneAllowed (� �)� const [virtual]

�	Reimplemented from CSIPHeaderBase.

IMPORT_C RStringF CSIPContactHeader::Name (� �)� const [virtual]

�	From CSIPHeaderBase Name. Implements CSIPHeaderBase.

static IMPORT_C CSIPContactHeader* CSIPContactHeader::NewL (� CSIPAddress *� aSIPAddress �)� [static]

�

Creates a new instance of CSIPContactHeader.

Precondition:: aSIPAddress != 0

Parameters:

aSIPAddress�

a name-address, the ownership is transferred

Returns:: a new instance of CSIPContactHeader

static IMPORT_C CSIPContactHeader* CSIPContactHeader::NewLC (� CSIPAddress *� aSIPAddress �)� [static]

�

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

Precondition:: aSIPAddress != 0

Parameters:

aSIPAddress�

a name-address, the ownership is transferred

Returns:: a new instance of CSIPContactHeader

IMPORT_C TBool CSIPContactHeader::operator==

(�

const CSIPContactHeader &�

Compares this object to another instance of CSIPContactHeader.

Parameters:

aHeader�

a CSIPContactHeader header to compare to

Returns:: ETrue if the objects are equal otherwise EFalse

TPreferredPlace CSIPContactHeader::PreferredPlaceInMessage (� �)� const [virtual]

�	Implements CSIPHeaderBase.

IMPORT_C TReal CSIPContactHeader::QParameter

(�

�)�

const

�	Gets the value of "q"-parameter. Precondition: Star() == EFalse Returns: the "q"-parameter value, or zero if the parameter is not present.

IMPORT_C void CSIPContactHeader::SetExpiresParameterL

Sets the "expires"-parameter.