S60 3rd Edition API Reference: CSIPProfileRegistry Class Reference

CSIPProfileRegistry Class Reference

API published in: S60 2nd Ed

Link against: sipprofilecli.lib

Capability Information

Required Capabilities

Location NetworkControl NetworkServices ReadDeviceData ReadUserData WriteDeviceData

#include <sipprofileregistry.h>

Inherits CSIPProfileRegistryBase.

Detailed Description

PublishedAll
Released
The class for retrieving SIP profiles from permanent storage. This class provides services for retreiving SIP profiles and enabling/disabling them for the usage.

The user can create only one instance of this class (a singleton class).


Public Member Functions

IMPORT_C ~CSIPProfileRegistry ()
 Destructor.
IMPORT_C CSIP & SIP () const
 Gets handle to the SIP server.
IMPORT_C CSIPConnection * ConnectionL (CSIPProfile &aProfile)
 Gets the SIP connection to be used with this SIP profile.
IMPORT_C void EnableL (CSIPProfile &aProfile, MSIPConnectionObserver &aObserver)
 Enables the SIP profile for use.
IMPORT_C TInt Disable (CSIPProfile &aProfile)
 Disables the usage of SIP profile.
IMPORT_C TBool IsEnabled (const CSIPProfile &aProfile) const
 Tests is the SIP profile enabled for the use.
CSIPProfile * NewInstanceL ()
 Gets new instance of either type CSIPProfile or CSIPManagedProfile.

Static Public Member Functions

static IMPORT_C CSIPProfileRegistry * NewL (CSIP &aSip, MSIPProfileRegistryObserver &aObserver)
 Two-phased constructor.
static IMPORT_C CSIPProfileRegistry * NewLC (CSIP &aSip, MSIPProfileRegistryObserver &aObserver)
 Two-phased constructor.

Constructor & Destructor Documentation

IMPORT_C CSIPProfileRegistry::~CSIPProfileRegistry (   ) 
 

Destructor.

Member Function Documentation

IMPORT_C CSIPConnection* CSIPProfileRegistry::ConnectionL ( CSIPProfile &  aProfile  ) 
 

Gets the SIP connection to be used with this SIP profile.

Precondition:
IsEnabled() == ETrue
Parameters:
aProfile a sip profile
Returns:
a SIP connection to be used; the owneship is transfered
Leave:
KErrNoMemory if out of memory NetworkServices
IMPORT_C TInt CSIPProfileRegistry::Disable ( CSIPProfile &  aProfile  ) 
 

Disables the usage of SIP profile.

Parameters:
aProfile a sip profile to disable
Returns:
KErrNone if SIP profile was successfully disabled; system wide error otherwise NetworkServices
IMPORT_C void CSIPProfileRegistry::EnableL ( CSIPProfile &  aProfile,
MSIPConnectionObserver &  aObserver
) 
 

Enables the SIP profile for use.

Enabling the SIP profile will cause the SIP profile to be registered if its status was unregistered. The user must check the profile status after calling this function. In case the profile is not registered the user must wait until the it is notified about profile registration on MSIPProfileRegistryObserver-callback interface.

Parameters:
aProfile a sip profile to enable
aObserver a observer for SIP connection events
Leave:
KErrNotFound if non-existing profile is provided NetworkServices
IMPORT_C TBool CSIPProfileRegistry::IsEnabled ( const CSIPProfile &  aProfile  )  const
 

Tests is the SIP profile enabled for the use.

Parameters:
aProfile a SIP profile to be checked
Returns:
ETrue if SIP profile is enabled; EFalse otherwise
CSIPProfile* CSIPProfileRegistry::NewInstanceL (   )  [virtual]
 

Gets new instance of either type CSIPProfile or CSIPManagedProfile.

Returns:
new instance

Implements CSIPProfileRegistryBase.

static IMPORT_C CSIPProfileRegistry* CSIPProfileRegistry::NewL ( CSIP &  aSip,
MSIPProfileRegistryObserver &  aObserver
)  [static]
 

Two-phased constructor.

This constructor should be used if the client intends to use SIP services with profiles.

Parameters:
aSip a SIP client providing connection to SIP stack.
aObserver a observer for SIP profile change events.
static IMPORT_C CSIPProfileRegistry* CSIPProfileRegistry::NewLC ( CSIP &  aSip,
MSIPProfileRegistryObserver &  aObserver
)  [static]
 

Two-phased constructor.

This constructor should be used if the client intends to use SIP services with profiles. Constructs an object and adds the pointer to the cleanup stack;

Parameters:
aSip a SIP client providing connection to SIP stack.
aObserver a observer for SIP profile change events.
IMPORT_C CSIP& CSIPProfileRegistry::SIP (   )  const
 

Gets handle to the SIP server.

Returns:
handle to the SIP server
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top