Telligent Community
Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Telligent Community 10.x
  • Verint Community
  • More
Telligent Community 10.x
API Documentation $core_v2_language 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_language Widget Extension


Enables scripted content fragments to retrieve localized text and format data.

Properties

NameTypeDescriptionDefaultOptions
CodestringIdentifies the current language code, for example, en.
CodeAndLocalestringIdentifies the current language code and locale, for example, en-us.
IsRightToLeftboolIdentifies if the accessing user's language is rendered right to left.
NewLinestringEnvironment-aware new line character

Methods

FormatAgoDate

Formats a date as a readable 'time ago' format. DEPRECATED: Parameter "useUserTime" is no longer supported

Usage

#set($stringResponse = $core_v2_language.FormatAgoDate($date, $useUserTime))

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired
useUserTimeboolUse User TimeRequired

Return Type

string

FormatAgoDate

Formats a date as a readable 'time ago' format

Usage

#set($stringResponse = $core_v2_language.FormatAgoDate($date))

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired

Return Type

string

FormatDataSize

Formats a data size

Usage

#set($stringResponse = $core_v2_language.FormatDataSize($size))

Parameters

NameTypeDescriptionRequiredDefaultOptions
sizeintSizeRequired

Return Type

string

FormatDate

Formats a date to the default date format

Usage

#set($stringResponse = $core_v2_language.FormatDate($date))

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired

Return Type

string

FormatDate

Formats a date to a custom date format

Usage

#set($stringResponse = $core_v2_language.FormatDate($date, $format))

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired
formatstringSupports standard and custom datetime formats as defined msdn.microsoft.com/.../az4se3k1.aspx and msdn.microsoft.com/.../8kb3ddd4.aspxRequired

Return Type

string

FormatDate

Formats a date to a custom date format and or adjusted time zone

Usage

#set($stringResponse = $core_v2_language.FormatDate($date, "%{AdjustTimeZone = $adjustTimeZoneArg, Format = $formatArg, TimeZoneId = $timeZoneIdArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired
AdjustTimeZoneboolWhen true, converts to accessing user's time zone. DEPRECATED: this parameter is no longer supportedOptionalTrue
FormatstringCustom formatOptional
TimeZoneIdstringTimeZone IdOptional

Return Type

string

FormatDateAndTime

Formats a date to the default date and time format

Usage

#set($stringResponse = $core_v2_language.FormatDateAndTime($date))

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired

Return Type

string

FormatDateAndTime

Formats a date to the default date and time format

Usage

#set($stringResponse = $core_v2_language.FormatDateAndTime($date, "%{AdjustTimeZone = $adjustTimeZoneArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired
AdjustTimeZoneboolWhen true, converts to accessing user's time zone. DEPRECATED: this parameter is no longer supportedOptionalTrue

Return Type

string

FormatNumber

Formats a number

Usage

#set($stringResponse = $core_v2_language.FormatNumber($number))

Parameters

NameTypeDescriptionRequiredDefaultOptions
numberintNumberRequired

Return Type

string

FormatNumber

Formats a number

Usage

#set($stringResponse = $core_v2_language.FormatNumber($number))

Parameters

NameTypeDescriptionRequiredDefaultOptions
numberdoubleNumberRequired

Return Type

string

FormatString

Replaces each format item in a specified string with the text equivalent of a corresponding object's value.

Usage

#set($stringResponse = $core_v2_language.FormatString($format, $parameters))

Parameters

NameTypeDescriptionRequiredDefaultOptions
formatstringFormat string including indexed placeholders: {0}, {1}, {2}, etcRequired
parametersstring[]ParametersRequired

Return Type

string

FormatString

Replaces each format item of the format {NAME} with the value of the item with that name in the parameters dictionary.

Usage

#set($stringResponse = $core_v2_language.FormatString($format, "%{ = $Arg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
formatstringFormat string including named parameters in the format {name}.Required
Parameter values, indexed by name.Optional

Return Type

string

FormatTime

Formats the time component of a date/time using the site default time format.

Usage

#set($stringResponse = $core_v2_language.FormatTime($time))

Parameters

NameTypeDescriptionRequiredDefaultOptions
timeDateTimeTimeRequired

Return Type

string

FormatUrl

Formats a URL

Usage

#set($stringResponse = $core_v2_language.FormatUrl($url))

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringUrlRequired

Return Type

string

GetInitials

Returns initials for a full Name

Usage

#set($stringResponse = $core_v2_language.GetInitials($fullName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
fullNamestringFull NameRequired

Return Type

string

GetResource

Gets the widget-specified language resource defined by a resource name

Usage

#set($stringResponse = $core_v2_language.GetResource($resourceName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
resourceNamestringResource NameRequired

Return Type

string

Lowercase

Converts a string to lower-case

Usage

#set($stringResponse = $core_v2_language.Lowercase($text))

Parameters

NameTypeDescriptionRequiredDefaultOptions
textstringTextRequired

Return Type

string

RemoveHtml

Removes HTML from a string

Usage

#set($stringResponse = $core_v2_language.RemoveHtml($html))

Parameters

NameTypeDescriptionRequiredDefaultOptions
htmlstringHtmlRequired

Return Type

string

Truncate

Truncates text as close to the desiredLength as possible without breaking words. Also removes HTML

Usage

#set($stringResponse = $core_v2_language.Truncate($text, $desiredLength, $ellipsis))

Parameters

NameTypeDescriptionRequiredDefaultOptions
textstringTextRequired
desiredLengthintDesired LengthRequired
ellipsisstringString to truncateRequired

Return Type

string

Truncate

Truncates text as close to the desiredLength as possible without breaking words.

Usage

#set($stringResponse = $core_v2_language.Truncate($text, $desiredLength, "%{Ellipsis = $ellipsisArg, MaintainHtmlFormatting = $maintainHtmlFormattingArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
textstringString to truncateRequired
desiredLengthintDesired length to truncate at. Truncation will break on the next word boundary.Required
EllipsisstringString to append after the truncated string.Optional...
MaintainHtmlFormattingboolWhen true, maintains HTML formatting within the trucated string.OptionalFalse

Return Type

string

Uppercase

Converts a string to upper-case

Usage

#set($stringResponse = $core_v2_language.Uppercase($text))

Parameters

NameTypeDescriptionRequiredDefaultOptions
textstringTextRequired

Return Type

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