Telligent Community
Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Telligent Community 10.x
  • Verint Community
  • More
Telligent Community 10.x
API Documentation $core_v2_page Widget Extension
  • Ask the Community
  • User Documentation
  • API Documentation
  • Manager Training
  • Developer Training
  • Tags
  • More
  • Cancel
  • New
  • API Documentation
  • +In-Process API Documentation
  • +Plugin API Documentation
  • +REST API Documentation
  • -Widget API Documentation
    • +JavaScript API Documentation
    • +Widget Associated Types
    • -Widget Extensions
      • $calendar_v1_calendars Widget Extension
      • $calendar_v1_events Widget Extension
      • $calendar_v1_permissions Widget Extension
      • $calendar_v1_registrations Widget Extension
      • $calendar_v1_resources Widget Extension
      • $calendar_v1_UI Widget Extension
      • $calendar_v1_urls Widget Extension
      • $context_v2_propertyTemplate Widget Extension
      • $context_v2_themeBody Widget Extension
      • $context_v2_themeHeader Widget Extension
      • $core_v2_abuseAppeal Widget Extension
      • $core_v2_abuseReport Widget Extension
      • $core_v2_abusiveContent Widget Extension
      • $core_v2_achievement Widget Extension
      • $core_v2_achievementSummary Widget Extension
      • $core_v2_activityStory Widget Extension
      • $core_v2_activityStorySitePreference Widget Extension
      • $core_v2_activityStoryUserPreference Widget Extension
      • $core_v2_apiKey Widget Extension
      • $core_v2_application Widget Extension
      • $core_v2_applicationMerge Widget Extension
      • $core_v2_applicationSubscription Widget Extension
      • $core_v2_applicationType Widget Extension
      • $core_v2_authentication Widget Extension
      • $core_v2_authorQualityScore Widget Extension
      • $core_v2_blog Widget Extension
      • $core_v2_blogConfiguration Widget Extension
      • $core_v2_blogPermissions Widget Extension
      • $core_v2_blogPost Widget Extension
      • $core_v2_blogPostSummary Widget Extension
      • $core_v2_blogUrls Widget Extension
      • $core_v2_bookmark Widget Extension
      • $core_v2_calculatedScores Widget Extension
      • $core_v2_cfs Widget Extension
      • $core_v2_comments Widget Extension
      • $core_v2_commentVotes Widget Extension
      • $core_v2_configuration Widget Extension
      • $core_v2_container Widget Extension
      • $core_v2_containerType Widget Extension
      • $core_v2_content Widget Extension
      • $core_v2_contentConversion Widget Extension
      • $core_v2_contentPresence Widget Extension
      • $core_v2_contentQualityScore Widget Extension
      • $core_v2_contentRecommendation Widget Extension
      • $core_v2_contentSubscribers Widget Extension
      • $core_v2_contentSubscription Widget Extension
      • $core_v2_contentType Widget Extension
      • $core_v2_contentViews Widget Extension
      • $core_v2_conversation Widget Extension
      • $core_v2_conversationMessage Widget Extension
      • $core_v2_customNavigation Widget Extension
      • $core_v2_customPage Widget Extension
      • $core_v2_dynamicForm Widget Extension
      • $core_v2_editableGroup Widget Extension
      • $core_v2_editor Widget Extension
      • $core_v2_emailDigest Widget Extension
      • $core_v2_emoticon Widget Extension
      • $core_v2_encoding Widget Extension
      • $core_v2_eventLog Widget Extension
      • $core_v2_follower Widget Extension
      • $core_v2_following Widget Extension
      • $core_v2_forum Widget Extension
      • $core_v2_forumConfiguration Widget Extension
      • $core_v2_forumPermissions Widget Extension
      • $core_v2_forumReply Widget Extension
      • $core_v2_forumReplyVote Widget Extension
      • $core_v2_forumThread Widget Extension
      • $core_v2_forumThreadVote Widget Extension
      • $core_v2_forumUrls Widget Extension
      • $core_v2_friendship Widget Extension
      • $core_v2_gallery Widget Extension
      • $core_v2_group Widget Extension
      • $core_v2_groupAuthorQualityScore Widget Extension
      • $core_v2_groupContactRequest Widget Extension
      • $core_v2_groupPermissions Widget Extension
      • $core_v2_groupRoleMember Widget Extension
      • $core_v2_groupUrls Widget Extension
      • $core_v2_groupUserMember Widget Extension
      • $core_v2_hashTag Widget Extension
      • $core_v2_infoResult Widget Extension
      • $core_v2_language Widget Extension
      • $core_v2_ldapGroups Widget Extension
      • $core_v2_ldapUsers Widget Extension
      • $core_v2_leader Widget Extension
      • $core_v2_leaderboard Widget Extension
      • $core_v2_leaderboardUrls Widget Extension
      • $core_v2_like Widget Extension
      • $core_v2_likedItem Widget Extension
      • $core_v2_media Widget Extension
      • $core_v2_mediaConfiguration Widget Extension
      • $core_v2_mediaPermissions Widget Extension
      • $core_v2_mediaUrls Widget Extension
      • $core_v2_mention Widget Extension
      • $core_v2_mentionable Widget Extension
      • $core_v2_message Widget Extension
      • $core_v2_moderationTemplates Widget Extension
      • $core_v2_nodePermission Widget Extension
      • $core_v2_notification Widget Extension
      • $core_v2_notificationCategory Widget Extension
      • $core_v2_notificationDistributionType Widget Extension
      • $core_v2_notificationType Widget Extension
      • $core_v2_notificationUserPreference Widget Extension
      • $core_v2_oauthClient Widget Extension
      • $core_v2_page Widget Extension
      • $core_v2_permission Widget Extension
      • $core_v2_pointTransaction Widget Extension
      • $core_v2_poll Widget Extension
      • $core_v2_ratedItem Widget Extension
      • $core_v2_rating Widget Extension
      • $core_v2_recaptcha Widget Extension
      • $core_v2_role Widget Extension
      • $core_v2_roleUsers Widget Extension
      • $core_v2_rssFeedItem Widget Extension
      • $core_v2_search Widget Extension
      • $core_v2_searchCategory Widget Extension
      • $core_v2_searchResult Widget Extension
      • $core_v2_servicePresence Widget Extension
      • $core_v2_sitePermissions Widget Extension
      • $core_v2_statusMessage Widget Extension
      • $core_v2_submittableEditor Widget Extension
      • $core_v2_systemNotification Widget Extension
      • $core_v2_taggedContent Widget Extension
      • $core_v2_tags Widget Extension
      • $core_v2_theme Widget Extension
      • $core_v2_themeFooter Widget Extension
      • $core_v2_themeHeader Widget Extension
      • $core_v2_themePage Widget Extension
      • $core_v2_tourTip Widget Extension
      • $core_v2_ui Widget Extension
      • $core_v2_uploadedFile Widget Extension
      • $core_v2_urls Widget Extension
      • $core_v2_user Widget Extension
      • $core_v2_userAchievement Widget Extension
      • $core_v2_userFile Widget Extension
      • $core_v2_userFolder Widget Extension
      • $core_v2_userInvitation Widget Extension
      • $core_v2_userPermission Widget Extension
      • $core_v2_userPresence Widget Extension
      • $core_v2_userProfileField Widget Extension
      • $core_v2_userProfileFieldGroup Widget Extension
      • $core_v2_userRecommendation Widget Extension
      • $core_v2_userValidation Widget Extension
      • $core_v2_utility Widget Extension
      • $core_v2_webhook Widget Extension
      • $core_v2_webhookEvent Widget Extension
      • $core_v2_widget Widget Extension
      • $core_v2_wiki Widget Extension
      • $core_v2_wikiConfiguration Widget Extension
      • $core_v2_wikiFiles Widget Extension
      • $core_v2_wikiPage Widget Extension
      • $core_v2_wikiPageCommentSubscriptions Widget Extension
      • $core_v2_wikiPageRevision Widget Extension
      • $core_v2_wikiPermissions Widget Extension
      • $core_v2_wikiToc Widget Extension
      • $core_v2_wikiUrls Widget Extension
      • $core_v3_feature Widget Extension
      • $geocoding_v1_core Widget Extension
      • $km_v1_categories Widget Extension
      • $km_v1_documents Widget Extension
      • $km_v1_knowledgeCollections Widget Extension
      • $km_v1_permissions Widget Extension
      • $km_v1_tags Widget Extension
      • $km_v1_urls Widget Extension
      • $telligentIdeas_v1_challenges Widget Extension
      • $telligentIdeas_v1_ideaCategories Widget Extension
      • $telligentIdeas_v1_ideaPermissions Widget Extension
      • $telligentIdeas_v1_ideas Widget Extension
      • $telligentIdeas_v1_ideaStatuses Widget Extension
      • $telligentIdeas_v1_statuses Widget Extension
      • $telligentIdeas_v1_urls Widget Extension
      • $telligentIdeas_v1_userVoteSummaries Widget Extension
      • $telligentIdeas_v1_votes Widget Extension

