MWSAccMgrMepPlugin Class Reference

#include <ext/mw/mwsaccmgrmepplugin.h>

class MWSAccMgrMepPlugin
Public Member Functions
pure virtual TInt AutoDetectUserL(TRequestStatus &, CWSAccount &)
pure virtual TInt CancelMepAsync()
pure virtual TInt ChangePasswordL(TRequestStatus &, CWSAccount &)
pure virtual TInt CheckUsernameAvailabilityL(TRequestStatus &, CWSAccount &)
pure virtual TInt CloseConnection()
pure virtual TInt CreateCaptchaL(TRequestStatus &, CWSAccount &)
pure virtual TInt DeleteTokenL(TRequestStatus &, CWSAccount &, CWSToken &)
pure virtual TInt FullAccountProfileL(TRequestStatus &, CWSAccount &)
pure virtual TInt GetSmcSubscriptionStatusL(TRequestStatus &, CWSAccount &)
pure virtual TInt Init(const CSenTransportProperties &)
pure virtual TInt MarketingConsentRequestL(TRequestStatus &, CWSAccount &, TBool)
pure virtual TInt OviEmailConfigRequestL(TRequestStatus &, CWSAccount &)
pure virtual TInt ResetPasswordL(TRequestStatus &, CWSAccount &)
pure virtual TInt RetrieveContactMethodsL(TRequestStatus &, CWSAccount &)
pure virtual TInt RetrievePasswordQuestionL(TRequestStatus &, CWSAccount &)
pure virtual TInt RetrieveSecurityQuestionsL(TRequestStatus &, CWSAccount &)
pure virtual TInt RetrieveTOSL(TRequestStatus &)
pure virtual TInt RetrieveYahooTermsLinksL(TRequestStatus &)
pure virtual TInt SignUpAccountL(TRequestStatus &, CWSAccount &)
pure virtual TInt SmcQueryVariantRequestL(TRequestStatus &, CWSAccount &)
pure virtual TInt StartFetchClockServerTimeL(TRequestStatus &)
pure virtual TInt StartFetchNokiaPrivacyPolicyContentL(TRequestStatus &, CWSAccount &)
pure virtual TInt StartFetchNokiaTermsAcceptanceInformationL(TRequestStatus &, CWSAccount &)
pure virtual TInt StartFetchNokiaToSContentL(TRequestStatus &, CWSAccount &)
pure virtual TInt StartFetchYahooPrivacyPolicyContentL(TRequestStatus &, CWSAccount &)
pure virtual TInt StartFetchYahooToSContentL(TRequestStatus &, CWSAccount &)
pure virtual TInt StartUpdateTermsAcceptanceInformationL(TRequestStatus &, CWSAccount &)
pure virtual TInt UpdateAccountProfileL(TRequestStatus &, CWSAccount &)
pure virtual TInt UpdateDeviceInfoL(TRequestStatus &, CWSAccount &)

Member Function Documentation

AutoDetectUserL ( TRequestStatus &, CWSAccount & )

TInt AutoDetectUserL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

Fetch PhoneActivation Details from backend and store it within aAccount object ========================================================================= |key | value | ========================================================================= |KWSAccAttrAccountMobile | User Mobile Number |

-------------------------------------------------------------------------

------------------------------------------------------------------------- | This box values are present only in case of an error |KWSAccAttrErrorCode | Keeps the number of error code | | | |KWSAccAttrErrorName | Indicates a place where error occured| | | |KWSAccAttrErrorMessage | Error details if available | -------------------------------------------------------------------------

========================================================================= |key | value | ========================================================================= |KWSAccAttrAccountMobile | User Mobile Number |

-------------------------------------------------------------------------

------------------------------------------------------------------------- | This box values are present only in case of an error |KWSAccAttrErrorCode | Keeps the number of error code | | | |KWSAccAttrErrorName | Indicates a place where error occured| | | |KWSAccAttrErrorMessage | Error details if available | -------------------------------------------------------------------------

Parameters
aStatus- Used by Plugin to indicate completion of the send request. aStatus as return values: KErrNone - successfully fetched CAPCTHA, and stored within aAccount Transport errors - like HTTP errors (4xx, 5xx) KErrCancel - request has been cancelled
aAccount- out parameter, below available values under account keys
Return Value
KErrNone or some system-wide Symbian error code. Detect whether it is a returning user or a new user. KErrNone or some system-wide Symbian error code.

CancelMepAsync ( )

TInt CancelMepAsync()[pure virtual]

