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_language 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_language Script API


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

  • Properties
  • FormatAgoDate
  • FormatDataSize
  • FormatDate
  • FormatDateAndTime
  • FormatNumber
  • FormatString
  • FormatTime
  • FormatUrl
  • GetInitials
  • GetResource
  • Lowercase
  • RemoveHtml
  • Truncate
  • Uppercase

Properties

NameAccessTypeDescription
CodeReadStringIdentifies the current language code, for example, en.
CodeAndLocaleReadStringIdentifies the current language code and locale, for example, en-us.
IsRightToLeftReadBooleanIdentifies if the accessing user's language is rendered right to left.
NewLineReadStringEnvironment-aware new line character

Methods

FormatAgoDate

FormatAgoDate Overload 1

Formats a date as a readable 'time ago' format

Velocity

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

JavaScript

var stringResponse = core_v2_language.FormatAgoDate(date);

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired

FormatAgoDate Overload 2

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

Velocity

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

JavaScript

var stringResponse = core_v2_language.FormatAgoDate(date, useUserTime);

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired
useUserTimeBooleanUse User TimeRequired

Returns

String

FormatDataSize

Formats a data size

Velocity

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

JavaScript

var stringResponse = core_v2_language.FormatDataSize(size);

Parameters

NameTypeDescriptionRequiredDefaultOptions
sizeInt32SizeRequired

Returns

String

FormatDate

FormatDate Overload 1

Formats a date to the default date format

Velocity

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

JavaScript

var stringResponse = core_v2_language.FormatDate(date);

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired

FormatDate Overload 2

Formats a date to a custom date format

Velocity

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

JavaScript

var 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

FormatDate Overload 3

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

Velocity

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

JavaScript

var stringResponse = core_v2_language.FormatDate(date, { AdjustTimeZone: adjustTimeZoneArg, Format: formatArg, TimeZoneId: timeZoneIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired
optionsOptionsSet of optional parameters including:Required
AdjustTimeZoneBooleanWhen true, converts to accessing user's time zone. DEPRECATED: this parameter is no longer supportedOptionalTrue
FormatStringCustom formatOptional
TimeZoneIdStringTimeZone IdOptional

Returns

String

FormatDateAndTime

FormatDateAndTime Overload 1

Formats a date to the default date and time format

Velocity

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

JavaScript

var stringResponse = core_v2_language.FormatDateAndTime(date);

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired

FormatDateAndTime Overload 2

Formats a date to the default date and time format

Velocity

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

JavaScript

var stringResponse = core_v2_language.FormatDateAndTime(date, { AdjustTimeZone: adjustTimeZoneArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired
optionsOptionsSet of optional parameters including:Required
AdjustTimeZoneBooleanWhen true, converts to accessing user's time zone. DEPRECATED: this parameter is no longer supportedOptionalTrue

Returns

String

FormatNumber

FormatNumber Overload 1

Formats a number

Velocity

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

JavaScript

var stringResponse = core_v2_language.FormatNumber(number);

Parameters

NameTypeDescriptionRequiredDefaultOptions
numberInt32NumberRequired

FormatNumber Overload 2

Formats a number

Velocity

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

JavaScript

var stringResponse = core_v2_language.FormatNumber(number);

Parameters

NameTypeDescriptionRequiredDefaultOptions
numberDoubleNumberRequired

Returns

String

FormatString

FormatString Overload 1

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

Velocity

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

JavaScript

var stringResponse = core_v2_language.FormatString(format, parameters);

Parameters

NameTypeDescriptionRequiredDefaultOptions
formatStringFormat string including indexed placeholders: {0}, {1}, {2}, etcRequired
parametersArray of StringParametersRequired

FormatString Overload 2

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

Velocity

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

JavaScript

var stringResponse = core_v2_language.FormatString(format, {});

Parameters

NameTypeDescriptionRequiredDefaultOptions
formatStringFormat string including named parameters in the format {name}.Required
parametersOptionsSet of optional parameters including:Required

Returns

String

FormatTime

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

Velocity

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

JavaScript

var stringResponse = core_v2_language.FormatTime(time);

Parameters

NameTypeDescriptionRequiredDefaultOptions
timeDateTimeTimeRequired

Returns

String

FormatUrl

Formats a URL

Velocity

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

JavaScript

var stringResponse = core_v2_language.FormatUrl(url);

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired

Returns

String

GetInitials

Returns initials for a full Name

Velocity

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

JavaScript

var stringResponse = core_v2_language.GetInitials(fullName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
fullNameStringFull NameRequired

Returns

String

GetResource

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

Velocity

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

JavaScript

var stringResponse = core_v2_language.GetResource(resourceName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
resourceNameStringResource NameRequired

Returns

String

Lowercase

Converts a string to lower-case

Velocity

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

JavaScript

var stringResponse = core_v2_language.Lowercase(text);

Parameters

NameTypeDescriptionRequiredDefaultOptions
textStringTextRequired

Returns

String

RemoveHtml

Removes HTML from a string

Velocity

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

JavaScript

var stringResponse = core_v2_language.RemoveHtml(html);

Parameters

NameTypeDescriptionRequiredDefaultOptions
htmlStringHtmlRequired

Returns

String

Truncate

Truncate Overload 1

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

Velocity

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

JavaScript

var stringResponse = core_v2_language.Truncate(text, desiredLength, ellipsis);

Parameters

NameTypeDescriptionRequiredDefaultOptions
textStringTextRequired
desiredLengthInt32Desired LengthRequired
ellipsisStringString to truncateRequired

Truncate Overload 2

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

Velocity

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

JavaScript

var stringResponse = core_v2_language.Truncate(text, desiredLength, { Ellipsis: ellipsisArg, MaintainHtmlFormatting: maintainHtmlFormattingArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
textStringString to truncateRequired
desiredLengthInt32Desired length to truncate at. Truncation will break on the next word boundary.Required
optionsOptionsSet of optional parameters including:Required
EllipsisStringString to append after the truncated string.Optional...
MaintainHtmlFormattingBooleanWhen true, maintains HTML formatting within the trucated string.OptionalFalse

Returns

String

Uppercase

Converts a string to upper-case

Velocity

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

JavaScript

var stringResponse = core_v2_language.Uppercase(text);

Parameters

NameTypeDescriptionRequiredDefaultOptions
textStringTextRequired

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