Class CSIPAddress

class CSIPAddress : public CBase;

Description

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

sipcodec.lib

Derivation

• CBase - Base class for all classes to be instantiated on the heap

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

Members

Defined in CSIPAddress:
DecodeL(), DisplayName(), ExternalizeL(), InternalizeL(), NewL(), NewL(), NewL(), NewLC(), NewLC(), NewLC(), SetDisplayNameL(), SetUri8L(), ToTextLC(), URI(), URI(), Uri8(), operator==(), ~CSIPAddress()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C CSIPAddress *NewL(CUri8 *aUri8);

Pre-Condition

aUri != 0

Description

Creates a new instance of CSIPAddress

Parameters

CUri8 *aUri8

Return value

CSIPAddress * a new instance of CSIPAddress

static IMPORT_C CSIPAddress *NewLC(CUri8 *aUri8);

Pre-Condition

aUri != 0

Description

Creates a new instance of CSIPAddress and puts it to CleanupStack

Parameters

CUri8 *aUri8

Return value

CSIPAddress * a new instance of CSIPAddress

static IMPORT_C CSIPAddress *NewL(const TDesC8 &aDisplayName, CUri8 *aUri8);

Pre-Condition

aUri != 0

Description

Creates a new instance of CSIPAddress

Parameters

const TDesC8 &aDisplayName a SIP token or a SIP quoted-string CUri8 *aUri8

Return value

CSIPAddress * a new instance of CSIPAddress

static IMPORT_C CSIPAddress *NewLC(const TDesC8 &aDisplayName, CUri8 *aUri8);

Pre-Condition

aUri != 0

Description

Creates a new instance of CSIPAddress and puts it to CleanupStack

Parameters

const TDesC8 &aDisplayName a SIP token or a SIP quoted-string CUri8 *aUri8

Return value

CSIPAddress * a new instance of CSIPAddress

static IMPORT_C CSIPAddress *NewL(const CSIPAddress &aSIPAddress);

Description

Creates a deep-copy of a CSIPAddress

Parameters

const CSIPAddress &aSIPAddress the address to be copied

Return value

CSIPAddress * a new instance of CSIPAddress

static IMPORT_C CSIPAddress *NewLC(const CSIPAddress &aSIPAddress);

Description

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

Parameters

const CSIPAddress &aSIPAddress the address to be copied

Return value

CSIPAddress * a new instance of CSIPAddress

IMPORT_C ~CSIPAddress();

Description

Destructor, deletes the resources of CSIPAddress.

static IMPORT_C CSIPAddress *DecodeL(const TDesC8 &aValue);

Description

Constructs a CSIPAddress from textual representation

Parameters

const TDesC8 &aValue SIP name-addr as text

Return value

CSIPAddress * a new instance of CSIPAddress

IMPORT_C TBool operator==(const CSIPAddress &aSIPAddress) const;

Description

Compares this object to another instance of CSIPAddress

Parameters

const CSIPAddress &aSIPAddress a CSIPAddress to compare to

Return value

TBool ETrue if the objects are equal otherwise EFalse

IMPORT_C const TDesC8 &DisplayName() const;

Description

Gets the display name

Return value

const TDesC8 & the display name if present, otherwise a zero-length descriptor

IMPORT_C void SetDisplayNameL(const TDesC8 &aDisplayName);

Description

Sets the display name

Parameters

const TDesC8 &aDisplayName a SIP token or a SIP quoted-string

IMPORT_C const CUri8 &Uri8() const;

Description

Gets the URI part of the address as const

Return value

const CUri8 & a reference to the URI object

IMPORT_C void SetUri8L(CUri8 *aUri8);

Pre-Condition

aUri!= 0

Description

Sets the URI part of the address

Parameters

CUri8 *aUri8

IMPORT_C HBufC8 *ToTextLC(TBool aUseAngleBrackets=EFalse) const;

Description

Creates a textual representation and pushes it to CleanupStack

Parameters

TBool aUseAngleBrackets if ETrue, sets the anglebrackets

Return value

HBufC8 * a textual representation of the object, the ownership is transferred

static IMPORT_C CSIPAddress *InternalizeL(RReadStream &aReadStream);

Description

Constructs an instance of a CSIPAddress from a RReadStream

Parameters

RReadStream &aReadStream a stream containing the externalized object

Return value

CSIPAddress * an instance of a CSIPAddress

IMPORT_C void ExternalizeL(RWriteStream &aWriteStream);

Description

Writes the object to a RWriteStream

Parameters

RWriteStream &aWriteStream a stream where the object is to be externalized

IMPORT_C CURIContainer &URI();

Description

Return value

CURIContainer &

IMPORT_C const CURIContainer &URI() const;

Description

Return value

const CURIContainer &