Cancels an outstanding asynchronous request. The result of the cancellation request will be reflected through the request status of the pending request. A status of KErrCancel denotes that the request has been safely cancelled.

Return Value
KErrNone or some system-wide Symbian error code.

ChangePasswordL ( TRequestStatus &, CWSAccount & )

TInt ChangePasswordL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

CheckUsernameAvailabilityL ( TRequestStatus &, CWSAccount & )

TInt CheckUsernameAvailabilityL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

PreRegister new account within backend. Before proper SignUp process, account name availability can be checked In values ========================================================================= |key | values | ========================================================================= |aAccount.UserId() | Account name (user id) | ------------------------------------------------------------------------- |AvailableUsernames | Keeps list of free Account-names, | | | If SignUp fails ------------------------------------------------------------------------- | This box values are present only in case of an error |KWSAccAttrErrorCode | Keeps the number of error code | | | |KWSAccAttrErrorName | Indicates a place where error occured| | | |KWSAccAttrErrorMessage | Error details if available | -------------------------------------------------------------------------

Parameters
aStatus- Used by Plugin to indicate completion of the send request. aStatus return values: KErrNone - userName free, can be used for SignUp Transport error - like HTTP errors (4xx, 5xx) KErrCancel - request has been cancelled KSenConnectionStatusExpired - connection to backend can not be established (for example: token invalid)
aAccount- in parameter, below available values under account keys
Return Value
KErrNone or some system-wide Symbian error code.

CloseConnection ( )

TInt CloseConnection()[pure virtual]

Close IAP connections maintained by Plugin. It guarantee no connection activity after calling.

Return Value
KErrNone or some system-wide Symbian error code.

CreateCaptchaL ( TRequestStatus &, CWSAccount & )

TInt CreateCaptchaL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

Fetch CAPTCHA image from backend and store it within aAccount object ========================================================================= |key | value | ========================================================================= |KWSAccAttrAccountCaptchaId | Identifier of Captcha, | | | will be used during SignUp | ------------------------------------------------------------------------- |KWSAccAttrAccountCaptcha | Holds CAPTCHA, usually as Base64 | ------------------------------------------------------------------------- | This box values are present only in case of an error |KWSAccAttrErrorCode | Keeps the number of error code | | | |KWSAccAttrErrorName | Indicates a place where error occured| | | |KWSAccAttrErrorMessage | Error details if available | -------------------------------------------------------------------------

Parameters
aStatus- Used by Plugin to indicate completion of the send request. aStatus as return values: KErrNone - successfully fetched CAPCTHA, and stored within aAccount Transport errors - like HTTP errors (4xx, 5xx) KErrCancel - request has been cancelled
aAccount- out parameter, below available values under account keys
Return Value
KErrNone or some system-wide Symbian error code.

DeleteTokenL ( TRequestStatus &, CWSAccount &, CWSToken & )

TInt DeleteTokenL(TRequestStatus &aStatus,
CWSAccount &aAccount,
CWSToken &aToken
)[pure virtual]

FullAccountProfileL ( TRequestStatus &, CWSAccount & )

TInt FullAccountProfileL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

Dynamic fetching account profile data In values ========================================================================= |key | values | ========================================================================= Out values ========================================================================= |key | values | ========================================================================= |KWSAccAttrAccountAccountId | Account id | ========================================================================= |KWSAccAttrAccountSecretQuest | Id of security question | ------------------------------------------------------------------------- |KWSAccAttrAccountMobile | Account's owner mobile phone number| ------------------------------------------------------------------------- |KWSAccAttrAccountEmail | Account's owner email address | ------------------------------------------------------------------------- |KWSAccAttrAccountMobileVerified | Mobile verification flag | ------------------------------------------------------------------------- |KWSAccAttrAccountEmailVerified | Email verification flag | ------------------------------------------------------------------------- |KWSAccAttrAccountLanguage | Preffered Language | ------------------------------------------------------------------------- |KWSAccAttrAccountCountry | Account's owner country | ------------------------------------------------------------------------- |KWSAccAttrAccountDateOfBirth | Account's owner date of birth | ------------------------------------------------------------------------- |KWSAccAttrAccountFirstName | Account's owner first name | ------------------------------------------------------------------------- |KWSAccAttrAccountLastName | Account's owner last name | ------------------------------------------------------------------------- |KWSAccAttrAccountGender | Account's owner gender | ------------------------------------------------------------------------- | This box values are present only in case of an error |KWSAccAttrErrorCode | Keeps the number of error code | | | |KWSAccAttrErrorName | Indicates a place where error occured| | | |KWSAccAttrErrorMessage | Error details if available | -------------------------------------------------------------------------

