CSIPProfile Class Reference

API published in: S60 2nd Ed

Link against: sipprofilecli.lib

Capability Information

Required Capabilities

Location NetworkControl NetworkServices ReadDeviceData ReadUserData WriteDeviceData

#include <sipprofile.h>

Inherits MSIPRegistrationContext.

Detailed Description

PublishedAll

Released

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


Public Member Functions
IMPORT_C�	~CSIPProfile ()
�	Destructor.
IMPORT_C const TSIPProfileTypeInfo &�	Type () const
�	Gets profile type information.
IMPORT_C TInt�	GetParameter (TUint32 aParam, TDesC8 const *&aVal) const
�	Gets profile parameter.
IMPORT_C TInt�	GetParameter (TUint32 aParam, TUint32 &aVal) const
�	Gets profile parameter.
IMPORT_C TInt�	GetParameter (TUint32 aParam, TBool &aVal) const
�	Gets profile parameter.
IMPORT_C TInt�	GetParameter (TUint32 aParam, MDesC8Array const *&aVal) const
�	Gets profile parameter.
IMPORT_C TInt�	GetParameter (TUint32 aServerType, TUint32 aParam, TDesC8 const *&aVal) const
�	Gets profile parameter that is defined for a particular SIP server.
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.
TUint32�	ContextId () const
�	For internal use only.
void�	SetEnabled (TBool aEnabled)
�	Sets profiles enabled state.
void�	SetConcreteProfile (CSIPConcreteProfile *aProfile)
�	Sets concrete profile that holds actual data.
void�	ClearConcreteProfile ()
�	Clears concrete profile that holds actual data.
CSIPConcreteProfile &�	ConcreteProfile ()
�	Gets concrete profile that holds actual data.
const CSIPConcreteProfile &�	ConcreteProfile () const
�	Gets concrete profile that holds actual data.
TBool�	IsEnabled () const
�	Checks if the profile is enabled.
TInt�	LastRegistrationError () const
�	Gets last occurred error during registration.
TBool�	operator== (const CSIPProfile &aProfile) const
�	Checks if two profiles are equal.
void�	SetRegistry (CSIPProfileRegistryBase *aRegistry)
�	sets pointer to registry for profile
void�	ClearRegistry ()
�	Clears pointer to registry from profile.
Static Public Member Functions
static CSIPProfile *�	NewL (CSIPProfileRegistry *aSIPRegistry)
�	Two-phased constructor.
static CSIPProfile *�	NewLC (CSIPProfileRegistry *aSIPRegistry)
�	Two-phased constructor.
Protected Member Functions
�	CSIPProfile (CSIPProfileRegistryBase *aRegistry)
�	Constructor.
void�	ConstructL ()
�	2nd phase constructor.
Protected Attributes
CSIPConcreteProfile *�	iSIPProfile
CSIPProfileRegistryBase *�	iSIPProfileRegistry

Constructor & Destructor Documentation

IMPORT_C CSIPProfile::~CSIPProfile

(�

�)�

�	Destructor. NetworkServices

CSIPProfile::CSIPProfile (� CSIPProfileRegistryBase *� aRegistry �)� [protected]

�	Constructor.

Member Function Documentation

void CSIPProfile::ClearConcreteProfile

(�

�)�

�	Clears concrete profile that holds actual data.

void CSIPProfile::ClearRegistry

(�

�)�

�	Clears pointer to registry from profile.

const CSIPConcreteProfile& CSIPProfile::ConcreteProfile

(�

�)�

const

�	Gets concrete profile that holds actual data. Returns: concrete profile holding data

CSIPConcreteProfile& CSIPProfile::ConcreteProfile

(�

�)�

�	Gets concrete profile that holds actual data. Returns: concrete profile holding data

void CSIPProfile::ConstructL (� �)� [protected]

�	2nd phase constructor.

TUint32 CSIPProfile::ContextId (� �)� const [virtual]

�	For internal use only. Returns: context id Implements MSIPRegistrationContext.

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

�

Gets profile parameter that is defined for a particular SIP server.

Parameters:

	aServer�	a SIP server type
	aParam�	a parameter to get
	aVal�	on return will contain parameter value

Returns:: KErrNotFound if parameter was not found, KErrNone otherwise

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

�

Gets profile parameter.

Parameters:

	aParam�	a parameter to get
	aVal�	on return will contain parameter value

Returns:: KErrNotFound if parameter was not found, KErrNone otherwise

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

�

Gets profile parameter.

Parameters:

	aParam�	a parameter to get
	aVal�	on return will contain parameter value

Returns:: KErrNotFound if parameter was not found, KErrNone otherwise

IMPORT_C TInt CSIPProfile::GetParameter	(�	TUint32�	aParam,
		TUint32 &�	aVal
	)�	const

�

Gets profile parameter.

Parameters:

	aParam�	a parameter to get
	aVal�	on return will contain parameter value

Returns:: KErrNotFound if parameter was not found, KErrNone otherwise

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

�

Gets profile parameter.

Parameters:

	aParam�	a parameter to get
	aVal�	on return will contain parameter value

Returns:: KErrNotFound if parameter was not found, KErrNone otherwise

TBool CSIPProfile::IsContextActive (� �)� const [virtual]

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

TBool CSIPProfile::IsEnabled

(�

�)�

const