eb_BillingShippingAddressAdmin Class
Define eb_BillingShippingAddressAdmin class.
Item Index
Methods
- eb_BillingShippingAddressAdmin.createAddressRecord
- eb_BillingShippingAddressAdmin.deleteCompanyAddressRecord
- eb_BillingShippingAddressAdmin.deleteCompanyProfileAddressRecord
- eb_BillingShippingAddressAdmin.domElement
- eb_BillingShippingAddressAdmin.getAllShipmentTypes
- eb_BillingShippingAddressAdmin.getCompanyAddresses
- eb_BillingShippingAddressAdmin.getCompanyProfileAddresses
- eb_BillingShippingAddressAdmin.getCountriesData
- eb_BillingShippingAddressAdmin.getProvinceData
- eb_BillingShippingAddressAdmin.model
- eb_BillingShippingAddressAdmin.render
- eb_BillingShippingAddressAdmin.shoppingCart
- eb_BillingShippingAddressAdmin.updateCompanyAddressRecord
- eb_BillingShippingAddressAdmin.updateCompanyProfileAddressRecord
- eb_BillingShippingAddressAdmin.userContext
Properties
- eb_BillingShippingAddressAdmin.companyId
- eb_BillingShippingAddressAdmin.defaultErrorMessage
- eb_BillingShippingAddressAdmin.deleteCompanyAddressService
- eb_BillingShippingAddressAdmin.deleteProfileAddressService
- eb_BillingShippingAddressAdmin.errorResponses
- eb_BillingShippingAddressAdmin.getAllShipmentTypesURL
- eb_BillingShippingAddressAdmin.getCompanyAddressService
- eb_BillingShippingAddressAdmin.getCompanyProfileAddressService
- eb_BillingShippingAddressAdmin.getCountriesService
- eb_BillingShippingAddressAdmin.getProvinceService
- eb_BillingShippingAddressAdmin.newAddressService
- eb_BillingShippingAddressAdmin.orderReviewUrl
- eb_BillingShippingAddressAdmin.selectedAddress
- eb_BillingShippingAddressAdmin.ServicePath
- eb_BillingShippingAddressAdmin.shippingAddress
- eb_BillingShippingAddressAdmin.SitePath
- eb_BillingShippingAddressAdmin.skipPageRedirection
- eb_BillingShippingAddressAdmin.TemplatePath
- eb_BillingShippingAddressAdmin.updateCompanyAddressService
- eb_BillingShippingAddressAdmin.updateCompanyProfileAddressService
Methods
eb_BillingShippingAddressAdmin.createAddressRecord
-
companyId
-
data
POST service call method.
Parameters:
-
companyId
NumbercompanyId
-
data
ObjectAddress related information[ State, City, Country ...]
Returns:
New address promise object with City, Id, Country, State, line1, line2, name, postal code, StateProvience fields.
eb_BillingShippingAddressAdmin.deleteCompanyAddressRecord
-
companyId
-
addressName
Delete custom Company Address Service call
Parameters:
-
companyId
NumbercompanyID
-
addressName
StringAddress name to delete particular address
eb_BillingShippingAddressAdmin.deleteCompanyProfileAddressRecord
-
companyId
-
addressName
Delete Company Profile Address Service call
Parameters:
-
companyId
NumbercompanyID
-
addressName
StringAddress name to delete particular address
eb_BillingShippingAddressAdmin.domElement
-
domElement
Page DOM element.
Parameters:
-
domElement
Objectcurrent DOM element.
eb_BillingShippingAddressAdmin.getAllShipmentTypes
()
Object
Gets all web-enabled shipment types.
Returns:
jQuery promise object which when resolved returns shipment type list.
eb_BillingShippingAddressAdmin.getCompanyAddresses
-
companyId
Public method to get custom Company Addresses data list from the server
Parameters:
-
companyId
NumbercompanyId to get company addresses
Returns:
Addresses of company
eb_BillingShippingAddressAdmin.getCompanyProfileAddresses
-
companyId
Public method to get Profile Addresses data list from the server
Parameters:
-
companyId
NumbercompanyId to get profile addresses
Returns:
Addresses of person
eb_BillingShippingAddressAdmin.getCountriesData
()
Object
Public method to get countries data list from the server.
Returns:
Return Array of All Countries
eb_BillingShippingAddressAdmin.getProvinceData
-
country
Get State/Province list from the server through the get service call.
Parameters:
-
country
StringAll the state in specified country
Returns:
Return Array of state
eb_BillingShippingAddressAdmin.model
-
options
BillingShippingAddressAdmin Model for binding data. The model contains observable properties to hold corresponding data returned from services. Also, model contains computed properties and methods to support Billing and Shipping Address functionality.
Parameters:
-
options
ObjectContains necessary data which is required for Billing and Shipping Address functionality.
-
ServicePath
StringService URL.
-
SitePath
StringSite URL.
-
data
ObjectContains data returned from service which is used to construct BillingShippingAddress model.
-
domElement
ObjectDOM element.
-
templatePath
StringHTML path.
-
eb_BillingShippingAddressAdmin.render
-
options
Rendering public method to load HTML template. Based on page level configuration it will select the template and load in DOM. Template path and DOM element are required parameters. GET the template by Ajax call using template path and then assign it to DOM element.
Parameters:
-
options
ObjectObject with data required for getting HTML template through Ajax call.
-
SitePath
StringSite path.
-
templatePath
StringHTML file path.
-
domElement
ObjectDOM element.
-
Returns:
jQuery promise object which when resolved returns HTML template.
eb_BillingShippingAddressAdmin.shoppingCart
-
shoppingCart
Shopping cart object
Parameters:
-
shoppingCart
Objectshopping cart object.
eb_BillingShippingAddressAdmin.updateCompanyAddressRecord
-
companyId
-
data
-
addressName
PATCH service call method.
Parameters:
-
companyId
NumbercompanyId
-
data
ObjectAddress related information[ State, City, Country ...]
-
addressName
StringUpdated information of company Address
Returns:
Return Updated Address
eb_BillingShippingAddressAdmin.updateCompanyProfileAddressRecord
-
companyId
-
data
-
addressName
PATCH service call method.
Parameters:
-
companyId
NumbercompanyId
-
data
ObjectAddress related information[ State, City, Country ...]
-
addressName
StringUpdated information of profile address
Returns:
Return Updated Address
eb_BillingShippingAddressAdmin.userContext
-
userContext
User context object
Parameters:
-
userContext
ObjectuserContext object.
Properties
eb_BillingShippingAddressAdmin.companyId
String
Company Id
eb_BillingShippingAddressAdmin.defaultErrorMessage
String
Default error message.
eb_BillingShippingAddressAdmin.deleteCompanyAddressService
String
Delete company's custom address
eb_BillingShippingAddressAdmin.deleteProfileAddressService
String
Delete company's profile address
eb_BillingShippingAddressAdmin.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_BillingShippingAddressAdmin.getAllShipmentTypesURL
String
Get All Shipment types service URL.
eb_BillingShippingAddressAdmin.getCompanyAddressService
String
GET company's custom address service.
eb_BillingShippingAddressAdmin.getCompanyProfileAddressService
String
GET company's profile address service.
eb_BillingShippingAddressAdmin.getCountriesService
String
GET service to get all countries records.
eb_BillingShippingAddressAdmin.getProvinceService
String
GET service to get all State/Province record.
eb_BillingShippingAddressAdmin.newAddressService
String
GET new address service.
eb_BillingShippingAddressAdmin.orderReviewUrl
String
Redirect to review order Page.
eb_BillingShippingAddressAdmin.selectedAddress
String
Redirect to billing or shipping address
eb_BillingShippingAddressAdmin.ServicePath
String
The path to the eBusiness SOA layer.
eb_BillingShippingAddressAdmin.shippingAddress
String
Shipping Address
eb_BillingShippingAddressAdmin.SitePath
String
Control level setting: Site path.
eb_BillingShippingAddressAdmin.skipPageRedirection
Bool
skipPageRedirection
eb_BillingShippingAddressAdmin.TemplatePath
String
Control level setting Template path.
eb_BillingShippingAddressAdmin.updateCompanyAddressService
String
Update company's custom address service.
eb_BillingShippingAddressAdmin.updateCompanyProfileAddressService
String
Update company's profile address service.