page.face

Name : page

Type : Map

Name : menu

Type : Map

blog-list.face

Name : page

Type : Map

Name : menu

Type : Map

Name : blog_posts

Type : List

Name : blog_categories

Type : List

Name : blog_tags

Type : List

Name : blog_authors

Type : List

blog-post.face

Name : page

Type : Map

Name : menu

Type : map

Name : blog_post

Type : Map

Name : blog_category

Type : Map

Name : blog_tags

Type : List

Name : blog_authors

Type : List

page

Type : Map

page.site_id

Type : long

Returns the unique ID of the site.

page.primary_domain

Type : String

Returns the primary domain of the site, if primary domain exists.

page.id

Type : long

Returns the unique ID of the page.

page.type

Type : int

Returns the type of the page.

page.url

Type : String

Returns the URL of the page.

page.title

Type : String

Returns the title of the page.

page.site_title

Type : String

Returns the title of the site.

page.site_caption

Type : String

Returns the caption of the site.

page.meta_tags

Type : String

Returns a String which contains the meta tag for the site.

page.is_title_enabled

Type : boolean

Returns a true/false value indicating if the title is enabled for the site.

page.is_caption_enabled

Type : boolean

Returns a true/false value indicating if caption is enabled for the site.

page.is_logo_enabled

Type : boolean

Returns a true/false value indicating if logo is enabled for the site.

page.is_sidebar_enabled

Type : boolean

Returns a true/false value indicating if sidebar is enabled for the site.

page.is_banner_enabled

Type : boolean

Returns a true/false value indicating if banner is enabled for the site.

page.is_custom_banner_enabled

Type : boolean

Returns a true/false value indicating if custom banner is enabled for the site.

page.is_search_enabled

Type : boolean

Returns a true/false value indicating if search is enabled for the site.

page.search_url

Type : String

Returns the search URL for the site.

page.primary_search

Type : String

Returns the primary search.

page.is_social_icon_enabled

Type : boolean

Returns a true/false value indicating if social icons are enabled.

page.is_contact_information_enabled

Type : boolean

Returns a true/false value indicating if contact information is enabled.

page.is_breadcrumb_enabled

Type : boolean

Returns a true/false value indicating if breadcrumb is enabled.

page.is_menu_enabled

Type : boolean

Returns a true/false value if menu is enabled.

page.is_footer_enabled

Type : boolean

Returns a true/false value if footer is enabled.

page.email_id

Type : String

Returns a String containing the email ID, if it is specified in your site settings.

page.phone_number

Type : String

Returns a String containing the phone number, if is specified in your site settings.

page.social_icons_order

Type : List of Strings

Returns a list of Strings which contain the order of social icons for the site.

page.social_icons_list

Type : Map of data

Returns a Map of social icons and their respective URLs.

page.custom_social_profiles

Type : List

--.

page.header_code

Type : String

Returns the header code for the site.

page.footer_code

Type : String

Returns the footer code for the site.

page.custom_css

Type : String

Returns custom CSS for the site, if there is any.

page.stylesheets

Type : String

Returns the tag containing the style sheets for the site.

page.scripts

Type : String

Returns the scripts used in the site.

page.template_assets

Type : String

Returns the template assets used in the site.

Type : Map of logo

Returns the logo details of the site.

page.banner

Type : String

Returns the banner content of the site.

page.sidebar_content

Type : String

Returns the sidebar content of the site.

page.footer_content

Type : String

Returns the footer content of the site.

page.is_portal_enabled

Type : boolean

Returns a true/false value indicating if the member portal is enabled for the site.

page.content

Type : String

Returns the content of the site.

page.breadcrumbs

Type : List of breadcrumb

Returns the breadcrumb details of the site.

page.form_code

Type : String

Returns the URL for authenticating the i-frame.

page.is_portal_signup_enabled

Type : boolean

Returns a true/false value indicating if site sign up is enabled.

page.stock_images

Type : String

Returns stock image URLs for the site.

page.signup_settings

Type : Map of signup_settings

Returns the fields enabled for sign up settings in a Map.

page.blog_page_no

Type : int

Returns the page number for the current blog.

page.blog_posts_per_page

Type : int

Returns the number of blog posts per page.

page.blog_summary_view

Type : boolean

Returns a true/false value indicating if blog summary is enabled.

page.blog_next_page

Type : int

Returns the page number of the next blog.

page.blog_prev_page

Type : int

Returns the page number of the previous blog.

page.blog_next_page_url

Type : String

Returns the URL of the next blog page.

page.blog_prev_page_url

Type : String

Returns the URL of the previous blog page.

page.blog_post_count

Type : int

Returns the number of blog posts.

page.blog_page_count

Type : int

Returns the number of blog pages.

page.blog_view_type

Type : String

