Verint | Telligent Community
Verint | Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Verint Community 12.x
  • Verint Community
Verint Community 12.x
API Documentation core_v2_encoding Script API
  • User Documentation
  • Ask the Community
  • API Documentation
  • Manager Training
  • Developer Training
  • Tags
  • More
  • Cancel
  • New
  • API Documentation
  • +In-Process API Documentation
  • +Plugin API Documentation
  • +REST API Documentation
  • -Widget, Theme, and Automation APIs
    • +Automation Events
    • +Client-side APIs
    • +Dynamic Configuration
    • +LESS Functions
    • +Script API Types
    • -Script APIs
      • articles_v1_articleCategories Script API
      • articles_v1_articleCollections Script API
      • articles_v1_articles Script API
      • articles_v1_articleTypes Script API
      • articles_v1_articleUrls Script API
      • articles_v1_articleVersionCategories Script API
      • articles_v1_articleVersions Script API
      • articles_v1_categories Script API
      • articles_v1_helpfulness Script API
      • articles_v1_helpfulnessResponseTypes Script API
      • articles_v1_permissions Script API
      • articles_v1_publishGroups Script API
      • articles_v1_subscriptionTypes Script API
      • calendar_v1_calendars Script API
      • calendar_v1_events Script API
      • calendar_v1_permissions Script API
      • calendar_v1_registrations Script API
      • calendar_v1_resources Script API
      • calendar_v1_UI Script API
      • calendar_v1_urls Script API
      • context_v2_automationState Script API
      • context_v2_automationTrigger Script API
      • context_v2_embeddable Script API
      • context_v2_propertyRule Script API
      • context_v2_propertyTemplate Script API
      • context_v2_scheduledFile Script API
      • context_v2_themeBody Script API
      • context_v2_themeHeader Script API
      • core_v1_reportingPermissions Script API
      • core_v1_reportingUrls Script API
      • core_v2_abuseAppeal Script API
      • core_v2_abuseReport Script API
      • core_v2_abusiveContent Script API
      • core_v2_achievement Script API
      • core_v2_achievementSummary Script API
      • core_v2_activityStory Script API
      • core_v2_activityStorySitePreference Script API
      • core_v2_activityStoryUserPreference Script API
      • core_v2_apiKey Script API
      • core_v2_application Script API
      • core_v2_applicationMerge Script API
      • core_v2_applicationSubscription Script API
      • core_v2_applicationType Script API
      • core_v2_authentication Script API
      • core_v2_authorQualityScore Script API
      • core_v2_automation Script API
      • core_v2_blog Script API
      • core_v2_blogConfiguration Script API
      • core_v2_blogPermissions Script API
      • core_v2_blogPost Script API
      • core_v2_blogPostSummary Script API
      • core_v2_blogUrls Script API
      • core_v2_bookmark Script API
      • core_v2_calculatedScores Script API
      • core_v2_captureThreadToArticle Script API
      • core_v2_cfs Script API
      • core_v2_comments Script API
      • core_v2_commentSummary Script API
      • core_v2_commentVotes Script API
      • core_v2_configuration Script API
      • core_v2_container Script API
      • core_v2_containerType Script API
      • core_v2_content Script API
      • core_v2_contentConversion Script API
      • core_v2_contentPresence Script API
      • core_v2_contentQualityScore Script API
      • core_v2_contentRecommendation Script API
      • core_v2_contentSubscribers Script API
      • core_v2_contentSubscription Script API
      • core_v2_contentType Script API
      • core_v2_contentViews Script API
      • core_v2_conversation Script API
      • core_v2_conversationMessage Script API
      • core_v2_customNavigation Script API
      • core_v2_customPage Script API
      • core_v2_dynamicForm Script API
      • core_v2_editableGroup Script API
      • core_v2_editor Script API
      • core_v2_email Script API
      • core_v2_emailDigest Script API
      • core_v2_emoticon Script API
      • core_v2_encoding Script API
      • core_v2_eventLog Script API
      • core_v2_exceptions Script API
      • core_v2_follower Script API
      • core_v2_following Script API
      • core_v2_forum Script API
      • core_v2_forumConfiguration Script API
      • core_v2_forumPermissions Script API
      • core_v2_forumReply Script API
      • core_v2_forumReplyVote Script API
      • core_v2_forumThread Script API
      • core_v2_forumThreadVote Script API
      • core_v2_forumUrls Script API
      • core_v2_friendship Script API
      • core_v2_gallery Script API
      • core_v2_group Script API
      • core_v2_groupAuthorQualityScore Script API
      • core_v2_groupContactRequest Script API
      • core_v2_groupPermissions Script API
      • core_v2_groupRoleMember Script API
      • core_v2_groupUrls Script API
      • core_v2_groupUserMember Script API
      • core_v2_hashTag Script API
      • core_v2_http Script API
      • core_v2_infoResult Script API
      • core_v2_language Script API
      • core_v2_ldapGroups Script API
      • core_v2_ldapUsers Script API
      • core_v2_leader Script API
      • core_v2_leaderboard Script API
      • core_v2_leaderboardUrls Script API
      • core_v2_like Script API
      • core_v2_likedItem Script API
      • core_v2_media Script API
      • core_v2_mediaConfiguration Script API
      • core_v2_mediaPermissions Script API
      • core_v2_mediaUrls Script API
      • core_v2_mention Script API
      • core_v2_mentionable Script API
      • core_v2_message Script API
      • core_v2_moderationTemplates Script API
      • core_v2_notification Script API
      • core_v2_notificationCategory Script API
      • core_v2_notificationDistributionType Script API
      • core_v2_notificationType Script API
      • core_v2_notificationUserPreference Script API
      • core_v2_oauthClient Script API
      • core_v2_page Script API
      • core_v2_permission Script API
      • core_v2_pointTransaction Script API
      • core_v2_poll Script API
      • core_v2_process Script API
      • core_v2_ratedItem Script API
      • core_v2_rating Script API
      • core_v2_reviewableContent Script API
      • core_v2_role Script API
      • core_v2_roleUsers Script API
      • core_v2_rssFeedItem Script API
      • core_v2_search Script API
      • core_v2_searchCategory Script API
      • core_v2_searchResult Script API
      • core_v2_servicePresence Script API
      • core_v2_sitePermissions Script API
      • core_v2_statusMessage Script API
      • core_v2_submittableEditor Script API
      • core_v2_systemNotification Script API
      • core_v2_taggedContent Script API
      • core_v2_tags Script API
      • core_v2_theme Script API
      • core_v2_themeFooter Script API
      • core_v2_themeHeader Script API
      • core_v2_themePage Script API
      • core_v2_tourTip Script API
      • core_v2_ui Script API
      • core_v2_uploadedFile Script API
      • core_v2_urls Script API
      • core_v2_user Script API
      • core_v2_userAchievement Script API
      • core_v2_userFile Script API
      • core_v2_userFolder Script API
      • core_v2_userInvitation Script API
      • core_v2_userPermission Script API
      • core_v2_userProfileField Script API
      • core_v2_userProfileFieldGroup Script API
      • core_v2_userRecommendation Script API
      • core_v2_userValidation Script API
      • core_v2_utility Script API
      • core_v2_webhook Script API
      • core_v2_webhookEvent Script API
      • core_v2_widget Script API
      • core_v2_wiki Script API
      • core_v2_wikiConfiguration Script API
      • core_v2_wikiFiles Script API
      • core_v2_wikiPage Script API
      • core_v2_wikiPageCommentSubscriptions Script API
      • core_v2_wikiPageRevision Script API
      • core_v2_wikiPermissions Script API
      • core_v2_wikiToc Script API
      • core_v2_wikiUrls Script API
      • core_v3_feature Script API
      • core_v3_permission Script API
      • telligentIdeas_v1_challenges Script API
      • telligentIdeas_v1_ideaCategories Script API
      • telligentIdeas_v1_ideaPermissions Script API
      • telligentIdeas_v1_ideas Script API
      • telligentIdeas_v1_ideaStatuses Script API
      • telligentIdeas_v1_statuses Script API
      • telligentIdeas_v1_urls Script API
      • telligentIdeas_v1_userVoteSummaries Script API
      • telligentIdeas_v1_votes Script API