$core_v2_page Widget Extension


Enables scripted content fragments to get page information and set the page title.

Properties

NameTypeDescriptionDefaultOptions
IpAddressstringIP address of current request
IsAuthorizationboolReturns true if the current URL is rendering authorization content.
IsInThemePreviewModeboolReturns true if the theme is being previewed
IsModalboolReturns true if the current URL is rendering a modal.
IsPostboolReturns true if the current request was made via POST
LayoutstringCurrent Layout
ReturnUrlstringURL specified by the 'returnUrl' query string parameter
SupportsJavaScriptboolWhether or not JavaScript is known to be supported by the requesting browser
ThemeNamestringCurrent Theme Name
ThemeTypeIdGuidCurrent Theme Type
UrlstringCurrent URL

Methods

AbsoluteUrl

Current Absolute URL

Usage

#set($stringResponse = $core_v2_page.AbsoluteUrl($url))

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringUrlRequired

Return Type

string

AddAtomLink

Adds an Atom 1.0 autodiscoverale link to the header

Usage

$core_v2_page.AddAtomLink($title, $href)

Parameters

NameTypeDescriptionRequiredDefaultOptions
titlestringTitleRequired
hrefstringHrefRequired

AddLink

Adds a new link tag to the header.

Usage

$core_v2_page.AddLink($rel, $href)

