Symbian^3 Product Developer Library >

CSIPProfile Class Reference

class CSIPProfile : public CBase

Class contains profile information of particular SIP service provider. Class provides functions for quering profile parameter values. sipprofilecli.lib

Inherits from

Public Member Functions
~CSIPProfile()
voidClearConcreteProfile()
voidClearRegistry()
CSIPConcreteProfile &ConcreteProfile()
const CSIPConcreteProfile &ConcreteProfile()
TUint32 ContextId()
voidDefaultSNAPL(TUint32 &)
IMPORT_C TIntGetParameter(TUint32, TDesC8 const *&)
IMPORT_C TIntGetParameter(TUint32, TUint32 &)
IMPORT_C TIntGetParameter(TUint32, TBool &)
IMPORT_C TIntGetParameter(TUint32, MDesC8Array const *&)
IMPORT_C TIntGetParameter(TUint32, TUint32, TDesC8 const *&)
TBool IsContextActive()
TBool IsEnabled()
TInt LastRegistrationError()
CSIPProfile *NewL(CSIPProfileRegistry *)
CSIPProfile *NewLC(CSIPProfileRegistry *)
voidSetConcreteProfile(CSIPConcreteProfile *)
voidSetEnabled(TBool)
voidSetRegistry(CSIPProfileRegistryBase *)
IMPORT_C const TSIPProfileTypeInfo &Type()
Protected Member Functions
CSIPProfile(CSIPProfileRegistryBase *)
voidConstructL()
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()
Protected Attributes
CSIPConcreteProfile *iSIPProfile
CSIPProfileRegistryBase *iSIPProfileRegistry
Private Attributes
TBool iEnabled

Constructor & Destructor Documentation

CSIPProfile(CSIPProfileRegistryBase *)

CSIPProfile(CSIPProfileRegistryBase *aRegistry)[protected]

Constructor.

Parameters

CSIPProfileRegistryBase * aRegistry

~CSIPProfile()

IMPORT_C~CSIPProfile()
Destructor.
capability
NetworkServices

Member Functions Documentation

ClearConcreteProfile()

voidClearConcreteProfile()

Clears concrete profile that holds actual data

ClearRegistry()

voidClearRegistry()

Clears pointer to registry from profile

ConcreteProfile()

CSIPConcreteProfile &ConcreteProfile()

Gets concrete profile that holds actual data

ConcreteProfile()

const CSIPConcreteProfile &ConcreteProfile()const

Gets concrete profile that holds actual data

ConstructL()

voidConstructL()[protected]

2nd phase constructor.

ContextId()

TUint32 ContextId()const

For internal use only

DefaultSNAPL(TUint32 &)

voidDefaultSNAPL(TUint32 &aSnapId)const

gets the Default SNAP ID from the Connectivity Settings

Parameters

TUint32 & aSnapId

GetParameter(TUint32, TDesC8 const *&)

IMPORT_C TIntGetParameter(TUint32aParam,
TDesC8 const *&aVal
)const

Gets profile parameter

Parameters

TUint32 aParama parameter to get
TDesC8 const *& aValon return will contain parameter value

GetParameter(TUint32, TUint32 &)

IMPORT_C TIntGetParameter(TUint32aParam,
TUint32 &aVal
)const

Gets profile parameter

Parameters

TUint32 aParama parameter to get
TUint32 & aValon return will contain parameter value

GetParameter(TUint32, TBool &)

IMPORT_C TIntGetParameter(TUint32aParam,
TBool &aVal
)const

Gets profile parameter

Parameters

TUint32 aParama parameter to get
TBool & aValon return will contain parameter value

GetParameter(TUint32, MDesC8Array const *&)

IMPORT_C TIntGetParameter(TUint32aParam,
MDesC8Array const *&aVal
)const

Gets profile parameter

Parameters

TUint32 aParama parameter to get
MDesC8Array const *& aValon return will contain parameter value

GetParameter(TUint32, TUint32, TDesC8 const *&)

IMPORT_C TIntGetParameter(TUint32aServerType,
TUint32aParam,
TDesC8 const *&aVal
)const

Gets profile parameter that is defined for a particular SIP server

Parameters

TUint32 aServerType
TUint32 aParama parameter to get
TDesC8 const *& aValon return will contain parameter value

IsContextActive()

TBool IsContextActive()const

Tests if the registration context can be used for creating SIP messages/dialogs Profile can be used, when CSIPProfileRegistry::IsEnabled() == ETrue and Status() == ERegistered.

IsEnabled()

TBool IsEnabled()const

Checks if the profile is enabled

LastRegistrationError()

TInt LastRegistrationError()const

Gets last occurred error during registration

NewL(CSIPProfileRegistry *)

CSIPProfile *NewL(CSIPProfileRegistry *aSIPRegistry)[static]

Two-phased constructor.

Parameters

CSIPProfileRegistry * aSIPRegistrya SIP profile client providing connection to SIP profile server.

NewLC(CSIPProfileRegistry *)

CSIPProfile *NewLC(CSIPProfileRegistry *aSIPRegistry)[static]

Two-phased constructor.

Parameters

CSIPProfileRegistry * aSIPRegistrya SIP profile client providing connection to SIP profile server. Constructs an object and adds the pointer to the cleanup stack;

SetConcreteProfile(CSIPConcreteProfile *)

voidSetConcreteProfile(CSIPConcreteProfile *aProfile)

Sets concrete profile that holds actual data

Parameters

CSIPConcreteProfile * aProfileprofile instance containing data

SetEnabled(TBool)

voidSetEnabled(TBoolaEnabled)

Sets profiles enabled state

Parameters

TBool aEnabledETrue if enabled

SetRegistry(CSIPProfileRegistryBase *)

voidSetRegistry(CSIPProfileRegistryBase *aRegistry)

sets pointer to registry for profile

Parameters

CSIPProfileRegistryBase * aRegistry

Type()

IMPORT_C const TSIPProfileTypeInfo &Type()const

Gets profile type information

Member Data Documentation

TBool iEnabled

TBool iEnabled[private]

CSIPConcreteProfile * iSIPProfile

CSIPConcreteProfile *iSIPProfile[protected]

CSIPProfileRegistryBase * iSIPProfileRegistry

CSIPProfileRegistryBase *iSIPProfileRegistry[protected]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.