CSIPAddress Class Reference

#include <mw/sipaddress.h>

Link against: sipcodec.lib

class CSIPAddress : public CBase

Inherits from

  • CSIPAddress
    Public Member Functions
    ~CSIPAddress()
    IMPORT_C CSIPAddress *DecodeL(const TDesC8 &)
    IMPORT_C const TDesC8 &DisplayName()
    IMPORT_C voidExternalizeL(RWriteStream &)
    IMPORT_C CSIPAddress *InternalizeL(RReadStream &)
    IMPORT_C CSIPAddress *NewL(CUri8 *)
    IMPORT_C CSIPAddress *NewL(const TDesC8 &, CUri8 *)
    IMPORT_C CSIPAddress *NewL(const CSIPAddress &)
    IMPORT_C CSIPAddress *NewLC(CUri8 *)
    IMPORT_C CSIPAddress *NewLC(const TDesC8 &, CUri8 *)
    IMPORT_C CSIPAddress *NewLC(const CSIPAddress &)
    CSIPAddress *NewLC(CURIContainer *)
    IMPORT_C voidSetDisplayNameL(const TDesC8 &)
    IMPORT_C voidSetUri8L(CUri8 *)
    IMPORT_C HBufC8 *ToTextLC(TBool)
    IMPORT_C CURIContainer &URI()
    IMPORT_C const CURIContainer &URI()
    IMPORT_C const CUri8 &Uri8()
    IMPORT_C TBooloperator==(const CSIPAddress &)
    Inherited Functions
    CBase::CBase()
    CBase::Delete(CBase *)
    CBase::Extension_(TUint,TAny *&,TAny *)
    CBase::operator new(TUint)
    CBase::operator new(TUint,TAny *)
    CBase::operator new(TUint,TLeave)
    CBase::operator new(TUint,TLeave,TUint)
    CBase::operator new(TUint,TUint)
    CBase::~CBase()

    Detailed Description

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

    Constructor & Destructor Documentation

    ~CSIPAddress ( )

    IMPORT_C~CSIPAddress()

    Destructor, deletes the resources of CSIPAddress.

    Member Function Documentation

    DecodeL ( const TDesC8 & )

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

    Constructs a CSIPAddress from textual representation

    ParameterDescription
    aValueSIP name-addr as text

    Returns: a new instance of CSIPAddress

    DisplayName ( )

    IMPORT_C const TDesC8 &DisplayName()const

    Gets the display name

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

    ExternalizeL ( RWriteStream & )

    IMPORT_C voidExternalizeL(RWriteStream &aWriteStream)

    Writes the object to a RWriteStream

    ParameterDescription
    aWriteStreama stream where the object is to be externalized

    InternalizeL ( RReadStream & )

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

    Constructs an instance of a CSIPAddress from a RReadStream

    ParameterDescription
    aReadStreama stream containing the externalized object

    Returns: an instance of a CSIPAddress

    NewL ( CUri8 * )

    IMPORT_C CSIPAddress *NewL(CUri8 *aUri8)[static]
    Creates a new instance of CSIPAddress
    Pre-condition
    aUri != 0

    Returns: a new instance of CSIPAddress

    NewL ( const TDesC8 &, CUri8 * )

    IMPORT_C CSIPAddress *NewL(const TDesC8 &aDisplayName,
    CUri8 *aUri8
    )[static]
    Creates a new instance of CSIPAddress
    Pre-condition
    aUri != 0
    ParameterDescription
    aDisplayNamea SIP token or a SIP quoted-string

    Returns: a new instance of CSIPAddress

    NewL ( const CSIPAddress & )

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

    Creates a deep-copy of a CSIPAddress

    ParameterDescription
    aSIPAddressthe address to be copied

    Returns: a new instance of CSIPAddress

    NewLC ( CUri8 * )

    IMPORT_C CSIPAddress *NewLC(CUri8 *aUri8)[static]
    Creates a new instance of CSIPAddress and puts it to CleanupStack
    Pre-condition
    aUri != 0

    Returns: a new instance of CSIPAddress

    NewLC ( const TDesC8 &, CUri8 * )

    IMPORT_C CSIPAddress *NewLC(const TDesC8 &aDisplayName,
    CUri8 *aUri8
    )[static]
    Creates a new instance of CSIPAddress and puts it to CleanupStack
    Pre-condition
    aUri != 0
    ParameterDescription
    aDisplayNamea SIP token or a SIP quoted-string

    Returns: a new instance of CSIPAddress

    NewLC ( const CSIPAddress & )

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

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

    ParameterDescription
    aSIPAddressthe address to be copied

    Returns: a new instance of CSIPAddress

    NewLC ( CURIContainer * )

    CSIPAddress *NewLC(CURIContainer *aURI)[static]

    SetDisplayNameL ( const TDesC8 & )

    IMPORT_C voidSetDisplayNameL(const TDesC8 &aDisplayName)

    Sets the display name

    ParameterDescription
    aDisplayNamea SIP token or a SIP quoted-string

    SetUri8L ( CUri8 * )

    IMPORT_C voidSetUri8L(CUri8 *aUri8)
    Sets the URI part of the address
    Pre-condition
    aUri!= 0

    ToTextLC ( TBool )

    IMPORT_C HBufC8 *ToTextLC(TBoolaUseAngleBrackets = EFalse)const

    Creates a textual representation and pushes it to CleanupStack

    ParameterDescription
    aUseAngleBracketsif ETrue, sets the anglebrackets

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

    URI ( )

    IMPORT_C CURIContainer &URI()

    URI ( )

    IMPORT_C const CURIContainer &URI()const

    Uri8 ( )

    IMPORT_C const CUri8 &Uri8()const

    Gets the URI part of the address as const

    Returns: a reference to the URI object

    operator== ( const CSIPAddress & )

    IMPORT_C TBooloperator==(const CSIPAddress &aSIPAddress)const

    Compares this object to another instance of CSIPAddress

    ParameterDescription
    aSIPAddressa CSIPAddress to compare to

    Returns: ETrue if the objects are equal otherwise EFalse

    © Nokia 2011.