Parameters
aStatus- Used by Plugin to indicate completion of the send request. aStatus return values: KErrNone - list of secret questions downloaded Transport error - like HTTP errors (4xx, 5xx) KErrCancel - request has been cancelled KSenConnectionStatusExpired - connection to backend can not be established (for example: token invalid)
aAccount- in/out parameter, below available values under account keys
Return Value
KErrNone or some system-wide Symbian error code.

GetSmcSubscriptionStatusL ( TRequestStatus &, CWSAccount & )

TInt GetSmcSubscriptionStatusL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

Init ( const CSenTransportProperties & )

TInt Init(const CSenTransportProperties &aTranspProperties)[pure virtual]

Set IAP (internet access point) used by Plugin.

Return Value
KErrNone or some system-wide Symbian error code.

MarketingConsentRequestL ( TRequestStatus &, CWSAccount &, TBool )

TInt MarketingConsentRequestL(TRequestStatus &aStatus,
CWSAccount &aAccount,
TBoolaAccountProfileSmc = EFalse
)[pure virtual]

OviEmailConfigRequestL ( TRequestStatus &, CWSAccount & )

TInt OviEmailConfigRequestL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

ResetPasswordL ( TRequestStatus &, CWSAccount & )

TInt ResetPasswordL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

RetrieveContactMethodsL ( TRequestStatus &, CWSAccount & )

TInt RetrieveContactMethodsL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

RetrievePasswordQuestionL ( TRequestStatus &, CWSAccount & )

TInt RetrievePasswordQuestionL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

RetrieveSecurityQuestionsL ( TRequestStatus &, CWSAccount & )

TInt RetrieveSecurityQuestionsL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

Dynamic fetching list of secret questions In values ========================================================================= |key | values | ========================================================================= |KWSAccAttrAccountLanguage | Preffered Language | ------------------------------------------------------------------------- Out values ========================================================================= |key | values | ========================================================================= |aAccount.SecurityQuestions() | Array of secret questions | ------------------------------------------------------------------------- | This box values are present only in case of an error |KWSAccAttrErrorCode | Keeps the number of error code | | | |KWSAccAttrErrorName | Indicates a place where error occured| | | |KWSAccAttrErrorMessage | Error details if available | -------------------------------------------------------------------------

Parameters
aStatus- Used by Plugin to indicate completion of the send request. aStatus return values: KErrNone - list of secret questions downloaded Transport error - like HTTP errors (4xx, 5xx) KErrCancel - request has been cancelled KSenConnectionStatusExpired - connection to backend can not be established (for example: token invalid)
aAccount- in/out parameter, below available values under account keys
Return Value
KErrNone or some system-wide Symbian error code.

RetrieveTOSL ( TRequestStatus & )

TInt RetrieveTOSL(TRequestStatus &aStatus)[pure virtual]

RetrieveYahooTermsLinksL ( TRequestStatus & )

TInt RetrieveYahooTermsLinksL(TRequestStatus &aStatus)[pure virtual]

SignUpAccountL ( TRequestStatus &, CWSAccount & )

TInt SignUpAccountL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

Register new account within backend In values ========================================================================= |key | value | ========================================================================= |aAccount.UserId() | Account name | ------------------------------------------------------------------------- |KWSAccAttrAccountCaptchaId | Identifier of Captcha, | ------------------------------------------------------------------------- |KWSAccAttrAccountCaptcha | Holds human text of CAPTCHA | ------------------------------------------------------------------------- |KWSAccAttrAccountMobile | Account's owner mobile phone number| ------------------------------------------------------------------------- |aAccount.Password() | Account password | ------------------------------------------------------------------------- |KWSAccAttrAccountSecretQuest | Id of security question | ------------------------------------------------------------------------- |KWSAccAttrAccountSecretAnswer | Answer for security question | ------------------------------------------------------------------------- Out values ========================================================================= |key | description | ========================================================================= |KWSAccAttrAccountAccountId | Account id , if SignUp succeed | ------------------------------------------------------------------------- |AvailableUsernames | Keeps list of free Account-names, | | | If SignUp fails ------------------------------------------------------------------------- | This box values are present only in case of an error |KWSAccAttrErrorCode | Keeps the number of error code | | | |KWSAccAttrErrorName | Indicates a place where error occured| | | |KWSAccAttrErrorMessage | Error details if available | -------------------------------------------------------------------------