core_v2_encoding Script API


Enables scripted content fragments to encode data for rendering.

  • HtmlAttributeEncode
  • HtmlDecode
  • HtmlEncode
  • HtmlEnsureEncoded
  • JavascriptEncode
  • SanitizeHtml
  • SearchEncode
  • UriEscape
  • UrlDecode
  • UrlDecodeFileComponent
  • UrlEncode

Methods

HtmlAttributeEncode

Encodes text for use within HTML or XML attributes

Velocity

#set($stringResponse = $core_v2_encoding.HtmlAttributeEncode($text))

JavaScript

var stringResponse = core_v2_encoding.HtmlAttributeEncode(text);

Parameters

NameTypeDescriptionRequiredDefaultOptions
textStringRaw textRequired

Returns

String

HtmlDecode

HTML-decodes text

Velocity

#set($stringResponse = $core_v2_encoding.HtmlDecode($html))

JavaScript

var stringResponse = core_v2_encoding.HtmlDecode(html);

Parameters

NameTypeDescriptionRequiredDefaultOptions
htmlStringHTML-encoded textRequired

Returns

String

HtmlEncode

HTML-encodes text. Note, most text properties on data returned by the Platform API is already pre-encoded.

Velocity

#set($stringResponse = $core_v2_encoding.HtmlEncode($text))

