Symbian^3 Application Developer Library >

CSIPProfileITC Class Reference

class CSIPProfileITC : public CBase

The class provides simplified ITC access for client

sipprofilecli.lib

Inherits from

Public Member Functions
~CSIPProfileITC ()
void AddALRObserverL ()
void AddSIPProfileL ( CSIPConcreteProfile &)
void AllowMigrationL ( TUint32 , TUint32 )
void DeleteSIPProfileL ( TUint32 )
TInt DisableSIPProfileL ( TUint32 )
void DisallowMigrationL ( TUint32 , TUint32 )
TInt EnableSIPProfileL ( TUint32 )
TInt ForceDisableSIPProfileL ( TUint32 )
void NegotiatedSecurityMechanismL ( CSIPConcreteProfile &)
CSIPProfileITC * NewL ( RSIPProfile &)
CSIPProfileITC * NewLC ( RSIPProfile &)
void RefreshIapAvailabilityL ( TUint32 )
void RegisteredAORsL ( CSIPConcreteProfile &)
void RemoveALRObserver ()
void RemoveSIPProfileL ( TUint32 )
CSIPConcreteProfile * SIPCreateProfileL (const TSIPProfileTypeInfo &)
TUint SIPProfileDefaultIdL ()
void SIPProfileDefaultL ( TUint &, TUint32 &)
CSIPConcreteProfile * SIPProfileL ( TUint32 , TUint )
CSIPProfilePlugins * SIPProfilePluginsL ()
CSIPConcreteProfile * SIPProfileRefreshL ( TUint32 , TUint )
TInt SIPProfileUsageL ( TUint32 )
CSIPConcreteProfileHolder * SIPProfilesByAORL (const TDesC8 &)
CSIPConcreteProfileHolder * SIPProfilesByTypeL (const TSIPProfileTypeInfo &)
CSIPConcreteProfileHolder * SIPProfilesL ()
void UpdateSIPProfileL ( CSIPConcreteProfile &)
Private Member Functions
CSIPProfileITC ( RSIPProfile &)
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()
Private Attributes
HBufC8 * iEmptyContent
CSIPProfileITCHelper iHelper
TIpcArgs iITCMsgArgs

Constructor & Destructor Documentation

CSIPProfileITC(RSIPProfile &)

CSIPProfileITC ( RSIPProfile & aSip ) [private]

Constructor

Parameters

RSIPProfile & aSip a client providing connection to SIP profile server.

~CSIPProfileITC()

~CSIPProfileITC ( )

Destructor.

Member Functions Documentation

AddALRObserverL()

void AddALRObserverL ( )

Informs the server side that ALR controller has been created.

AddSIPProfileL(CSIPConcreteProfile &)

void AddSIPProfileL ( CSIPConcreteProfile & aProfile )
Add profile into persistent storage of profile server.
Pre-condition
aProfile.Id() = 0
Post-condition
aProfile.Id() > 0

Parameters

CSIPConcreteProfile & aProfile profile to be added

AllowMigrationL(TUint32, TUint32)

void AllowMigrationL ( TUint32 aProfileId,
TUint32 aIapId
)

Allows SIP Profile Agent to start the migration from the old IAP to the new one.

Parameters

TUint32 aProfileId the SIP profile id
TUint32 aIapId the new IAP id.

ConstructL()

void ConstructL ( ) [private]

Symbian 2nd phase constructor

DeleteSIPProfileL(TUint32)

void DeleteSIPProfileL ( TUint32 aProfileId )

Inform profile server that local instance of profile is deleted

Parameters

TUint32 aProfileId id of retrieved profile

DisableSIPProfileL(TUint32)

TInt DisableSIPProfileL ( TUint32 aProfileId )

Disable the profile after being used

Parameters

TUint32 aProfileId id of retrieved profile

DisallowMigrationL(TUint32, TUint32)

void DisallowMigrationL ( TUint32 aProfileId,
TUint32 aIapId
)

Disallows SIP Profile Agent to start the migration from the old IAP to the new one.

Parameters

TUint32 aProfileId the SIP profile id
TUint32 aIapId the new IAP id.

EnableSIPProfileL(TUint32)

TInt EnableSIPProfileL ( TUint32 aProfileId )

Enable the profile for use

Parameters

TUint32 aProfileId id of retrieved profile

ForceDisableSIPProfileL(TUint32)

TInt ForceDisableSIPProfileL ( TUint32 aProfileId )

Force disable the profile after being used

Parameters

TUint32 aProfileId id of retrieved profile

NegotiatedSecurityMechanismL(CSIPConcreteProfile &)

