API Docs for:
Show:

eb_profile Class

User Profile class.

Methods

eb_profile.domElement

(
  • domElement
)

Page DOM element.

Parameters:

  • domElement Object

    current DOM element.

eb_profile.getCountriesData

() Object

Public method to get countries data list from the server. The service will return list of all countries.

Returns:

Object:

jQuery promise object which when resolved returns countries list.

eb_profile.getPersonData

(
  • personID
)
Object

Get person data from the server through the get service call.

Parameters:

  • personID String

    Person Id.

Returns:

Object:

jQuery promise object which when resolved returns person data.

eb_profile.getPersonPhoneNumberData

() Object

Public method to get person phone data list from the server. The service will return list of all phones.

Returns:

Object:

jQuery promise object which when resolved returns phones list.

eb_profile.getPersonsAddresses

(
  • personId
)
Object

Public method to get Persons Addresses data list from the server

Parameters:

  • personId Number

    personId to get person addresses

Returns:

Object:

Addresses of person

eb_profile.getProfileAddresses

(
  • personId
)
Object

Public method to get Profile Addresses data list from the server.

Parameters:

  • personId String

    Person Id.

Returns:

Object:

jQuery promise object which when resolved returns profile address data.

eb_profile.getProfilePhoneNumberData

() Object

Public method to get profile phone data list from the server. The service will return list of all phones.

Returns:

Object:

jQuery promise object which when resolved returns phones list.

eb_profile.getProvinceData

(
  • country
)
Object

Public method to get province data list from the server.

Parameters:

  • country String

    Country Id.

Returns:

Object:

jQuery promise object which when resolved returns province list.

eb_profile.getSearchData

() Object

Get Service call for search data

Returns:

Object:

jQuery promise object which when resolved returns search data.

eb_profile.makePreferredMailingaddress

(
  • personId
  • data
  • addressName
)
Object

PATCH service call method.

Parameters:

  • personId Number

    personId

  • data Object

    Address related information[ State, City, Country ...]

  • addressName String

    Updated information of person Address

Returns:

Object:

Return Updated Address

eb_profile.model

(
  • options
  • domElement
  • userContext
)

Person profile model.

Parameters:

  • options Any

    Object of profile data.

  • domElement String

    DOM element.

  • userContext String

    eb_UserContext.model instance.

eb_profile.render

(
  • options
)
String

Rendering public method to load HTML template. Based on page level configuration it will select the template and load in DOM.

Parameters:

  • options Any

    Array of required data.

    • templatePath String

      Profile template URL.

Returns:

String:

Profile HTML template.

eb_profile.updatePersonAddressRecord

(
  • personId
  • data
  • addressName
)
Object

PATCH service call method.

Parameters:

  • personId Number

    personId

  • data Object

    Address related information[ State, City, Country ...]

  • addressName String

    Updated information of person Address

Returns:

Object:

Return Updated Address

eb_profile.updatePersonData

(
  • data
)
Object

Update person profile information method.

Parameters:

  • data Object

    Data to be updated.

Returns:

Object:

jQuery promise object which when resolved returns updated person data.

eb_profile.updatePersonPhoneNumbersData

() Object

Update person phone number information

Returns:

Object:

jQuery promise object which when resolved returns search data.

eb_profile.updateProfileAddressRecord

(
  • data
  • addressName
)
Object

PATCH service call method.

Parameters:

  • data Object

    Data to be updated.

  • addressName String

    Address name.

Returns:

Object:

jQuery promise object which when resolved returns updated profile address data.

eb_profile.updateProfilePhoneNumbersData

() Object

Update profile phone number information

Returns:

Object:

jQuery promise object which when resolved returns search data.

eb_profile.validateAddressData

(
  • country
)
Object

Public method to validate data from the server.

Parameters:

  • country String

    Country Id.

Returns:

Object:

jQuery promise object which when resolved returns province list.

Properties

eb_profile.defaultErrorMessage

String

Default error message.

eb_profile.errorResponses

Object

Globally defined error codes object for the control. Every error code should have boolean 'useServerMessage' attribute, which when true suggests we are showing service error message on the UI. If the 'useServerMessage' is defined as false, then provide another attribute 'frontEndMessage' with the error string which will be shown on UI. If 'useServerMessage' is false and 'frontEndMessage' is not defined, default error message will be shown. If service error response contains error code not defined in this object then default error message will be shown.

eb_profile.getSearchDetails

String

GET service to get the company list

eb_profile.proceedToOrderHistory

String

OrderHistory Page URL.

eb_profile.ServicePath

String

SOA path. It would be set from configuration file.

eb_profile.ServicePath

String

SOA serviceUrls. All profile Service URLs.

eb_profile.SitePath

String

Site path. It would be set from configuration file.

eb_profile.TemplatePath

String

Profile template path.