Returns the type of blog view, the values being- 'page_view','category_view','tag_view','author_view', and 'post_view'

page.blog_view_entity_url

Type : String

Returns the URL for the blog view.

page.blog_pagination_url

Type : String

Returns the pagination URL of the blog.

page.blog_feed_url

Type : String

Returns the feed URL of the blog.

page.template_vars

Type : Map of template_vars

Returns the default variables of the template on a Map.

page.is_portal_user_allowed

Type : boolean

Returns a true/false value indicating if a portal user is allowed.

page.show_cart_icon

Type : boolean

Returns a true/false value indicating if the cart icon should be shown.

page.top_band_content

Type : String

--.

page.portal_signup_uri

Type : String

--.

page.is_multi_currency_enabled

Type : boolean

--.

page.is_sorting_enabled

Type : boolean

--.

page.is_specification_enabled

Type : boolean

--.

page.type_name

Type : String

--.

page.breadcrumb_level

Type : int

--.

page.is_header_enabled

Type : boolean

--.

page.after_body_scripts

Type : String

--.

page.is_coupon_enabled

Type : boolean

--.

page.is_checkout_tax_enabled

Type : boolean

--.

page.is_delivery_location_enabled

Type : boolean

--.

page.is_multi_warehouse_enabled

Type : boolean

--.

page.language

Type : String

--.

page.language_name

Type : String

--.

page.language_list

Type : List of language_list

Returns a list of languages.

page.html_tag_attributes

Type : String

--.

page.schemas

Type : Map

--.

page.is_rtl

Type : boolean

--.

page.is_powered_by_zoho_enabled

Type : boolean

--.

page.page_name

Type : String

--.

page.commentbox_rating

Type : Map

--.

page.portal_page_type

Type : int

--.

page.is_home_page

Type : boolean

--.

page.is_subsite

Type : boolean

--.

language_list

Type : Map

language_list.language

Type : String

--.

language_list.language_code

Type : String

--.

language_list.path

Type : String

--.

language_list.is_default

Type : boolean

--.

breadcrumb

Type : Map

Type : String

Retuns the name of the breadcrumb.

Type : String

Retuns the URL of the breadcrumb.

Type : boolean

Retuns a true/false value indicating if the current breadcrumb is selected.

menu

Type : Map

Type : List of menu_item

Returns a list of menu items.

menu_item

Type : Map

Type : long

Returns the unique ID of the menu.

Type : long

Returns the unique ID of the menu item.

Type : int

Returns the menu item type, the possible values being 0-ROOT, 1-RESOURCE, 2-MENU_GROUP, 3-EXTERNAL, 4-CATEGORY, 5-ANCHOR, 6-MEGA_MENU_ROW, 7-MEGA_MENU_COLUMN, 8-TEXT

Type : String

Returns the name of the menu item.

Type : String

Returns the URL of the menu item.

Type : long

Returns the unique ID of the resource.

Type : long

Returns the unique ID of the menu.

Type : long

Returns the unique ID of the menu category.

Type : int

Returns the resource type.

Type : int

Returns the sequence number of the menu item.

Type : Date

Returns the created time of the menu item.

Type : long

Returns the parent ID of the menu item.

menu_item.page_type

Type : int

Returns the page type of the menu item, the values being 0-NORMAL, 1-BLOG, 2-LINK, 3-FOLDER, -1-PAGE_404, -2-SEARCH, -3-PROTECTED, -4-PORTAL

Type : boolean

Returns a true/false value indicating if the menu item is hidden.

Type : boolean

Returns a true/false value indicating if the current menu item is the target.

Type : String

Returns the anchor name of the menu item.

Type : boolean

--.

Type : Map

Returns map with values like mega menu - menu split ratio, mega menu column layout and so on.

Type : Map

Returns map with values like if highlighting enabled, highlighting style and so on.

Type : Map

Returns map with values like icon id, if icon enabled and so on.

Type : long

Return id of the mega menu that is linked to current menu.

Type : int

--.

Type : String

--.

Type : boolean

--.

Type : boolean

--.

Type : String

--.

blog_posts

Type : List of blog_post

blog_post

Type : Map

blog_post.post_id

Type : long

Returns the unique post ID of the blog post.

blog_post.post_title

Type : String

Returns the blog post title.

blog_post.post_url

Type : String

Returns the blog post URL.

blog_post.description

Type : String

Returns the description of the blog post.

blog_post.post_image

Type : String

Returns the image URL of the blog post.

blog_post.post_author

Type : long

Returns the post author's ID.

blog_post.post_created_time

Type : String

--.

blog_post.post_created_time_gmt

Type : String

--.

blog_post.post_published_time

Type : String

Returns the time when the post was published.

blog_post.post_scheduled_time

Type : String

Returns the time when the blog post is scheduled to be posted.

blog_post.rss_published_time

Type : String

