Symbian^3 Application 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 ()
void ClearConcreteProfile ()
void ClearRegistry ()
CSIPConcreteProfile & ConcreteProfile ()
const CSIPConcreteProfile & ConcreteProfile ()
TUint32 ContextId ()
void DefaultSNAPL ( TUint32 &)
IMPORT_C TInt GetParameter ( TUint32 , TDesC8 const *&)
IMPORT_C TInt GetParameter ( TUint32 , TUint32 &)
IMPORT_C TInt GetParameter ( TUint32 , TBool &)
IMPORT_C TInt GetParameter ( TUint32 , MDesC8Array const *&)
IMPORT_C TInt GetParameter ( TUint32 , TUint32 , TDesC8 const *&)
TBool IsContextActive ()
TBool IsEnabled ()
TInt LastRegistrationError ()
CSIPProfile * NewL ( CSIPProfileRegistry *)
CSIPProfile * NewLC ( CSIPProfileRegistry *)
void SetConcreteProfile ( CSIPConcreteProfile *)
void SetEnabled ( TBool )
void SetRegistry ( CSIPProfileRegistryBase *)
IMPORT_C const TSIPProfileTypeInfo & Type ()
Protected Member Functions
CSIPProfile ( CSIPProfileRegistryBase *)
void ConstructL ()
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()

void ClearConcreteProfile ( )

Clears concrete profile that holds actual data

ClearRegistry()

void ClearRegistry ( )

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()

void ConstructL ( ) [protected]

2nd phase constructor.

ContextId()

TUint32 ContextId ( ) const

For internal use only

DefaultSNAPL(TUint32 &)

void DefaultSNAPL ( TUint32 & aSnapId ) const

gets the Default SNAP ID from the Connectivity Settings

Parameters

TUint32 & aSnapId

GetParameter(TUint32, TDesC8 const *&)

IMPORT_C TInt GetParameter ( TUint32 aParam,
TDesC8 const *& aVal
) const

Gets profile parameter

Parameters

TUint32 aParam a parameter to get
TDesC8 const *& aVal on return will contain parameter value

GetParameter(TUint32, TUint32 &)

IMPORT_C TInt GetParameter ( TUint32 aParam,
TUint32 & aVal
) const

Gets profile parameter

Parameters

TUint32 aParam a parameter to get
TUint32 & aVal on return will contain parameter value

GetParameter(TUint32, TBool &)

IMPORT_C TInt GetParameter ( TUint32 aParam,
TBool & aVal
) const

Gets profile parameter

Parameters

TUint32 aParam a parameter to get
TBool & aVal on return will contain parameter value

GetParameter(TUint32, MDesC8Array const *&)

IMPORT_C TInt GetParameter ( TUint32 aParam,
MDesC8Array const *& aVal
) const

Gets profile parameter

Parameters

TUint32 aParam a parameter to get
MDesC8Array const *& aVal on return will contain parameter value

GetParameter(TUint32, TUint32, TDesC8 const *&)

IMPORT_C TInt GetParameter ( TUint32 aServerType,
TUint32 aParam,
TDesC8 const *& aVal
) const

Gets profile parameter that is defined for a particular SIP server

Parameters

TUint32 aServerType
TUint32 aParam a parameter to get
TDesC8 const *& aVal on 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 * aSIPRegistry a SIP profile client providing connection to SIP profile server.

NewLC(CSIPProfileRegistry *)

CSIPProfile * NewLC ( CSIPProfileRegistry * aSIPRegistry ) [static]

Two-phased constructor.

Parameters

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

SetConcreteProfile(CSIPConcreteProfile *)

void SetConcreteProfile ( CSIPConcreteProfile * aProfile )

Sets concrete profile that holds actual data

Parameters

CSIPConcreteProfile * aProfile profile instance containing data

SetEnabled(TBool)

void SetEnabled ( TBool aEnabled )

Sets profiles enabled state

Parameters

TBool aEnabled ETrue if enabled

SetRegistry(CSIPProfileRegistryBase *)

void SetRegistry ( 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.