Parameters

NameTypeDescriptionRequiredDefaultOptions
relstringRelRequired
hrefstringHrefRequired

AddLink

Adds a new link tag to the header. Options will be added as HTML attributes

Usage

$core_v2_page.AddLink($rel, $href, "%{Position = $positionArg}")

Parameters

NameTypeDescriptionRequiredDefaultOptions
relstringRelRequired
hrefstringHrefRequired
PositionPosition at which the link will be rendered within the headingOptionalBeforeThemeAfterTheme, BeforeTheme

AddMetaDescription

Adds a description meta tag to the header

Usage

$core_v2_page.AddMetaDescription($value)

Parameters

NameTypeDescriptionRequiredDefaultOptions
valuestringValueRequired

AddMetaKeywords

Adds a keyword meta tag to the header

Usage

$core_v2_page.AddMetaKeywords($value)

Parameters

NameTypeDescriptionRequiredDefaultOptions
valuestringValueRequired

AddMetaTag

Adds a meta tag to the header

Usage

$core_v2_page.AddMetaTag($key, $value)

Parameters

NameTypeDescriptionRequiredDefaultOptions
keystringKeyRequired
valuestringValueRequired

AddOpenGraphMetaTag

Adds an Open Graph meta tag to the header

Usage

$core_v2_page.AddOpenGraphMetaTag($property, $content)

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertystringPropertyRequired
contentstringContentRequired

AddOpenGraphNamespace

Adds an Open Graph namespace to the header

Usage

$core_v2_page.AddOpenGraphNamespace($prefix, $uri)

Parameters

NameTypeDescriptionRequiredDefaultOptions
prefixstringPrefixRequired
uristringUriRequired

AddRssLink

Adds a RSS 2.0 autodiscoverable link to the header

Usage

$core_v2_page.AddRssLink($title, $href)

