CSIPAddress Class Reference

API published in: S60 2nd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <sipaddress.h>

Detailed Description

PublishedAll

Released

Class provides functions for setting and getting parameters in SIP name-addr structure


Public Member Functions
IMPORT_C�	~CSIPAddress ()
�	Destructor, deletes the resources of CSIPAddress.
IMPORT_C TBool�	operator== (const CSIPAddress &aSIPAddress) const
�	Compares this object to another instance of CSIPAddress.
IMPORT_C const TDesC8 &�	DisplayName () const
�	Gets the display name.
IMPORT_C void�	SetDisplayNameL (const TDesC8 &aDisplayName)
�	Sets the display name.
IMPORT_C const CUri8 &�	Uri8 () const
�	Gets the URI part of the address as const.
IMPORT_C void�	SetUri8L (CUri8 *aUri8)
�	Sets the URI part of the address.
IMPORT_C HBufC8 *�	ToTextLC (TBool aUseAngleBrackets=EFalse) const
�	Creates a textual representation and pushes it to CleanupStack.
IMPORT_C void�	ExternalizeL (RWriteStream &aWriteStream)
�	Writes the object to a RWriteStream.
IMPORT_C CURIContainer &�	URI ()
IMPORT_C const CURIContainer &�	URI () const
Static Public Member Functions
static IMPORT_C CSIPAddress *�	DecodeL (const TDesC8 &aValue)
�	Constructs a CSIPAddress from textual representation.
static IMPORT_C CSIPAddress *�	NewL (CUri8 *aUri8)
�	Creates a new instance of CSIPAddress.
static IMPORT_C CSIPAddress *�	NewLC (CUri8 *aUri8)
�	Creates a new instance of CSIPAddress and puts it to CleanupStack.
static IMPORT_C CSIPAddress *�	NewL (const TDesC8 &aDisplayName, CUri8 *aUri8)
�	Creates a new instance of CSIPAddress.
static IMPORT_C CSIPAddress *�	NewLC (const TDesC8 &aDisplayName, CUri8 *aUri8)
�	Creates a new instance of CSIPAddress and puts it to CleanupStack.
static IMPORT_C CSIPAddress *�	NewL (const CSIPAddress &aSIPAddress)
�	Creates a deep-copy of a CSIPAddress.
static IMPORT_C CSIPAddress *�	NewLC (const CSIPAddress &aSIPAddress)
�	Creates a deep-copy of a CSIPAddress and puts it to CleanupStack.
static IMPORT_C CSIPAddress *�	InternalizeL (RReadStream &aReadStream)
�	Constructs an instance of a CSIPAddress from a RReadStream.
static CSIPAddress *�	NewLC (CURIContainer *aURI)

Constructor & Destructor Documentation

IMPORT_C CSIPAddress::~CSIPAddress

�	Destructor, deletes the resources of CSIPAddress.

Member Function Documentation

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

Constructs a CSIPAddress from textual representation.

Parameters:

SIP name-addr as text

Returns:: a new instance of CSIPAddress

IMPORT_C const TDesC8& CSIPAddress::DisplayName

�	Gets the display name. Returns: the display name if present, otherwise a zero-length descriptor

IMPORT_C void CSIPAddress::ExternalizeL

RWriteStream &�

Writes the object to a RWriteStream.

Parameters:

aWriteStream�

a stream where the object is to be externalized

static IMPORT_C CSIPAddress* CSIPAddress::InternalizeL (� RReadStream &� aReadStream �)� [static]

Constructs an instance of a CSIPAddress from a RReadStream.

Parameters:

aReadStream�

a stream containing the externalized object

Returns:: an instance of a CSIPAddress

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

Creates a deep-copy of a CSIPAddress.

Parameters:

aSIPAddress�

the address to be copied

Returns:: a new instance of CSIPAddress

static IMPORT_C CSIPAddress* CSIPAddress::NewL	(�	const TDesC8 &�	aDisplayName,
		CUri8 *�	aUri8
	)�	`[static]`

Creates a new instance of CSIPAddress.

Precondition:: aUri != 0

Parameters:

	aDisplayName�	a SIP token or a SIP quoted-string
	aUri�	the ownership is transferred.

Returns:: a new instance of CSIPAddress

static IMPORT_C CSIPAddress* CSIPAddress::NewL (� CUri8 *� aUri8 �)� [static]

Creates a new instance of CSIPAddress.

Precondition:: aUri != 0

Parameters:

the ownership is transferred.

Returns:: a new instance of CSIPAddress

static CSIPAddress* CSIPAddress::NewLC (� CURIContainer *� aURI �)� [static]

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

Creates a deep-copy of a CSIPAddress and puts it to CleanupStack.

Parameters:

aSIPAddress�

the address to be copied

Returns:: a new instance of CSIPAddress

static IMPORT_C CSIPAddress* CSIPAddress::NewLC	(�	const TDesC8 &�	aDisplayName,
		CUri8 *�	aUri8
	)�	`[static]`

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

Precondition:: aUri != 0

Parameters:

	aDisplayName�	a SIP token or a SIP quoted-string
	aUri�	the ownership is transferred.

Returns:: a new instance of CSIPAddress

static IMPORT_C CSIPAddress* CSIPAddress::NewLC (� CUri8 *� aUri8 �)� [static]

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

Precondition:: aUri != 0

Parameters:

the ownership is transferred.

Returns:: a new instance of CSIPAddress

IMPORT_C TBool CSIPAddress::operator==

const CSIPAddress &�

Compares this object to another instance of CSIPAddress.

Parameters:

aSIPAddress�

a CSIPAddress to compare to

Returns:: ETrue if the objects are equal otherwise EFalse

IMPORT_C void CSIPAddress::SetDisplayNameL

const TDesC8 &�

Sets the display name.

Parameters:

aDisplayName�

a SIP token or a SIP quoted-string

IMPORT_C void CSIPAddress::SetUri8L

Sets the URI part of the address.

Precondition:: aUri!= 0

Parameters:

a pointer to the URI object, the ownership is transferred

IMPORT_C HBufC8* CSIPAddress::ToTextLC (� TBool� aUseAngleBrackets = EFalse �)� const

Creates a textual representation and pushes it to CleanupStack.

Parameters:

aUseAngleBrackets�

if ETrue, sets the anglebrackets

Returns:: a textual representation of the object, the ownership is transferred

IMPORT_C const CURIContainer& CSIPAddress::URI

IMPORT_C CURIContainer& CSIPAddress::URI

IMPORT_C const CUri8& CSIPAddress::Uri8

�	Gets the URI part of the address as const. Returns: a reference to the URI object

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

sipaddress.h

Copyright � Nokia Corporation 2001-2007