Site:Frontend:HDFObjects
From Metrixstream
(Redirected from Site:HDFObjects)
HDF Objects consist key/value pairs of information. This information comes from a Backend Query and is able to be referenced by the Frontend using the Clearsilver templating language.
Below are some common objects that you should be familiar with while building your site pages.
Contents |
Content
- id
- This is the numerical id of this object.
- objtype
- This is set to "content".
- canonical_id
- This is the SEO friendly id for this object.
- extid
- This is an optional id used for 3rd party integration.
- review
- This is the state of this object's review.
- type
- This is the type of this object. Example: video
- title
- This is the title of this object.
- title_wb
- This is the title of this object with wordbreaks inserted.
- title_short
- This is the short version of the title of this object with an optional ellipsis at the end.
- description
- This is the description of this object.
- description_text
- This is a text only version of this description with all HTML removed.
- description_filtered
- This is a version of this object's description with certain 3rd party links transformed into object embeds. (Example: youtube links)
- orig_filename
- This is the original filename of this object.
- banner_url
- This is the banner image of this object. Each object can have up to 10 banner images.
- added
- This is the release date of this object in numerical date format. Each object can have up to 3 release dates.
- added_year
- This is the numerical year of this object's release date.
- added_month
- This is the numerical month of this object's release date.
- added_unixtimestamp
- This is the unix timestamp of this object's release date.
- view_count
- This is the view count of this object.
- favorite_count
- This is the favorite count of this object.
- comment_count
- This is the comment count of this object.
- rating_count
- This is the rating count of this object.
- rating_score
- This is the rating score of this object.
- rating_avgscore
- This is the average rating score of this object.
- credits_to_own
- This is the amount of credits necessary to purchase this object.
- hasEnoughCreditsToOwn
- This is a boolean value on whether the authenticated user has enough credits to purchase this object with credits.
- price
- This is the price of this object in real currency.
- photo_count
- This is the number of photos this object has.
- photos
- This is a list of photos belonging to this object.
- categories
- This is a list of category ids that belong to this object.
- tags
- This is a list of tags that belong to this object.
- labels
- This is a list of labels that belong to this object.
- owner
- This is the account that owns this object.
- user
- This is the user that owns this object.
- associations
- A list of associations along with the associated account.
- relationships.is
- A list of relationships that this object is along with the related content.
- relationships.has
- A list of relationships that this object has along with the related content.
- custom
- A list of custom fields manually created for this object type.
Account
- id
- This is the numerical id of this object.
- objtype
- This is set to "owner".
- verified
- This is whether or not this object's email address is verified.
- username
- This is the username of this object.
- review
- This is the state of this object's review.
- description
- This is the description of this object.
- description_text
- This is a text only version of this description with all HTML removed.
- description_filtered
- This is a version of this object's description with certain 3rd party links transformed into object embeds. (Example: youtube links)
- billing.first_name
- This is the first name of the billing entity of this object.
- billing.last_name
- This is the last name of the billing entity of this object.
- billing.address
- This is the address of the billing entity of this object.
- billing.address2
- This is the address2 of the billing entity of this object.
- billing.city
- This is the city of the billing entity of this object.
- billing.state
- This is the state of the billing entity of this object.
- billing.zip
- This is the zip of the billing entity of this object.
- billing.country
- This is the country of the billing entity of this object.
- phone
- This is the phone number of this object.
- This is the email address of this object.
- added
- This is the release date of this object in numerical date format.
- added_unixtimestamp
- This is the unix timestamp of this object's release date.
- is_online
- This determines of this object is online.
- view_count
- This is the view count of this object.
- favorite_count
- This is the favorite count of this object.
- comment_count
- This is the comment count of this object.
- rating_count
- This is the rating count of this object.
- rating_score
- This is the rating score of this object.
- rating_avgscore
- This is the average rating score of this object.
- activity
- This is the last activity date of this object in numberical date format.
- activity_unixtimestamp
- This is the unix timestamp of the last activity date of this object.
- activity_delta
- This is the number of seconds between now and the last activity date of this object.
- display_name
- This is the display name of this object.
- display_status
- This is the display status of this object.
- lang
- This is the preferred language of this object.
- sex
- This is the sex of this object.
- dob
- This is the unix timestamp of the date of birth of this object.
- location
- This is the current location of this object.
- hometown
- This is the hometown of this object.
- relationship
- This is the relationship status of this object.
- interests
- This is the current interests of this object.
- activities
- This is a list of favorite activies of this object.
- music
- This is a list of favorite music of this object.
- movies
- This is a list of favorite movies of this object.
- tv
- This is a list of favorite tv shows of this object.
- books
- This is a list of favorite books of this object.
- banner_url
- This is the banner image of this object. Each object can have up to 10 banner images.
- custom
- A list of custom fields manually created for this object type.
User
- id
- This is the numerical id of this object.
- objtype
- This is set to "user".
- verified
- This is whether or not this object's email address is verified.
- newsletter
- This is whether or not this object is interested in receiving a site newsletter.
- username
- This is the username of this object.
- review
- This is the state of this object's review.
- description
- This is the description of this object.
- description_text
- This is a text only version of this description with all HTML removed.
- description_filtered
- This is a version of this object's description with certain 3rd party links transformed into object embeds. (Example: youtube links)
- billing.first_name
- This is the first name of the billing entity of this object.
- billing.last_name
- This is the last name of the billing entity of this object.
- billing.address
- This is the address of the billing entity of this object.
- billing.address2
- This is the address2 of the billing entity of this object.
- billing.city
- This is the city of the billing entity of this object.
- billing.state
- This is the state of the billing entity of this object.
- billing.zip
- This is the zip of the billing entity of this object.
- billing.country
- This is the country of the billing entity of this object.
- phone
- This is the phone number of this object.
- This is the email address of this object.
- added
- This is the release date of this object in numerical date format.
- added_unixtimestamp
- This is the unix timestamp of this object's release date.
- is_online
- This determines of this object is online.
- view_count
- This is the view count of this object.
- favorite_count
- This is the favorite count of this object.
- comment_count
- This is the comment count of this object.
- rating_count
- This is the rating count of this object.
- rating_score
- This is the rating score of this object.
- rating_avgscore
- This is the average rating score of this object.
- activity
- This is the last activity date of this object in numberical date format.
- activity_unixtimestamp
- This is the unix timestamp of the last activity date of this object.
- activity_delta
- This is the number of seconds between now and the last activity date of this object.
- display_name
- This is the display name of this object.
- display_status
- This is the display status of this object.
- lang
- This is the preferred language of this object.
- sex
- This is the sex of this object.
- dob
- This is the unix timestamp of the date of birth of this object.
- location
- This is the current location of this object.
- hometown
- This is the hometown of this object.
- relationship
- This is the relationship status of this object.
- interests
- This is the current interests of this object.
- activities
- This is a list of favorite activies of this object.
- music
- This is a list of favorite music of this object.
- movies
- This is a list of favorite movies of this object.
- tv
- This is a list of favorite tv shows of this object.
- books
- This is a list of favorite books of this object.
- banner_url
- This is the banner image of this object. Each object can have up to 10 banner images.
- ppm_seconds
- The current number of pre-paid video minutes available to this object.
- credits
- The current number of pre-paid credits available to this object.
- banking.name
- The name of the bank of this object.
- banking.address
- The address of the bank of this object.
- banking.address2
- The address2 of the bank of this object.
- banking.city
- The city of the bank of this object.
- banking.state
- The state of the bank of this object.
- banking.zip
- The zip of the bank of this object.
- banking.country
- The country of the bank of this object.
- banking.account
- The account number of the bank of this object.
- banking.routing
- The routing number of the bank of this object.
- banking.swift
- The swift code of the bank of this object.
- banking.phone
- The phone of the bank of this object.
- banking.iban
- The IBAN number of the bank of this object.
Photo
All of these fields are available on the MS.activeContent.photos key. Otherwise, only the id, layout, and photo_url are available.
- id
- This is the id of the one of the photos of this object.
- title
- This is the title of one of the photos of this object.
- filename
- This is the filename of one of the photos of this object.
- width
- This is the widge of one of the photos of this object.
- height
- This is the height of one of the photos of this object.
- layout
- This is the layout position of this photo.
- photo_url
- This is the URL to this photo.
File
- id
- The numerical id of this object.
- name
- The name of this object.
- size
- The size in bytes of this object.
Page
- name
- The name of this object.
- protocol
- The required protocol to view this object.
Request
- uri
- The URI of the current request.
- host
- The hostname of the current request.
- protocol
- The protocol of the current request.