JavaScript

var stringResponse = core_v2_encoding.HtmlEncode(text);

Parameters

NameTypeDescriptionRequiredDefaultOptions
textStringRaw textRequired

Returns

String

HtmlEnsureEncoded

Ensures that text is HTML-encoded.

Velocity

#set($stringResponse = $core_v2_encoding.HtmlEnsureEncoded($text))

JavaScript

var stringResponse = core_v2_encoding.HtmlEnsureEncoded(text);

Parameters

NameTypeDescriptionRequiredDefaultOptions
textStringRaw textRequired

Returns

String

JavascriptEncode

JavascriptEncode Overload 1

Escapes text for use within JavaScript string literals or JSON values

Velocity

#set($stringResponse = $core_v2_encoding.JavascriptEncode($text))

JavaScript

var stringResponse = core_v2_encoding.JavascriptEncode(text);

Parameters

NameTypeDescriptionRequiredDefaultOptions
textStringRaw textRequired

JavascriptEncode Overload 2

Escapes dates into a format suitable for javascript parsing.

Velocity

#set($stringResponse = $core_v2_encoding.JavascriptEncode($date))

JavaScript

var stringResponse = core_v2_encoding.JavascriptEncode(date);

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeSource dateRequired

Returns

String

SanitizeHtml

SanitizeHtml Overload 1

Sanitizes an html string

Velocity

#set($stringResponse = $core_v2_encoding.SanitizeHtml($html))

JavaScript

var stringResponse = core_v2_encoding.SanitizeHtml(html);

Parameters

NameTypeDescriptionRequiredDefaultOptions
htmlStringHtmlRequired

SanitizeHtml Overload 2

Sanitizes an html string

Velocity

#set($stringResponse = $core_v2_encoding.SanitizeHtml($html, "%{ ApplicationId = $applicationIdArg, ApplicationTypeId = $applicationTypeIdArg, ContentTypeId = $contentTypeIdArg }"))

JavaScript

var stringResponse = core_v2_encoding.SanitizeHtml(html, { ApplicationId: applicationIdArg, ApplicationTypeId: applicationTypeIdArg, ContentTypeId: contentTypeIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
htmlStringHtmlRequired
optionsOptionsSet of optional parameters including:Required
ApplicationIdGuidApplication ID in which this content exists.Optional
ApplicationTypeIdGuidApplication Type ID in which this content exists.Optional
ContentTypeIdGuidContent Type ID of this content.Optional

Returns

String

SearchEncode

Velocity

#set($stringResponse = $core_v2_encoding.SearchEncode($text))

JavaScript

var stringResponse = core_v2_encoding.SearchEncode(text);

Parameters

NameTypeDescriptionRequiredDefaultOptions
textStringTextRequired

Returns

String

UriEscape

Ensures a URI is escaped, excluding characters not reserved for URIs. Does not re-encode %.

Velocity

#set($stringResponse = $core_v2_encoding.UriEscape($uri))

JavaScript

var stringResponse = core_v2_encoding.UriEscape(uri);

Parameters

NameTypeDescriptionRequiredDefaultOptions
uriStringUriRequired

Returns

String

UrlDecode

Decodes text that was URL encoded

Velocity

#set($stringResponse = $core_v2_encoding.UrlDecode($text))

JavaScript

var stringResponse = core_v2_encoding.UrlDecode(text);

Parameters

NameTypeDescriptionRequiredDefaultOptions
textStringEncoded textRequired

Returns

String

UrlDecodeFileComponent

Velocity

#set($stringResponse = $core_v2_encoding.UrlDecodeFileComponent($urlToDecode))

JavaScript

var stringResponse = core_v2_encoding.UrlDecodeFileComponent(urlToDecode);

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlToDecodeStringUrl To DecodeRequired

Returns

String

UrlEncode

Encodes text for use within URL query parameters

Velocity

#set($stringResponse = $core_v2_encoding.UrlEncode($text))

JavaScript

var stringResponse = core_v2_encoding.UrlEncode(text);

Parameters

NameTypeDescriptionRequiredDefaultOptions
textStringRaw textRequired

Returns

String


  • 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 2024 Verint, Inc.
Powered by Verint Community