CWSAccount Class Reference

#include <ext/mw/wsaccount.h>

Link against: wsaccountmanager.lib

class CWSAccount : public CSenFragmentBase, public CSenFragmentBase

Inherits from

  • CWSAccount
    Public Member Functions
    pure virtual const CWSAccMgrPluginInfo *AccMgrPluginInfo()
    pure virtual TInt AccountErrorCode()
    pure virtual HBufC8 *AccountItemL(const TDesC8 &)
    pure virtual const RArray< RBuf8 > &AvailableUsernames()
    pure virtual TBool CERememberMe()
    pure virtual voidCERememberMe(TBool)
    pure virtual HBufC8 *EmailContactMethod()
    pure virtual const TDesC8 &Endpoint()
    pure virtual const TDesC8 &FrameworkId()
    pure virtual CSenIdentityProvider &IdentityProviderL()
    pure virtual TBool IsAutomaticSignInEnabledL()
    pure virtual TBool IsCEAccount()
    pure virtual HBufC8 *MobileContactMethod()
    IMPORT_C CWSAccount *NewL()
    IMPORT_C CWSAccount *NewL(const CSenIdentityProvider &)
    IMPORT_C CWSAccount *NewLC()
    IMPORT_C CWSAccount *NewLC(const CSenIdentityProvider &)
    pure virtual TBool OtherDESignedOut()
    pure virtual const TDesC8 &Password()
    pure virtual CCrossEnablerClientUtils *QTDEObserver()
    pure virtual TBool RemoveCEAccount()
    pure virtual const RArray< RBuf8 > &SecurityQuestions()
    pure virtual const RArray< RBuf8 > &SecurityQuestionsIds()
    pure virtual voidSetAccMgrPluginInfo(CWSAccMgrPluginInfo *)
    pure virtual voidSetAccountErrorCode(TInt)
    pure virtual voidSetAccountItemL(const TDesC8 &, const TDesC8 &)
    pure virtual voidSetAvailableUsernames(const RArray< RBuf8 > &)
    pure virtual voidSetDESignedOut(TBool)
    pure virtual voidSetEmailContactMethod(const TDesC8 &)
    pure virtual voidSetEndpointL(const TDesC8 &)
    pure virtual voidSetFrameworkIdL(const TDesC8 &)
    pure virtual voidSetIsCEAccount(TBool)
    pure virtual voidSetMobileContactMethod(const TDesC8 &)
    pure virtual voidSetPasswordL(const TDesC8 &)
    pure virtual voidSetQTDEObserver(CCrossEnablerClientUtils *)
    pure virtual voidSetRemoveCEAccount(TBool)
    pure virtual voidSetSecurityQuestions(const RArray< RBuf8 > &, const RArray< RBuf8 > &)
    pure virtual voidSetUserIdL(const TDesC8 &)
    pure virtual voidSetValidatorL(const TDesC8 &)
    pure virtual const TDesC8 &UserId()
    pure virtual const TDesC8 &ValidatorL()
    Protected Member Functions
    CWSAccount()
    Inherited Attributes
    CSenFragmentBase::iDocument
    CSenFragmentBase::iElement
    CSenFragmentBase::iState
    CSenFragmentBase::ipContentBuf
    CSenFragmentBase::ipContentWriteStream
    CSenFragmentBase::ipDelegate
    CSenFragmentBase::ipNamespaceArray
    CSenFragmentBase::ipOwner
    CSenFragmentBase::ipParser
    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()
    CSenFragmentBase::AddAttributesL(const RAttributeArray &)
    CSenFragmentBase::AddAttributesToElementL(TXmlEngElement,const RAttributeArray &)
    CSenFragmentBase::AddContentL(const TDesC8 &)
    CSenFragmentBase::AddNamespacesL()
    CSenFragmentBase::AsDocumentL()
    CSenFragmentBase::AsElementL()
    CSenFragmentBase::AsXmlL()
    CSenFragmentBase::AsXmlUnicodeL()
    CSenFragmentBase::BaseConstructL(TXmlEngElement &,RSenDocument &)
    CSenFragmentBase::BaseConstructL(const TDesC8 &)
    CSenFragmentBase::BaseConstructL(const TDesC8 &,const TDesC8 &)
    CSenFragmentBase::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &)
    CSenFragmentBase::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
    CSenFragmentBase::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,TXmlEngElement &)
    CSenFragmentBase::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,TXmlEngElement &,RSenDocument &)
    CSenFragmentBase::BaseConstructL(const TXmlEngElement &)
    CSenFragmentBase::CSenFragmentBase()
    CSenFragmentBase::ConsistsOfL(CSenFragmentBase &)
    CSenFragmentBase::ConsistsOfL(TXmlEngElement &,TXmlEngElement &)
    CSenFragmentBase::ContentL()
    CSenFragmentBase::ContentOf(const TDesC8 &)
    CSenFragmentBase::ExtractElement()
    CSenFragmentBase::GetExtendedInterface(const TInt32)
    CSenFragmentBase::LocalName()const
    CSenFragmentBase::Namespace(const TDesC8 &)
    CSenFragmentBase::NewL(TXmlEngElement &,RSenDocument &)
    CSenFragmentBase::NewL(const TDesC8 &)
    CSenFragmentBase::NewL(const TDesC8 &,const TDesC8 &)
    CSenFragmentBase::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &)
    CSenFragmentBase::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
    CSenFragmentBase::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,TXmlEngElement &)
    CSenFragmentBase::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,TXmlEngElement &,RSenDocument &)
    CSenFragmentBase::NewL(const TXmlEngElement &)
    CSenFragmentBase::NsPrefix()const
    CSenFragmentBase::NsUri()const
    CSenFragmentBase::OnContentL(const TDesC8 &,TInt)
    CSenFragmentBase::OnDelegateParsingL(CSenFragmentBase &)
    CSenFragmentBase::OnDelegateParsingL(const RTagInfo &,const RAttributeArray &,TInt)
    CSenFragmentBase::OnEndDocumentL(TInt)
    CSenFragmentBase::OnEndElementL(const RTagInfo &,TInt)
    CSenFragmentBase::OnEndPrefixMappingL(const RString &,TInt)
    CSenFragmentBase::OnError(TInt)
    CSenFragmentBase::OnIgnorableWhiteSpaceL(const TDesC8 &,TInt)
    CSenFragmentBase::OnProcessingInstructionL(const TDesC8 &,const TDesC8 &,TInt)
    CSenFragmentBase::OnResumeParsingFromL(const RTagInfo &,TInt)
    CSenFragmentBase::OnSkippedEntityL(const RString &,TInt)
    CSenFragmentBase::OnStartDocumentL(const RDocumentParameters &,TInt)
    CSenFragmentBase::OnStartElementL(const RTagInfo &,const RAttributeArray &,TInt)
    CSenFragmentBase::OnStartPrefixMappingL(const RString &,const RString &,TInt)
    CSenFragmentBase::OnWriteEndElementL(const RTagInfo &)
    CSenFragmentBase::OnWriteStartElementL(const RTagInfo &,const RAttributeArray &)
    CSenFragmentBase::RenameL(const TDesC8 &,const TDesC8 &)
    CSenFragmentBase::RenameL(const TDesC8 &,const TDesC8 &,const TDesC8 &)
    CSenFragmentBase::RenameLocalNameL(const TDesC8 &)
    CSenFragmentBase::RenameNamespaceL(const TDesC8 &)
    CSenFragmentBase::RenameNamespaceL(const TDesC8 &,const TDesC8 &)
    CSenFragmentBase::RenamePrefixL(const TDesC8 &)
    CSenFragmentBase::ResetContentL()
    CSenFragmentBase::SetContentHandler(CSenFragmentBase &)
    CSenFragmentBase::SetContentL(const TDesC8 &)
    CSenFragmentBase::SetContentOfL(const TDesC8 &,const TDesC8 &)
    CSenFragmentBase::SetDocument(RSenDocument &)
    CSenFragmentBase::SetOwner(CSenFragmentBase &)
    CSenFragmentBase::StartSavingContent()
    CSenFragmentBase::WriteAsXMLToL(RWriteStream &)
    CSenFragmentBase::~CSenFragmentBase()

    Detailed Description

    Represents account from backend (server side) and aggregates its information. Specialized collection which holds account specific values.

    Since
    Series60 5.0

    Constructor & Destructor Documentation

    CWSAccount ( )

    CWSAccount()[protected]

    Member Function Documentation

    AccMgrPluginInfo ( )

    const CWSAccMgrPluginInfo *AccMgrPluginInfo()const [pure virtual]
    Provides information about plugin which is used to manage account. Plugin determines UI and protocol for account management.
    Since
    Series60 5.0
    Return Value
    information about account manager plugin

    AccountErrorCode ( )

    TInt AccountErrorCode()[pure virtual]

    AccountItemL ( const TDesC8 & )

    HBufC8 *AccountItemL(const TDesC8 &aItemName)[pure virtual]
    Getter for any generic value used by account
    Since
    Series60 5.0
    Parameters
    aItemName- key to get value
    Return Value
    value represented by provided key

    AvailableUsernames ( )

    const RArray< RBuf8 > &AvailableUsernames()const [pure virtual]
    Convenient method to provide available usernames when SignUp process fails because of fact that username is already in use.
    Since
    Series60 5.0
    Return Value
    array of propositions for username

    CERememberMe ( )

    TBool CERememberMe()const [pure virtual]
    Method to get remember me Flag of Cross Enabler account
    Since
    Series60 5.0

    CERememberMe ( TBool )

    voidCERememberMe(TBoolaFlag)[pure virtual]
    Method to set remember me Flag from Cross Enabler account
    Since
    Series60 5.0

    EmailContactMethod ( )

    HBufC8 *EmailContactMethod()[pure virtual]
    Method to provide email contact method retrieved from the server Returns new HBufC8 with preffered email or NULL if email is absent in a profile. Creates new HBufC8.
    Since
    Series60 5.0
    Return Value
    email, ownership transferred to caller

    Endpoint ( )

    const TDesC8 &Endpoint()const [pure virtual]
    Endpoint of authentication service used during performing the SignIn process
    Since
    Series60 5.0
    Return Value
    endpoint of authentication service

    FrameworkId ( )

    const TDesC8 &FrameworkId()const [pure virtual]
    Framework Id which determines a certain service invocation framework.
    Since
    Series60 5.0
    Return Value
    framework Id

    IdentityProviderL ( )

    CSenIdentityProvider &IdentityProviderL()[pure virtual]
    Factory method to produce properly identity provider used by web service framework
    Since
    Series60 5.0
    Return Value
    Identity Provider representing current account

    IsAutomaticSignInEnabledL ( )

    TBool IsAutomaticSignInEnabledL()[pure virtual]

    Checks, if the automatic sign in flag has been enabled

    IsCEAccount ( )

    TBool IsCEAccount()const [pure virtual]
    Method to get Cross Enabler Account Flag
    Since
    Series60 5.0
    Return Value
    Cenrep Account Flag

    MobileContactMethod ( )

    HBufC8 *MobileContactMethod()[pure virtual]
    Method to provide mobile contact method retrieved from the server Returns new HBufC8 with preffered number or NULL if number is absent in a profile.
    Since
    Series60 5.0
    Return Value
    mobile phone number, ownership transferred to caller.

    NewL ( )

    IMPORT_C CWSAccount *NewL()[static]
    Creates an object representing an empty account.
    Since
    Series60 5.0
    Return Value
    a pointer to CWSAccount class instance.

    NewL ( const CSenIdentityProvider & )

    IMPORT_C CWSAccount *NewL(const CSenIdentityProvider &aIdentityProvider)[static]

    Creates an object representing an account. Variant of Factory method which adapts identityProvider information from web service framework

    See also: CSenIdentityProvider

    Since
    Series60 5.0
    Parameters
    aIdentityProvider- identity provider representing the account
    Return Value
    a pointer to CWSAccount class instance.

    NewLC ( )

    IMPORT_C CWSAccount *NewLC()[static]
    Creates an object representing an empty account.
    Since
    Series60 5.0
    Return Value
    a pointer to CWSAccount class instance.

    NewLC ( const CSenIdentityProvider & )

    IMPORT_C CWSAccount *NewLC(const CSenIdentityProvider &aIdentityProvider)[static]

    Creates an object representing an account. Variant of Factory method which adapts identityProvider information from web service framework

    See also: CSenIdentityProvider

    Since
    Series60 5.0
    Parameters
    aIdentityProvider- identity provider representing the account
    Return Value
    a pointer to CWSAccount class instance.

    OtherDESignedOut ( )

    TBool OtherDESignedOut()const [pure virtual]
    Method to check remove Cross Enabler Account Flag
    Since
    Series60 5.0

    Password ( )

    const TDesC8 &Password()const [pure virtual]
    Password of account
    Since
    Series60 5.0
    Return Value
    password of account

    QTDEObserver ( )

    CCrossEnablerClientUtils *QTDEObserver()const [pure virtual]
    Get QTDEObserverUtils information
    Since
    Series60 5.0
    Return Value
    aQTDEObserver - QTDEUtils object

    RemoveCEAccount ( )

    TBool RemoveCEAccount()const [pure virtual]
    Method to check remove Cross Enabler Account Flag
    Since
    Series60 5.0

    SecurityQuestions ( )

    const RArray< RBuf8 > &SecurityQuestions()const [pure virtual]
    Convenient method to provide security questions retrieved from the server
    Since
    Series60 5.0
    Return Value
    array of security questions

    SecurityQuestionsIds ( )

    const RArray< RBuf8 > &SecurityQuestionsIds()const [pure virtual]
    Convenient method to provide security questions ids retrieved from the server
    Since
    Series60 5.0
    Return Value
    array of security questions

    SetAccMgrPluginInfo ( CWSAccMgrPluginInfo * )

    voidSetAccMgrPluginInfo(CWSAccMgrPluginInfo *aPluginInfo)[pure virtual]
    Set plugin information which determines account manager plugin
    Since
    Series60 5.0
    Parameters
    aPluginInfo- account manager plugin information. Ownership is transferred

    SetAccountErrorCode ( TInt )

    voidSetAccountErrorCode(TIntaErrorCode)[pure virtual]

    SetAccountItemL ( const TDesC8 &, const TDesC8 & )

    voidSetAccountItemL(const TDesC8 &aItemName,
    const TDesC8 &aItemValue
    )[pure virtual]
    Setter for any generic value used by account
    Since
    Series60 5.0
    Parameters
    aItemName- key
    aItemValue- value

    SetAvailableUsernames ( const RArray< RBuf8 > & )

    voidSetAvailableUsernames(const RArray< RBuf8 > &aAvailableUsernames)[pure virtual]
    Convenient method to set available usernames when SignUp process fails because of fact that username is already in use.
    Since
    Series60 5.0
    Parameters
    aAvailableUsernames- array of propositions for usernames

    SetDESignedOut ( TBool )

    voidSetDESignedOut(TBoolaFlag)[pure virtual]
    Method to set if another application is signed out
    Since
    Series60 5.0

    SetEmailContactMethod ( const TDesC8 & )

    voidSetEmailContactMethod(const TDesC8 &aEmailContactMethod)[pure virtual]
    Method to set email contact methods retrieved from the server data appears after downloading account or sign up
    Since
    Series60 5.0

    SetEndpointL ( const TDesC8 & )

    voidSetEndpointL(const TDesC8 &aEndpoint)[pure virtual]
    Set endpoint of authentication service used during performing the SignIn process
    Since
    Series60 5.0
    Parameters
    aEndpoint- endpoint of authentication service

    SetFrameworkIdL ( const TDesC8 & )

    voidSetFrameworkIdL(const TDesC8 &aFrameworkId)[pure virtual]
    Set Framework Id which determines a certain service invocation framework.
    Since
    Series60 5.0
    Parameters
    aFrameworkId- framework Id

    SetIsCEAccount ( TBool )

    voidSetIsCEAccount(TBoolaFlag)[pure virtual]
    API AVAILABLE UNDER __CROSS_QT_ENABLED__ MACRO IS NOT FINALISED AND BELEIVED TO BE CHANGED APPLICATIONS MUST NOT USE THESE API Method to set Crossenabler Account Flag
    Since
    Series60 5.0

    SetMobileContactMethod ( const TDesC8 & )

    voidSetMobileContactMethod(const TDesC8 &aMobileContactMethod)[pure virtual]
    Method to set mobile contact methods retrieved from the server data appears after downloading account or sign up
    Since
    Series60 5.0

    SetPasswordL ( const TDesC8 & )

    voidSetPasswordL(const TDesC8 &aPassword)[pure virtual]
    Set password for account
    Since
    Series60 5.0
    Parameters
    aPassword- password of account

    SetQTDEObserver ( CCrossEnablerClientUtils * )

    voidSetQTDEObserver(CCrossEnablerClientUtils *aQTDEObserver)[pure virtual]
    Set QTDEObserverUtils information
    Since
    Series60 5.0
    Parameters
    aQTDEObserver- QTDEUtils object

    SetRemoveCEAccount ( TBool )

    voidSetRemoveCEAccount(TBoolaFlag)[pure virtual]
    Method to set remove Cross Enabler Account Flag
    Since
    Series60 5.0

    SetSecurityQuestions ( const RArray< RBuf8 > &, const RArray< RBuf8 > & )

    voidSetSecurityQuestions(const RArray< RBuf8 > &aSecurityQuestions,
    const RArray< RBuf8 > &aSecurityQuestionsIds
    )[pure virtual]
    Convenient method to set security questions and their ids retrieved from the server
    Since
    Series60 5.0

    SetUserIdL ( const TDesC8 & )

    voidSetUserIdL(const TDesC8 &aAccountName)[pure virtual]
    Set Unique Id representing account
    Since
    Series60 5.0
    Parameters
    aAccountName- unique id for account

    SetValidatorL ( const TDesC8 & )

    voidSetValidatorL(const TDesC8 &aValidator)[pure virtual]
    Method to set Validator
    Since
    Series60 5.0

    UserId ( )

    const TDesC8 &UserId()const [pure virtual]
    Unique Id representing account
    Since
    Series60 5.0
    Return Value
    Unique account Id

    ValidatorL ( )

    const TDesC8 &ValidatorL()[pure virtual]
    Method to get Validator
    Since
    Series60 5.0
    Return Value
    Validator of account
    © Nokia 2005.