void NegotiatedSecurityMechanismL ( CSIPConcreteProfile & aProfile )

Updates SIP profile value for negotiated security mechanism; leaves on failure

Parameters

CSIPConcreteProfile & aProfile a SIP profile

NewL(RSIPProfile &)

CSIPProfileITC * NewL ( RSIPProfile & aSipProfile ) [static]

Two-phased constructor.

Parameters

RSIPProfile & aSipProfile a client providing connection to SIP profile server.

NewLC(RSIPProfile &)

CSIPProfileITC * NewLC ( RSIPProfile & aSipProfile ) [static]

Two-phased constructor.

Parameters

RSIPProfile & aSipProfile a client providing connection to SIP profile server.

RefreshIapAvailabilityL(TUint32)

void RefreshIapAvailabilityL ( TUint32 aProfileId )

Refreshes the list of available IAPs for a profile.

Parameters

TUint32 aProfileId

RegisteredAORsL(CSIPConcreteProfile &)

void RegisteredAORsL ( CSIPConcreteProfile & aProfile )

Updates SIP profile value for registered AORs; leaves on failure

Parameters

CSIPConcreteProfile & aProfile a SIP profile

RemoveALRObserver()

void RemoveALRObserver ( )

Informs the server side that ALR controller has been destroyed.

RemoveSIPProfileL(TUint32)

void RemoveSIPProfileL ( TUint32 aProfileId )

Remove profile from persistent storage of profile server.

Parameters

TUint32 aProfileId id of the profile to be removed

SIPCreateProfileL(const TSIPProfileTypeInfo &)

CSIPConcreteProfile * SIPCreateProfileL ( const TSIPProfileTypeInfo & aType )

Retrieve new empty profile of given type with default values. Profile is not stored into server.

Parameters

const TSIPProfileTypeInfo & aType type of retrived profiles

SIPProfileDefaultIdL()

TUint SIPProfileDefaultIdL ( )

Retrieve id of default profile from profile server

SIPProfileDefaultL(TUint &, TUint32 &)

void SIPProfileDefaultL ( TUint & aSize,
TUint32 & aProfileId
)

Retrieve id and size of default profile from profile server

Parameters

TUint & aSize returned size of default profile
TUint32 & aProfileId returned id of default profile

SIPProfileL(TUint32, TUint)

CSIPConcreteProfile * SIPProfileL ( TUint32 aProfileId,
TUint aSize = 0
)

Retrieve single SIP profile from profile server

Parameters

TUint32 aProfileId id of retrieved profile
TUint aSize = 0 returned size of retrieved profile

SIPProfilePluginsL()

CSIPProfilePlugins * SIPProfilePluginsL ( )

Retrieve profile plugins from profile server.

SIPProfileRefreshL(TUint32, TUint)

CSIPConcreteProfile * SIPProfileRefreshL ( TUint32 aProfileId,
TUint aSize = 0
)

Refresh already previously retrieved SIP profile from profile server

Parameters

TUint32 aProfileId id of retrieved profile
TUint aSize = 0 returned size of retrieved profile

SIPProfileUsageL(TUint32)

TInt SIPProfileUsageL ( TUint32 aProfileId )

Retrieve number of users of a profile

Parameters

TUint32 aProfileId id of retrieved profile

SIPProfilesByAORL(const TDesC8 &)

CSIPConcreteProfileHolder * SIPProfilesByAORL ( const TDesC8 & aAOR )

Retrieve multiple SIP profiles based on AOR from profile server

Parameters

const TDesC8 & aAOR AOR of retrived profiles

SIPProfilesByTypeL(const TSIPProfileTypeInfo &)

CSIPConcreteProfileHolder * SIPProfilesByTypeL ( const TSIPProfileTypeInfo & aType )

Retrieve multiple SIP profiles based on type from profile server

Parameters

const TSIPProfileTypeInfo & aType type of retrived profiles

SIPProfilesL()

CSIPConcreteProfileHolder * SIPProfilesL ( )

Retrieve all SIP profiles from profile server

UpdateSIPProfileL(CSIPConcreteProfile &)

void UpdateSIPProfileL ( CSIPConcreteProfile & aProfile )
Update profile into persistent storage of profile server.
Pre-condition
aProfile.Id() > 0

Parameters

CSIPConcreteProfile & aProfile profile to be added

Member Data Documentation

HBufC8 * iEmptyContent

HBufC8 * iEmptyContent [private]

CSIPProfileITCHelper iHelper

CSIPProfileITCHelper iHelper [private]

TIpcArgs iITCMsgArgs

TIpcArgs iITCMsgArgs [private]

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.