Parameters

NameTypeDescriptionRequiredDefaultOptions
titlestringTitleRequired
hrefstringHrefRequired

AdjustQueryString

Merges and appends a new querystring with an existing URL

Usage

#set($stringResponse = $core_v2_page.AdjustQueryString($url, $queryString))

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringUrlRequired
queryStringstringQuery StringRequired

Return Type

string

AdjustTarget

Adjusts the hash target of a URL

Usage

#set($stringResponse = $core_v2_page.AdjustTarget($url, $target))

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringUrlRequired
targetstringTargetRequired

Return Type

string

ApplicationEscapeUrl

Escapes a URL to be relative to the application.

Usage

#set($stringResponse = $core_v2_page.ApplicationEscapeUrl($url))

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringUrlRequired

Return Type

string

ApplicationUnescapeUrl

Unescapes a URL from being relative to the application.

Usage

#set($stringResponse = $core_v2_page.ApplicationUnescapeUrl($url))

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringUrlRequired

Return Type

string

EnsureSecureConnection

If not already on HTTPS, redirects to the HTTPS version of the current URL

Usage

$core_v2_page.EnsureSecureConnection()

EnsureSecureConnection

If not already on HTTPS, redirects to the HTTPS version of the current URL

Usage

$core_v2_page.EnsureSecureConnection("%{IsAuthenticatingUser = $isAuthenticatingUserArg}")

Parameters

NameTypeDescriptionRequiredDefaultOptions
IsAuthenticatingUserboolIs Authenticating UserOptionalFalse

GetCookieValue

Gets a cookie value

Usage

#set($stringResponse = $core_v2_page.GetCookieValue($cookieKey))

Parameters

NameTypeDescriptionRequiredDefaultOptions
cookieKeystringCookie KeyRequired

Return Type

string

GetCookieValue

Gets a cookie value

Usage

#set($stringResponse = $core_v2_page.GetCookieValue($cookieKey, "%{cookieName = $cookieNameArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
cookieKeystringCookie KeyRequired
cookieNamestringCookie NameOptional

Return Type

string

GetFormValue

Gets a post value

Usage

#set($stringResponse = $core_v2_page.GetFormValue($name))

Parameters

NameTypeDescriptionRequiredDefaultOptions
namestringPosted value keyRequired

Return Type

string

GetFormValues

Gets all post values matching a key

Usage

#set($string[]Response = $core_v2_page.GetFormValues($name))

Parameters

NameTypeDescriptionRequiredDefaultOptions
namestringPosted value keyRequired

Return Type

string[]

GetQueryStringValue

Gets a query string value

Usage

#set($stringResponse = $core_v2_page.GetQueryStringValue($name))

Parameters

NameTypeDescriptionRequiredDefaultOptions
namestringQuery string keyRequired

Return Type

string

GetQueryStringValues

Gets all query string values matching a key

Usage

#set($string[]Response = $core_v2_page.GetQueryStringValues($name))

Parameters

NameTypeDescriptionRequiredDefaultOptions
namestringQuery string keyRequired

Return Type

string[]

MakeQueryString

Converts a basic set of keys and values into a specialized query string set of keys and values

Usage

#set($queryStringResponse = $core_v2_page.MakeQueryString())

Return Type

QueryString

ParseQueryString

Parses a query string into a specialized set of keys and values

Usage

#set($queryStringResponse = $core_v2_page.ParseQueryString($queryString))

Parameters

NameTypeDescriptionRequiredDefaultOptions
queryStringstringQuery StringRequired

Return Type

QueryString

Redirect

Redirects the current request via an HTTP 302 response

Usage

$core_v2_page.Redirect($url)

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringUrlRequired

RedirectToHashedQuery

Redirects to a modified URL with the query string embedded as a hash target

Usage

$core_v2_page.RedirectToHashedQuery($url)

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringUrlRequired

RedirectToHashedQuery

Redirects from the current URL to a modified URL with the query string embedded as a hash target

Usage

$core_v2_page.RedirectToHashedQuery()

RenderPlatformHeaders

