Public Member Type Definitions | |
---|---|
typedef | QString ConsumerKey |
typedef | Contact EmailContactInfo |
typedef | Contact MobileContactInfo |
typedef | QHash< QString, QString > QTHashTable |
Public Member Functions | |
---|---|
QString | GenderToString(const Gender &) |
Gender | StringToGender(const QString &) |
TermsFormat | StringToTermsFormat(const QString &) |
QString | TermsFormatToString(const TermsFormat &) |
_LIT(KCrossEnablerServerFilename, "crossenablerserver.exe") | |
_LIT(KCrossEnablerServerName, "crossenablerserver") | |
_LIT(KCrossEnablerServerSemaphoreName, "CrossEnablerServerSemaphore") | |
_LIT(KMmTsyModuleName, "phonetsy") |
All common data-structures, enumerations, static values are defined here.
The class NokiaAccountEngine manages all the requests and interaction that the clients make with the server.All the client requests and data are managed in this singleton engine repository class. The class NokiaAccountEngine manages all the requests and interaction that the clients make with the server.All the client requests and data are managed in this singleton engine repository class.
typedef QString | ConsumerKey |
typedef Contact | EmailContactInfo |
typedef Contact | MobileContactInfo |
typedef QHash< QString, QString > | QTHashTable |
const char *const | BACKENDDATA |
const char *const | BLRHA_BASEURL |
const char *const | CMCC_BASEURL |
const char *const | CMCC_STAGINGURL |
const char *const | CMCC_TESTINGURL |
const char *const | COLON |
const QString | COMMA_TAG |
const char *const | DATAKEY_BASEURL |
const char *const | DATAKEY_SESSIONID |
const QSize | DEFAULTCAPTCHASIZE | [static] |
const int | DEFAULTHEIGHT | [static] |
const int | DEFAULTTIMEOUT | [static] |
const int | DEFAULTWIDTH | [static] |
const char *const | EMAILBACKENDDATA |
const QString | EQUAL_TAG |
const QString | EQUAL_WITH_QUOTE_TAG |
const QString | HTTP_DELETE |
const QString | HTTP_GET |
const QString | HTTP_POST |
const QString | HTTP_PUT |
const TUint | KCrossEnablerServBuildVersionNumber |
const TUint | KCrossEnablerServMajorVersionNumber |
const TUint | KCrossEnablerServMinorVersionNumber |
const TUint | KDefaultMessageSlots | [static] |
const TUid | KServerUid3 |
const char *const | NABBI_BASEURL |
const QString | OAUTH_CONSUMERKEY_TAG |
const QString | OAUTH_CRYPT_TYPE |
const QString | OAUTH_DELIMIT_TAG |
const QString | OAUTH_NONCE_TAG |
const QString | OAUTH_REALM |
const QString | OAUTH_SIGNATURE |
const QString | OAUTH_SIGNATURE_METHOD |
const QString | OAUTH_TIMESTAMP |
const QString | OAUTH_TOKEN_KEY |
const QString | OAUTH_VERSION |
const QString | OAUTH_VERSION_TAG |
const char *const | PASSWORDBACKENDDATA |
const char *const | PLUGINNAME |
const char *const | PLUGINPATH |
const char *const | PRODUCTION_BASEURL |
const char *const | QA_BASEURL |
const char *const | QA_BASEURL_LATEST |
const QString | REST_AVAILABILITY |
const QString | REST_CAPTCHAS |
const QString | REST_CHANGESTRING |
const QString | REST_CONSENT_QUERY_VARIANT |
const QString | REST_CONTACTSTRING |
const QString | REST_DOWNLOADPROFILE |
const QString | REST_EMAIL_AVAILABILITY |
const QString | REST_GUARDIANTOKEN |
const QString | REST_MARKETINGSTRING |
const QString | REST_NEWREGISTRATION |
const QString | REST_PASSWORDRECOVERY |
const QString | REST_QUESTIONSTRING |
const QString | REST_REFRESHTOKEN |
const QString | REST_REGISTRATION |
const QString | REST_SECURITY_QUESTION |
const QString | REST_SENDSTRING |
const QString | REST_SERVICES |
const QString | REST_SIGNIN |
const QString | REST_SLASH |
const QString | REST_TERMS |
const char *const | SASL_AUTHENTICATE_STRING |
const char *const | SASL_CHARSET | [static] |
const char *const | SASL_DIGEST_URI |
const char *const | SASL_NONCE_COUNT_VALUE | [static] |
const char *const | SASL_QOP | [static] |
const char *const | SASL_REALM | [static] |
const char *const | SERVICEID_ONE_CONSENT | [static] |
const int | STRINGNOTFOUND |
const QString | STR_APPLICATION_NAME |
const QString | STR_BASEURL |
const QString | STR_ORGANIZATION |
const char *const | TEST_BASEURL |
const QString | XMLTAG_ACCOUNTID |
const QString | XMLTAG_ACCOUNTNOTACTIVATED |
const QString | XMLTAG_AGEVERIFICATIONMETHOD |
const QString | XMLTAG_AGEVERIFICATIONNEEDED |
const QString | XMLTAG_ATTRIBUTESYNTAXERROR |
const QString | XMLTAG_AUTHENTICATIONINFO |
const QString | XMLTAG_CAPSERROR |
const QString | XMLTAG_CAPSFEMALE |
const QString | XMLTAG_CAPSMALE |
const QString | XMLTAG_CAPTCHACREATIONRESPONSE |
const QString | XMLTAG_CAPTCHAERROR |
const QString | XMLTAG_CAPTCHAID |
const QString | XMLTAG_CONDITIONS |
const QString | XMLTAG_CONSENTQUERYVARIANT |
const QString | XMLTAG_CONSENTQUERYVARIANTRESPONSE |
const QString | XMLTAG_CONSUMERKEY |
const QString | XMLTAG_CONTACTS |
const QString | XMLTAG_CONTACTSUPDATERESPONSE |
const QString | XMLTAG_CONTACTUPDATE |
const QString | XMLTAG_CONTACTUPDATEERROR |
const QString | XMLTAG_COUNTRY |
const QString | XMLTAG_DATEOFBIRTH |
const QString | XMLTAG_DETAILEDERRORCODE |
const QString | XMLTAG_DISALLOWED |
const QString | XMLTAG_EMAIL |
const QString | XMLTAG_EMAILADDRESS |
const QString | XMLTAG_EMAILCONTACTOUTPUT |
const QString | XMLTAG_EMAILVERIFIED |
const QString | XMLTAG_ERROR |
const QString | XMLTAG_ERRORCODE |
const QString | XMLTAG_ERRORTEXT |
const QString | XMLTAG_EXPIRES |
const QString | XMLTAG_EXTENSIONS |
const QString | XMLTAG_FEMALE |
const QString | XMLTAG_FIRSTNAME |
const QString | XMLTAG_GENDER |
const QString | XMLTAG_GENERALERROR |
const QString | XMLTAG_GUARDIANTOKEN |
const QString | XMLTAG_GUARDIANTOKENRESPONSE |
const QString | XMLTAG_GUARDIANVALIDATIONERROR |
const QString | XMLTAG_HASACCEPTEDPRIVACYPOLICY |
const QString | XMLTAG_HASACCEPTEDSERVICESPECIFICTOS |
const QString | XMLTAG_HASACCEPTEDTOS |
const QString | XMLTAG_ILLEGALREQUESTMETHOD |
const QString | XMLTAG_ILLEGALUPDATE |
const QString | XMLTAG_IMAGEDATA |
const QString | XMLTAG_IMAGETYPE |
const QString | XMLTAG_INVALIDACCESSTOKEN |
const QString | XMLTAG_INVALIDCAPTCHA |
const QString | XMLTAG_INVALIDCOUNTRY |
const QString | XMLTAG_INVALIDCREDENTIALS |
const QString | XMLTAG_INVALIDEMAILADDRESS |
const QString | XMLTAG_INVALIDLANGUAGE |
const QString | XMLTAG_INVALIDMESSAGEFORMAT |
const QString | XMLTAG_INVALIDPASSWORD |
const QString | XMLTAG_INVALIDPHONENUMBER |
const QString | XMLTAG_INVALIDURL |
const QString | XMLTAG_LANGUAGE |
const QString | XMLTAG_LASTNAME |
const QString | XMLTAG_LEVEL |
const QString | XMLTAG_MALE |
const QString | XMLTAG_MARKETINGCONSENT |
const QString | XMLTAG_MARKETINGCONSENTQUERYRESPONSE |
const QString | XMLTAG_MOBILE |
const QString | XMLTAG_MOBILECONTACTOUTPUT |
const QString | XMLTAG_MOBILENUMBER |
const QString | XMLTAG_MOBILENUMBERRESERVED |
const QString | XMLTAG_MOBILEVERIFIED |
const QString | XMLTAG_NOTAUTHORIZED |
const QString | XMLTAG_NOTIMPLEMENTED |
const QString | XMLTAG_NOTSIGNEDIN |
const QString | XMLTAG_OPERATIONFAILED |
const QString | XMLTAG_PASSWORDMISMATCH |
const QString | XMLTAG_PASSWORDQUESTION |
const QString | XMLTAG_PASSWORDQUESTIONTEXT |
const QString | XMLTAG_PREFERRED |
const QString | XMLTAG_PRIVACYPOLICYURL |
const QString | XMLTAG_PROFILE |
const QString | XMLTAG_PROFILEQUERYRESPONSE |
const QString | XMLTAG_PROFILEUPDATEERROR |
const QString | XMLTAG_PROFILEUPDATERESPONSE |
const QString | XMLTAG_REGISTRATIONERROR |
const QString | XMLTAG_REGISTRATIONRESPONSE |
const QString | XMLTAG_RESOURCENOTFOUND |
const QString | XMLTAG_SECURITYQUESTION |
const QString | XMLTAG_SECURITYQUESTIONID |
const QString | XMLTAG_SECURITYQUESTIONSRESPONSE |
const QString | XMLTAG_SECURITYQUESTIONTEXT |
const QString | XMLTAG_SERVICE |
const QString | XMLTAG_SERVICEQUERYRESPONSE |
const QString | XMLTAG_SERVICES |
const QString | XMLTAG_SERVICESPECIFICTOSURL |
const QString | XMLTAG_SERVICEURL |
const QString | XMLTAG_SIGNIN_TERMSINFO |
const QString | XMLTAG_SIMPLECONSENT |
const QString | XMLTAG_SIMPLIFIEDCHANGEPASSWORDRESPONSE |
const QString | XMLTAG_SIMPLIFIEDPASSWORDQUESTIONRESPONSE |
const QString | XMLTAG_TERMSINFO |
const QString | XMLTAG_TERMSQUERYRESPONSE |
const QString | XMLTAG_TIME |
const QString | XMLTAG_TOKEN |
const QString | XMLTAG_TOKENCREATIONRESPONSE |
const QString | XMLTAG_TOKENINFO |
const QString | XMLTAG_TOKENREFRESHRESPONSE |
const QString | XMLTAG_TOKENSECRET |
const QString | XMLTAG_TOSURL |
const QString | XMLTAG_TTL |
const QString | XMLTAG_UNKNOWNCONTENTTYPE |
const QString | XMLTAG_USERINFO |
const QString | XMLTAG_USERNAME |
const QString | XMLTAG_USERNAMEAVAILABILITYRESPONSE |
const QString | XMLTAG_USERNAMERESERVED |
const QString | XMLTAG_USERNAMESUGGESTION |
const QString | XMLTAG_USERNAMESUGGESTIONS |
const QString | XMLTAG_USERNOTFOUND |
const QString | XMLTAG_USERPROFILE |
const QString | XMLTAG_VERIFIED |
const QString | XMLTEXT_CONSENTQUERYVARIANT_COPYTEXT |
const QString | XMLTEXT_CONSENTQUERYVARIANT_IMPLICIT |
const QString | XMLTEXT_CONSENTQUERYVARIANT_PRETICKED |
const QString | XMLTEXT_CONSENTQUERYVARIANT_UNTICKED |
const QString | XML_CONTENT_TAG |
const QString | XML_EMPTYSTRING |
const QString | XML_UNDERSCORE |
Enums for Hashing method used for accountId.
Enumerator | Value | Description |
---|---|---|
AccountIdHashNone | 0 | |
AccountIdHashSHA1 | ||
AccountIdHashMD5 |
Different Backend server URLs.
Enums for base url. Clients need to provide the settings using QSettings for the base url to be used. The organisation name and the application name in QSettings should be Nokia and NokiaAccountQT. Clients can choose one of the enums of the BaseUrl as the value of the QSettings.The key of the value provided should be baseUrl. By default( if the client doesnt provide any setting ) testUrl would be taken as the default. Clients should provide the base url settings before any other code( even before creation of any instances of registration,profilemanager,passwordmanager). Settings should not be changed dynamically by the client.The settings provided at the beginning will be taken as the setting for the session.
Example client code : QSettings baseUrlSetting("Nokia","NokiaAccountQT"); baseUrlSetting.setValue( "baseUrl", QVariant(index) );
Currently the url address of the three enums are - testUrl is https://nabbi.noklab.com/rest/1.0/ qaUrl is https://nacci.nrln.net/rest/1.0/ productionurl is https://nokia.account.com/rest/1.0/ qaStagingUrl is https://st-account.nokia.com/rest/1.0/ blrHaUrl is https://noaha.blrops.com/rest/1.0/ nabbiUrl is https://nabbi.noklab.com/rest/1.0/ cmccUrl is https://cmcc.account.nokia.com.cn/rest/1.0/ cmccStagingUrl is https://staging.cmcc.account.nokia.com.cn/rest/1.0/ cmccTestingUrl is https://testing.cmcc.account.nokia.com.cn/rest/1.0/
Enumerator | Value | Description |
---|---|---|
baseUrlUninitialized | -1 | |
baseUrlMin | 0 | |
testUrl | 0 |
0 - Test url. |
qaUrl |
1 - QA url. | |
productionUrl |
2 - Production url. | |
qaStagingUrl |
3 - QA staging url. | |
blrHaUrl |
4 - Bangalore HA url. | |
nabbiUrl |
5 - NABBI - Testing URL. | |
cmccUrl |
6 - cmccUrl Production | |
cmccStagingUrl |
7 - cmccUrl Staging | |
cmccTestingUrl |
8 - cmccUrl Testing | |
baseUrlMax | cmccTestingUrl |
Enumerator | Value | Description |
---|---|---|
captchaRegistration | 0 | |
captchaForgotPassword |
Enumerator | Value | Description |
---|---|---|
QueryVariantNone |
consent query variant is not updated | |
QueryVariantImplicit |
Response to the request for consentQueryVariant: "implicit" | |
QueryVariantPreTicked |
Response to the request for consentQueryVariant: "pre-ticked" | |
QueryVariantUnTicked |
Response to the request for consentQueryVariant: "un-ticked" | |
QueryVariantUnTickedWithCopyText |
Response to the request for consentQueryVariant: "un-tickedWithCopyText" |
Enumerator | Value | Description |
---|---|---|
eSSONotifyProvisionData | 0 | |
eSSONotifyMAX | 1 |
Enumerator | Value | Description |
---|---|---|
eSSODataReceived | 0 | |
eSSONetworkFailure | 1 | |
eSSORequestNotAllowed | 2 | |
eSSOValidDataAvailable | 3 |
Error values that may be returned by the enabler. re-defined.
Enumerator | Value | Description |
---|---|---|
errorNone |
0: No error. | |
errorInvalidAccessToken |
1: Invalid token. | |
errorIllegalRequestMethod |
2: Illegal request. | |
errorUnknownContentType |
3: Content type unknown. | |
errorInvalidUrl |
4: Invalid URL. | |
errorNotAuthorized |
5:Not authorised to do the operation. | |
errorGeneralError |
6: General error. | |
errorInvalidMessageFormat |
7: Invalid message format. | |
errorResourceNotFound |
8: Resource not found. | |
errorOperationFailed |
9: Operation falied. | |
errorNotSignedIn |
10: User not signed in. | |
errorInvalidCredentails |
11: Invalid user credentials. | |
errorAccountNotActivated |
12: Account not activated. | |
errorNotImplemented |
13: Not yet implemented. | |
errorPasswordMismatch |
14: Password missmatch error. | |
errorUsernameReserved |
15: Username reserved error. | |
errorCaptchaError |
16: Captcha error. | |
errorContactUpdate |
17: Error in contacts update. | |
errorAttributeSyntaxError |
18: Error attribute syntax | |
errorInvalidEmailAddress |
19: Error invalid email address | |
errorInvalidPhoneNumber |
20: Error invalid phone number | |
errorInvalidCountry |
22: Error invalid country | |
errorInvalidLanguage |
22: Error invalid language | |
errorTimeOutOfSync |
23: Invalid time, time out of sync | |
errorDateOfbirthNotFound |
24: DOB is mandatory parameter | |
errorAgeVerificationSimpleConsent |
25: Guardian consent reqd | |
errorAgeVerificationDisallowed |
26: Not allowed to register | |
errorTooYoung |
27: Too young to become guardian | |
errorConnectionRefused |
28: Error connection refused | |
errorRemoteHostClosed |
29: Error remote host closed connection | |
errorHostNotFound |
30: Error host not found | |
errorTimeout |
31: Error time out occured | |
errorOperationCanceled |
32: Error operation canceled | |
errorSslHandShakeFailed |
33: Error ssl handshake failed | |
errorProxyConnectionRefused |
34: Error proxy connection refused | |
errorProxyConnectionClosed |
35: Error proxy connection closed | |
errorProxyNotFound |
36: Error proxy not found | |
errorProxyAuthenticationRequired |
37: Error proxy authentication required | |
errorUnknownNetworkError |
38: Error unknown network error | |
errorUnknownProxyError |
39: Error unknown proxy related error | |
errorUserPreregistered |
40: Error User pre registered | |
errorServicetagError |
41: Error in service tag | |
errorSIMInfoNotFound |
42: Sim info not found | |
errorInvalidRequest |
43: Invalid request | |
errorContentOperationNotPermitted | 47 |
47: Content operation not permitted; perhaps, serviceTag/captcha is required |
errorEmailIdNotAvailable | 48 |
48: This error indicates that the provided email id not available at the backend |
errorUserCancelledVerification | 49 |
49: User cancelled the verification UI |
errorMobileNumberNotAvailable | 50 |
50: This error indicates that the provided mobile number is not available at the backend |
errorUserNotFound | 51 |
51: This error indicates no account found on the server for the provided mobile number or email-id |
errorInvalidNewPassword | 52 |
52: This error indicates that the provided new password is not valid |
errorUserInputRquired | 100 |
100: Indicates userInputRequired token recieved for federation request |
The gender of the user is stored in the form of the enum Gender.
Enumerator | Value | Description |
---|---|---|
GenderUnknown |
Default value. User did not wish to disclose. | |
GenderMale |
User is male. | |
GenderFemale |
User is female. |
Enums for ProxyType. Clients need to use this enum to indicate what type of proxy rquired for connectivity. NoProxy - No Proxy required. Direct connection to internet AutoProxy - Enabler will fetch the proxy address based on connection URL. SetProxy - User should specify a proxy address.
Enums for RememberMe. Clients need to use this enum to indicate whether the user credentials is to be remembered or not. rememberMeFalse - By default, the user credentials are not remembered. rememberMeTrue - the user credentials are remembered for the session until the user signs out. unchanged - reuse the previous session's remember me value to determine whether the user credentials is to be remembered or not for this session. The user credentials(username and password) is lost when the user signs out.
Enumerator | Value | Description |
---|---|---|
rememberMeFalse |
Dont remember user's credentials. | |
rememberMeTrue |
Remember user's credentials. | |
unchanged |
Re use the previous session's remember me value. |
Indicates the type of request made during an async call.
Enumerator | Value | Description |
---|---|---|
requestNone |
0: Default request. | |
requestSignIn |
1: Signin request. | |
requestDownload |
2: Download profile request. | |
requestUpload |
3: Upload profile request. | |
requestRefreshToken |
4: Refresh token request. | |
requestDeleteAccount |
5: Delete token request. | |
requestRegisterAccount |
6: Register/sing-up request. | |
requestRetrieveSecurityQuestionList |
7: Reterive security questions list. | |
requestRetrieveUserNameAvaiability |
8: Reterive available usernames. | |
requestRetrieveCaptchImage |
9: Reterive the captcha image. | |
requestRetrieveTermsOfService |
10: Reterive the terms of service. | |
requestRetrieveContactInfo |
11: Reterive additional contact information. | |
requestRetrieveMarketingInfo |
12: Reterive marketing subscription information. | |
requestUpdateMarketingInfo |
13: Update marketing subscription. | |
requestUpdateContactInfo |
14: Update contact information. | |
requestRetriveSecurityQuestion |
15: Retrieve security question request. | |
requestResetMessage |
16: Reset message request. | |
requestResetPassword |
17: Change password request | |
requestDeleteToken |
18: Delete token from backend | |
requestChangePassword |
19: change password request | |
requestRetrieveTOS |
20: Retrieve TOS | |
requestRetrieveTermsAcceptance |
21: Retrieve terms acceptance> | |
requestUpdateTermsAcceptance |
22: Update terms acceptance> | |
requestChangeSecurityQuestion |
23: Request for security question update> | |
requestGuardianToken |
24: Request for Guardian Token> | |
requestDetectPreAccount |
25: Request for detect preaccount> | |
requestRegisterPreAccount |
26: Request for register pre account> | |
requestUpdateDeviceInfo |
27: Request for update device information> | |
requestCheckEmailIdAvailability |
28: Check if the given email id is available in the back end. | |
requestConsentQueryVariant |
29: Request for the consent query variant | |
requestOperatorProfileFetch | 100 |
100: Request for the operator profile fetch |
requestOperatorRegisterProfile |
101: Request for the operator profile register and retireve token information after registration. | |
requestFedProvisioningFetch |
102: Request for the provisioning data downlad | |
requestFederateAccount |
103: Request for Federating an existing account |
Enumerator | Value | Description |
---|---|---|
eAccountCategoryDefault | 0 | |
eAccountCategoryFedShadow | ||
eAccountCategoryFedLink |
structure to identify federation type. serviceid comes from service clients FedIdentityType also provided by upper layers of FedEnabler
Enumerator | Value | Description |
---|---|---|
eAccIdentityAllowedUndefined | 0 | |
eAccIdentityAllowedYes | 1 | |
eAccIdentityAllowedNo | 2 | |
eAccIdentityNotSupported | 3 |
Enumerator | Value | Description |
---|---|---|
TermsTos | ||
TermsServiceSpecificTos | ||
TermsPrivacyPolicy | ||
TermsServiceSpecificPrivacyPolicy | ||
TermsOviStoreWithOrange |
Enumerator | Value | Description |
---|---|---|
TermsFormatUnknown |
Unknown format | |
TermsFormatText |
Format is Text | |
TermsFormatHtml |
Format is Html |
Token state used to notifiy clients about any change in the token state.
Enumerator | Value | Description |
---|---|---|
tokenStateRenewed |
Token renewed. | |
tokenStateExpired |
Token expired. | |
tokenStateDeleted |
Token deleted. |
launchUi use cases
Enumerator | Value | Description |
---|---|---|
UiLaunchSignIn | 0 | |
UiLaunchAccountManagement | 1 | |
UiLaunchSetUserId | 2 | |
UiReEnterPassword | 3 |
QString | GenderToString | ( | const Gender & | gender | ) | [static] |
Returns the string corresponding to the gender.
Gender | StringToGender | ( | const QString & | genderString | ) | [static] |
Returns the gender corresponding to the string.
TermsFormat | StringToTermsFormat | ( | const QString & | formatString | ) | [static] |
Returns the format corresponding to the string.
QString | TermsFormatToString | ( | const TermsFormat & | format | ) | [static] |
Returns the string corresponding to the Format.
_LIT | ( | KCrossEnablerServerFilename | , |
"crossenablerserver.exe" | |||
) |
_LIT | ( | KCrossEnablerServerName | , |
"crossenablerserver" | |||
) |
_LIT | ( | KCrossEnablerServerSemaphoreName | , |
"CrossEnablerServerSemaphore" | |||
) |
_LIT | ( | KMmTsyModuleName | , |
"phonetsy" | |||
) |