Returns the published time of the RSS feed.

blog_post.post_published_time_gmt

Type : String

Returns the time in which the post was published in GMT.

blog_post.publish_status

Type : int

Returns the published status of the post, the values being 0-POST_DRAFT, 1-POST_PUBLISHED, 2-POST_SCHEDULED, 3-POST_REVISED

blog_post.publish_type

Type : String

Returns the publish type for the post, values being 'draft', 'publish' and 'future'.

blog_post.summary

Type : String

Returns the summary of the blog post.

blog_post.summary_image

Type : String

Returns the summary image URL of the blog post.

blog_post.content

Type : String

Returns the content of the blog post.

blog_post.category

Type : Map of category

Returns the category of the blog post in a Map.

blog_post.tags

Type : List of blog_post_tag

Returns the tags of the blog post in a List.

blog_post.author

Type : Map of author

Returns the author details of the blog post.

blog_post.is_social_share_enabled

Type : boolean

Returns a true/false value indicating if social share is enabled.

blog_post.social_share_options

Type : Map of social_share_options

Returns the social share options in a Map.

social_share_options

Type : Map

social_share_options.align

Type : String

Returns the alignment.

social_share_options.style

Type : String

Returns the style.

social_share_options.show_count

Type : String

Returns the count of posts to show.

blog_categories

Type : List of blog_category

blog_category

Type : Map

blog_category.resource_id

Type : long

Returns the unique resource ID of the blog category.

blog_category.category_name

Type : String

Returns the name of the category.

blog_category.category_url

Type : String

Returns the URL of the category.

blog_category.seo

Type : Map of seo

--.

blog_category.published_post_count

Type : String

--.

blog_tags

Type : List of blog_tag

blog_tag

Type : Map

blog_tag.resource_id

Type : long

Returns the unique resource ID.

blog_tag.tag_name

Type : String

Returns the name of the tag.

blog_tag.tag_url

Type : String

Returns the URL of the tag.

blog_tag.seo

Type : Map of seo

--.

blog_tag.published_post_count

Type : String

Returns the publish post count.

blog_authors

Type : List of blog_author

blog_author

Type : Map

blog_author.resource_id

Type : long

Returns the unique resource ID.

blog_author.published_post_count

Type : String

Returns the published post count.

blog_author.mapping_author_id

Type : long

Returns the Mapping author ID.

blog_author.mapping_resource_id

Type : long

Returns the Mapping resource ID.

blog_author.author_id

Type : long

Returns the unique ID of the author.

blog_author.author_name

Type : String

Returns the name of the author.

blog_author.author_url

Type : String

Returns the URL of the author.

author

Type : Map

author.author_id

Type : long

Returns the unique ID of the author.

author.iam_user_id

Type : long

--.

author.author_name

Type : String

Returns the name of the author.

author.author_url

Type : String

Returns the URL of the author.

author.job_title

Type : String

--.

author.website_url

Type : String

--.

author.company

Type : String

--.

author.biography

Type : String

--.

author.profile_image_resource_id

Type : long

--.

author.thumbnail_image_resource_id

Type : long

--.

author.thumbnail_image_path

Type : String

--.

author.profile_image_path

Type : String

--.

blog_post_tag

Type : Map

blog_post_tag.post_id

Type : long

Returns the unique post ID.

blog_post_tag.tag_id

Type : long

Returns the unique tag ID.

blog_post_tag.tag_name

Type : String

Returns the name of the tag.

blog_post_tag.tag_url

Type : String

Returns the URL of the tag.

bread_crumb

Type : Map

Type : String

Returns the name of the breadcrumb.

Type : String

Returns the URL of the breadcrumb.

Type : boolean

Returns a true/false value indicating if the breadcrumb is selected.

document

Type : Map

document.document_id

Type : long

Returns the unique document ID.

document.name

Type : String

Returns the name of the document.

Type : boolean

Returns a true/false value indicating if the document is featured.

document.attachment_order

Type : int

Returns the attachment order of the document.

document.alter_text

Type : String

--.

seo

Type : Map

seo.description

Type : String

Returns the SEO description.

seo.keyword

Type : String

Returns the SEO keywords.

seo.title

Type : String

Returns the SEO title.

image

Type : Map

image.id

Type : long

Returns the unique ID of the image.

image.url

Type : String

Returns the URL of the image.

image.alternate_text

Type : String

Returns the alternate text for the image.

image.order

Type : int

Returns the order of the image.

Type : boolean

Returns a true/false value indicating if the image is featured.

image.is_placeholder_image

Type : boolean

Returns a true/false value indicating if the image is a placeholder image.

image.title

Type : String

--.

org_meta

Type : Map

org_meta.org_version

Type : String

--.

org_meta.support_email_id

Type : String

--.

org_meta.country_code

Type : String

--.