Renders HTML headers, including platform-defined CSS and JavaScript

Usage

#set($stringResponse = $core_v2_page.RenderPlatformHeaders())

Return Type

string

RenderPlatformHeaders

Renders HTML headers, including platform-defined CSS and JavaScript

Usage

#set($stringResponse = $core_v2_page.RenderPlatformHeaders("%{IsModal = $isModalArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
IsModalboolWhen true, renders the configured headers for modalsOptionalFalse

Return Type

string

RenderThemeHeaders

Renders configured theme HTML headers, including platform-defined and theme-defined CSS and JavaScript

Usage

#set($stringResponse = $core_v2_page.RenderThemeHeaders("%{IsModal = $isModalArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
IsModalboolWhen true, renders the configured headers for modalsOptionalFalse

Return Type

string

RenderThemeHeaders

Renders configured theme HTML headers, including platform-defined and theme-defined CSS and JavaScript

Usage

#set($stringResponse = $core_v2_page.RenderThemeHeaders())

Return Type

string

SendJsonError

Formats error messages as JSON and responds with a JSON content type

Usage

$core_v2_page.SendJsonError($errors)

Parameters

NameTypeDescriptionRequiredDefaultOptions
errorsIList<Error>ErrorsRequired

SendJsonError

Formats an error message as JSON and responds with a JSON content type

Usage

$core_v2_page.SendJsonError($errorMessage)

Parameters

NameTypeDescriptionRequiredDefaultOptions
errorMessagestringError MessageRequired

SendJsonError

Formats error messages as JSON and responds with a JSON content type

Usage

$core_v2_page.SendJsonError($errorMessages)

Parameters

NameTypeDescriptionRequiredDefaultOptions
errorMessagesIList<string>Error MessagesRequired

SetCanonicalLink

Overrides the default canonical Url defined for the page.

Usage

$core_v2_page.SetCanonicalLink($uri)

Parameters

NameTypeDescriptionRequiredDefaultOptions
uristringUriRequired

SetContentType

Sets the content type on the current HTTP response

Usage

$core_v2_page.SetContentType($contentType)

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentTypestringContent TypeRequired

SetCookieValue

Sets a cookie value

Usage

$core_v2_page.SetCookieValue($cookieKey, $cookieValue, "%{CookieName = $cookieNameArg, HttpOnly = $httpOnlyArg}")

Parameters

NameTypeDescriptionRequiredDefaultOptions
cookieKeystringCookie KeyRequired
cookieValuestringCookie ValueRequired
CookieNamestringCookie NameOptional
HttpOnlyboolHttp OnlyOptional

SetCookieValue

Sets a cookie value

Usage

$core_v2_page.SetCookieValue($cookieKey, $cookieValue)

Parameters

NameTypeDescriptionRequiredDefaultOptions
cookieKeystringCookie KeyRequired
cookieValuestringCookie ValueRequired

SetStatusCode

Sets an explicit status code on the current HTTP response

Usage

$core_v2_page.SetStatusCode($code)

Parameters

NameTypeDescriptionRequiredDefaultOptions
codeintCodeRequired

SetTitle

Sets the page title

Usage

$core_v2_page.SetTitle($title, $includeContext, $includeSiteName)

Parameters

NameTypeDescriptionRequiredDefaultOptions
titlestringTitleRequired
includeContextboolWhether to include the current container nameRequired
includeSiteNameboolWhether to include the site nameRequired

SetXFrameOptions

Overrides the site-wide X-FRAME-OPTIONS HTTP header to remove the header

Usage

$core_v2_page.SetXFrameOptions()

SetXFrameOptions

Overrides the site-wide X-FRAME-OPTIONS HTTP header. Unsets the header when passed an empty string.

Usage

$core_v2_page.SetXFrameOptions($options)

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsstringOptionsRequired

  • Share
  • History
  • More
  • Cancel
Related
Recommended
  • Telligent
  • Professional Services
  • Submit a Support Ticket
  • Become a Partner
  • Request a Demo
  • Contact Us

About
Privacy Policy
Terms of use
Copyright 2021 Verint, Inc.
Powered by Verint Community