The AffiliateViewModel is the primary view model that's used across the various affiliate views. It's used to generate the rendered views, as we as to help update affiliate information. This article will help you understand what's available to you in the view model.
The following pre-requisites will be necessary to accomplish the goals of this article:
- General understanding of template engines
- Familiarity with template languages
- Familiarity with ASP.NET MVC Razor
There are no tasks needed to get started with understanding this object.
The AffiliateViewModel object will contain all of the details of a single affiliate in your Hotcakes Commerce store.
The following table gives you details on the various members of the AffiliateViewModel object. The descriptions are based upon default functionality and the default Viewset included with Hotcakes.
The address line of the street address, such as 123 Main Street.
|AgreementText||String||Agreement text needs to be shown to end user.|
|AllowReferral||Bool||Used to determine whether referrals are allowed for this affiliate or not.|
|Approved||Bool||Flag which indicates whether affiliate has been approved or not.|
|City||String||The name of the city.|
|Company||String||If this is not a individual customer, a company name should be specified.|
|ConfirmPassword||String||Confirmation value of the desired password|
|ConfirmTerms||Bool||Checkbox to confirm the terms|
|Countries||List<Country>||List of the countries needs to be shown on view|
|CountryId||String||This should container valid country id|
|String||E-mail address of the affiliate.|
|FirstName||String||The first name of the affiliate|
|Id||Long||The unique ID for the affiliate|
|LastName||String||The last name or surname of the affiliate.|
|MyAffiliateId||String||User friendly/readable ID for the affiliate|
|Password||String||Value used as the password to login using the affiliate account|
|Phone||String||A telephone number for the affiliate.|
|PostalCode||String||Contains the zip or postal code of the address, as necessary.|
|ReferralAffiliateId||String||If another affiliate referred the current affiliate applicant, the referring affiliate ID should be here.|
|Regions||List<Region>||List of valid regions needs to be shown on view|
|State||String||The name of the state.|
|UserId||Int||Current logged in customer id|
|Username||String||Current logged in customer username|