Parameters
aStatus- Used by Plugin to indicate completion of the send request. aStatus return values: KErrNone - successfully SignUp Transport error - like HTTP errors (4xx, 5xx) KErrCancel - request has been cancelled
aAccount- in/out parameter, below available values under account keys
Return Value
KErrNone or some system-wide Symbian error code.

SmcQueryVariantRequestL ( TRequestStatus &, CWSAccount & )

TInt SmcQueryVariantRequestL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

StartFetchClockServerTimeL ( TRequestStatus & )

TInt StartFetchClockServerTimeL(TRequestStatus &aStatus)[pure virtual]

StartFetchNokiaPrivacyPolicyContentL ( TRequestStatus &, CWSAccount & )

TInt StartFetchNokiaPrivacyPolicyContentL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

StartFetchNokiaTermsAcceptanceInformationL ( TRequestStatus &, CWSAccount & )

TInt StartFetchNokiaTermsAcceptanceInformationL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

StartFetchNokiaToSContentL ( TRequestStatus &, CWSAccount & )

TInt StartFetchNokiaToSContentL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

StartFetchYahooPrivacyPolicyContentL ( TRequestStatus &, CWSAccount & )

TInt StartFetchYahooPrivacyPolicyContentL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

StartFetchYahooToSContentL ( TRequestStatus &, CWSAccount & )

TInt StartFetchYahooToSContentL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

StartUpdateTermsAcceptanceInformationL ( TRequestStatus &, CWSAccount & )

TInt StartUpdateTermsAcceptanceInformationL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

UpdateAccountProfileL ( TRequestStatus &, CWSAccount & )

TInt UpdateAccountProfileL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

Updates account profile on the backend side. If the given key is not present in the aAccount parameter, the corresponding data will be left intact on the backend side. If the key exists, but its value is set empty, corresponding data will be removed from the backend. In values ========================================================================= |key | values | ========================================================================= |aAccount.Password() | Account password | ------------------------------------------------------------------------- |KWSAccAttrAccountSecretQuest | Id of security question | ------------------------------------------------------------------------- |KWSAccAttrAccountSecretAnswer | Answer for security question | ------------------------------------------------------------------------- |KWSAccAttrAccountMobile | Account's owner mobile phone number| ------------------------------------------------------------------------- |KWSAccAttrAccountEmail | Account's owner email address | ------------------------------------------------------------------------- |KWSAccAttrAccountLanguage | Preffered Language | ------------------------------------------------------------------------- |KWSAccAttrAccountCountry | Account's owner country | ------------------------------------------------------------------------- |KWSAccAttrAccountDateOfBirth | Account's owner date of birth | ------------------------------------------------------------------------- |KWSAccAttrAccountFirstName | Account's owner first name | ------------------------------------------------------------------------- |KWSAccAttrAccountLastName | Account's owner last name | ------------------------------------------------------------------------- |KWSAccAttrAccountGender | Account's owner gender | ------------------------------------------------------------------------- Out values ========================================================================= |key | values | ========================================================================= | This box values are present only in case of an error |KWSAccAttrErrorCode | Keeps the number of error code | | | |KWSAccAttrErrorName | Indicates a place where error occured| | | |KWSAccAttrErrorMessage | Error details if available | -------------------------------------------------------------------------

Parameters
aStatus- Used by Plugin to indicate completion of the send request. aStatus return values: KErrNone - list of secret questions downloaded Transport error - like HTTP errors (4xx, 5xx) KErrCancel - request has been cancelled KSenConnectionStatusExpired - connection to backend can not be established (for example: token invalid)
aAccount- in/out parameter, below available values under account keys
Return Value
KErrNone or some system-wide Symbian error code.

UpdateDeviceInfoL ( TRequestStatus &, CWSAccount & )

TInt UpdateDeviceInfoL(TRequestStatus &aStatus,
CWSAccount &aAccount
)[pure virtual]

Update the device Info if there is a Full Account. ========================================================================= |key | value | ========================================================================= |KWSAccAttrAccountMobile | User Mobile Number |

-------------------------------------------------------------------------

------------------------------------------------------------------------- | This box values are present only in case of an error |KWSAccAttrErrorCode | Keeps the number of error code | | | |KWSAccAttrErrorName | Indicates a place where error occured| | | |KWSAccAttrErrorMessage | Error details if available | -------------------------------------------------------------------------

Parameters
aStatus- Used by Plugin to indicate completion of the send request. aStatus as return values: KErrNone - successfully fetched CAPCTHA, and stored within aAccount Transport errors - like HTTP errors (4xx, 5xx) KErrCancel - request has been cancelled
aAccount- out parameter, below available values under account keys
Return Value
KErrNone or some system-wide Symbian error code.