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


Enables scripted content fragments to have access to useful utility methods

Properties

NameTypeDescriptionDefaultOptions
CurrentDateDateTimeThe current date
CurrentUserDateDateTimeThe current user date
NewLinestringNew Line Character

Methods

AdjustTimeZone

Converts the date to new time zone. OBSOLETE in 10.1

Usage

#set($dateTimeResponse = $core_v2_utility.AdjustTimeZone($date, $timeZoneId))

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired
timeZoneIdstringTime Zone IdRequired

Return Type

DateTime

ContainsContent

Usage

#set($booleanResponse = $core_v2_utility.ContainsContent($html))

Parameters

NameTypeDescriptionRequiredDefaultOptions
htmlstringHtmlRequired

Return Type

bool

Describe

Returns debug information about a given object, recursing all properties

Usage

#set($stringResponse = $core_v2_utility.Describe($item, "%{Depth = $depthArg, Format = $formatArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
itemObjectItemRequired
DepthintDepth of traversalOptional2
FormatstringFormatOptionallistlist, text

Return Type

string

Describe

Returns debug information about a given object, recursing all properties

Usage

#set($stringResponse = $core_v2_utility.Describe($o))

Parameters

NameTypeDescriptionRequiredDefaultOptions
oObjectORequired

Return Type

string

FlattenHierarchy

Flattens a nested hierarchy of objects

Usage

#set($iListResponse = $core_v2_utility.FlattenHierarchy($hierarchy, $recursiveProperty, "%{ExpandToChildProperty = $expandToChildPropertyArg, ExpandToChildValue = $expandToChildValueArg, ExpandToLevel = $expandToLevelArg, HiddenProperty = $hiddenPropertyArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
hierarchyIEnumerableHierarchyRequired
recursivePropertystringRecursive PropertyRequired
ExpandToChildPropertystringExpand To Child PropertyOptional
ExpandToChildValuestringExpand To Child ValueOptional
ExpandToLevelintExpand To LevelOptional
HiddenPropertystringHidden PropertyOptional

Return Type

IList<FlattenedHierarchyItem>

FlattenHierarchy

Flattens a nested hierarchy of objects

Usage

#set($iListResponse = $core_v2_utility.FlattenHierarchy($hierarchy, $recursiveProperty))

Parameters

NameTypeDescriptionRequiredDefaultOptions
hierarchyIEnumerableHierarchyRequired
recursivePropertystringRecursive PropertyRequired

Return Type

IList<FlattenedHierarchyItem>

GetTemporaryData

Retrieves temporary data

Usage

#set($stringResponse = $core_v2_utility.GetTemporaryData($key))

Parameters

NameTypeDescriptionRequiredDefaultOptions
keystringKeyRequired

Return Type

string

GetTimestamp

Creates an timestamp representation of the date supplied.

Usage

#set($stringResponse = $core_v2_utility.GetTimestamp($date))

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired

Return Type

string

IsMatch

Tests a string against a regular expression pattern

Usage

#set($booleanResponse = $core_v2_utility.IsMatch($input, $pattern, "%{RegexOptions = $regexOptionsArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
inputstringInputRequired
patternstringPatternRequired
RegexOptionsIList<string>List of options.OptionalCompiled, CultureInvariant, ECMAScript, ExplicitCapture, IgnoreCase, IgnorePatternWhitespace, Multiline, None, RightToLeft, Singleline

Return Type

bool

IsMatch

Tests a string against a regular expression pattern

Usage

#set($booleanResponse = $core_v2_utility.IsMatch($input, $pattern))

Parameters

NameTypeDescriptionRequiredDefaultOptions
inputstringInputRequired
patternstringPatternRequired

Return Type

bool

Join

Joins a list of items into a single string

Usage

#set($stringResponse = $core_v2_utility.Join($separator, $items))

Parameters

NameTypeDescriptionRequiredDefaultOptions
separatorstringSeparatorRequired
itemsIList<string>ItemsRequired

Return Type

string

MakeList

Converts an array of strings into an IList of strings

Usage

#set($iListResponse = $core_v2_utility.MakeList($items))

Parameters

NameTypeDescriptionRequiredDefaultOptions
itemsstring[]ItemsRequired

Return Type

IList<string>

ParseBool

Converts a string to a bool. false if unparseable

Usage

#set($booleanResponse = $core_v2_utility.ParseBool($boolean))

Parameters

NameTypeDescriptionRequiredDefaultOptions
booleanstringBooleanRequired

Return Type

bool

ParseDate

Converts numerically-formatted year, month, date, hour, and minute strings into a DateTime

Usage

#set($dateTimeResponse = $core_v2_utility.ParseDate($year, $month, $day, $hour, $minute))

Parameters

NameTypeDescriptionRequiredDefaultOptions
yearstringYearRequired
monthstringMonthRequired
daystringDayRequired
hourstringHourRequired
minutestringMinuteRequired

Return Type

DateTime

ParseDate

Converts a string to a DateTime. Minimum Date if unparseable.

Usage

#set($dateTimeResponse = $core_v2_utility.ParseDate($date))

Parameters

NameTypeDescriptionRequiredDefaultOptions
datestringDateRequired

Return Type

DateTime

ParseDate

Converts numerically-formatted year, month, and date strings into a DateTime

Usage

#set($dateTimeResponse = $core_v2_utility.ParseDate($year, $month, $day))

Parameters

NameTypeDescriptionRequiredDefaultOptions
yearstringYearRequired
monthstringMonthRequired
daystringDayRequired

Return Type

DateTime

ParseDouble

Converts a string to a double. -1.0 if unparseable

Usage

#set($doubleResponse = $core_v2_utility.ParseDouble($input))

Parameters

NameTypeDescriptionRequiredDefaultOptions
inputstringInputRequired

Return Type

double

ParseGuid

Converts a string to a guid. Empty guid if unparseable

Usage

#set($guidResponse = $core_v2_utility.ParseGuid($guid))

Parameters

NameTypeDescriptionRequiredDefaultOptions
guidstringGuidRequired

Return Type

Guid

ParseInt

Converts a string to an integer. -1 if unparseable

Usage

#set($int32Response = $core_v2_utility.ParseInt($input))

Parameters

NameTypeDescriptionRequiredDefaultOptions
inputstringInputRequired

Return Type

int

ParseLong

Converts a string to a long. -1 if unparseable

Usage

#set($int64Response = $core_v2_utility.ParseLong($input))

Parameters

NameTypeDescriptionRequiredDefaultOptions
inputstringInputRequired

Return Type

Int64

ParseTimestamp

Converts the timestamp string to DateTime.

Usage

#set($dateTimeResponse = $core_v2_utility.ParseTimestamp($timestamp))

Parameters

NameTypeDescriptionRequiredDefaultOptions
timestampstringTimestampRequired

Return Type

DateTime

Replace

Replaces all parts of a string matching a regular expression pattern with a replacement

Usage

#set($stringResponse = $core_v2_utility.Replace($input, $pattern, $replacement))

Parameters

NameTypeDescriptionRequiredDefaultOptions
inputstringInputRequired
patternstringPatternRequired
replacementstringReplacementRequired

Return Type

string

Replace

Replaces all parts of a string matching a regular expression pattern with a replacement

Usage

#set($stringResponse = $core_v2_utility.Replace($input, $pattern, $replacement, "%{RegexOptions = $regexOptionsArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
inputstringInputRequired
patternstringPatternRequired
replacementstringReplacementRequired
RegexOptionsIList<string>List of options.OptionalCompiled, CultureInvariant, ECMAScript, ExplicitCapture, IgnoreCase, IgnorePatternWhitespace, Multiline, None, RightToLeft, Singleline

Return Type

string

Slice

Returns a subset of a list of strings

Usage

#set($iListResponse = $core_v2_utility.Slice($array, $startIndex, $length))

Parameters

NameTypeDescriptionRequiredDefaultOptions
arrayIList<string>ArrayRequired
startIndexintZero-based index to begin sliceRequired
lengthintLength of sliceRequired

Return Type

IList<string>

Split

Splits a string into separate items

Usage

#set($iListResponse = $core_v2_utility.Split($separator, $joined, $count))

Parameters

NameTypeDescriptionRequiredDefaultOptions
separatorstringSeparatorRequired
joinedstringJoinedRequired
countintCountRequired

Return Type

IList<string>

Split

Splits a string into separate items

Usage

#set($iListResponse = $core_v2_utility.Split($separator, $joined))

Parameters

NameTypeDescriptionRequiredDefaultOptions
separatorstringSeparatorRequired
joinedstringJoinedRequired

Return Type

IList<string>

StoreTemporaryData

Stores temporary data

Usage

#set($stringResponse = $core_v2_utility.StoreTemporaryData($data))

Parameters

NameTypeDescriptionRequiredDefaultOptions
datastringDataRequired

Return Type

string

ToJson

Serializes an object to JSON

Usage

#set($stringResponse = $core_v2_utility.ToJson($value))

Parameters

NameTypeDescriptionRequiredDefaultOptions
valueObjectValueRequired

Return Type

string

Trim

Trims whitespace around a string

Usage

#set($stringResponse = $core_v2_utility.Trim($input))

Parameters

NameTypeDescriptionRequiredDefaultOptions
inputstringInputRequired

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