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


Enables scripted content fragments to render standardized UI elements.

  • Properties
  • AgoDate
  • Bookmark
  • CanBeViewed
  • CanFormatHtmlAsText
  • ContentPeek
  • ConvertContent
  • Feature
  • FormatHtmlAsText
  • FormatTextAsHtml
  • ForumVotes
  • GetCurrentPageIndex
  • GetFileTypeImageUrl
  • GetLastPageIndex
  • GetMediaType
  • GetMimeType
  • GetPreviewHtml
  • GetPreviewImageUrl
  • GetResizedImageHtml
  • GetResizedImageUrl
  • GetViewHtml
  • Like
  • MakeCssClassName
  • Merge
  • Moderate
  • PagedContent
  • PagedContentPagedEvent
  • PagedContentPagingEvent
  • PagedContentWrapperElementId
  • Pager
  • Poll
  • Rate
  • Render
  • ScheduledFile
  • Tag
  • UserPresence

Properties

NameAccessTypeDescription
PageIndexQueryStringKeyReadStringUnique widget-instance-specific key used to identify requested page indexes in the query string

Methods

AgoDate

AgoDate Overload 1

Renders an auto-updating ago date.

Velocity

#set($stringResponse = $core_v2_ui.AgoDate($date))

JavaScript

var stringResponse = core_v2_ui.AgoDate(date);

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired

AgoDate Overload 2

Renders an auto-updating ago date.

Velocity

#set($stringResponse = $core_v2_ui.AgoDate($date, "%{ CssClass = $cssClassArg }"))

JavaScript

var stringResponse = core_v2_ui.AgoDate(date, { CssClass: cssClassArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired
optionsOptionsSet of optional parameters including:Required
CssClassStringAdditional CSS Class(es) to apply to the placeholderOptional

Returns

String

Bookmark

Bookmark Overload 1

Renders the ability to add/remove a bookmark for this content.

Velocity

#set($stringResponse = $core_v2_ui.Bookmark($contentId, $contentTypeId))

JavaScript

var stringResponse = core_v2_ui.Bookmark(contentId, contentTypeId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired

Bookmark Overload 2

Renders the ability to add/remove a bookmark for this content. Additional un-specified optional parameters are combined into a single query-string encoded data attribute on the resulting placeholder span.

Velocity

#set($stringResponse = $core_v2_ui.Bookmark($contentId, $contentTypeId, "%{ BookmarkTypeId = $bookmarkTypeIdArg, CssClass = $cssClassArg }"))

JavaScript

var stringResponse = core_v2_ui.Bookmark(contentId, contentTypeId, { BookmarkTypeId: bookmarkTypeIdArg, CssClass: cssClassArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired
optionsOptionsSet of optional parameters including:Required
BookmarkTypeIdGuidBookmark Type IdOptional
CssClassStringAdditional CSS Class(es) to apply to the placeholderOptional

Bookmark Overload 3

Renders the ability to add/remove a bookmark for this content.

Velocity

#set($stringResponse = $core_v2_ui.Bookmark($contentUrl, $oauthClientId))

JavaScript

var stringResponse = core_v2_ui.Bookmark(contentUrl, oauthClientId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired

Bookmark Overload 4

Renders the ability to add/remove a bookmark for this content. Additional un-specified optional parameters are combined into a single query-string encoded data attribute on the resulting placeholder span.

Velocity

#set($stringResponse = $core_v2_ui.Bookmark($contentUrl, $oauthClientId, "%{ BookmarkTypeId = $bookmarkTypeIdArg, CssClass = $cssClassArg }"))

JavaScript

var stringResponse = core_v2_ui.Bookmark(contentUrl, oauthClientId, { BookmarkTypeId: bookmarkTypeIdArg, CssClass: cssClassArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired
optionsOptionsSet of optional parameters including:Required
BookmarkTypeIdGuidBookmark Type IdOptional
CssClassStringAdditional CSS Class(es) to apply to the placeholderOptional

Returns

String

CanBeViewed

Determines whether a file can be viewed

Velocity

#set($booleanResponse = $core_v2_ui.CanBeViewed($url))

JavaScript

var booleanResponse = core_v2_ui.CanBeViewed(url);

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired

Returns

Boolean

CanFormatHtmlAsText

Identifies if HTML can be converted to text without data loss.

Velocity

#set($booleanResponse = $core_v2_ui.CanFormatHtmlAsText($html))

JavaScript

var booleanResponse = core_v2_ui.CanFormatHtmlAsText(html);

Parameters

NameTypeDescriptionRequiredDefaultOptions
htmlStringHtmlRequired

Returns

Boolean

ContentPeek

ContentPeek Overload 1

Renders an HTML attribute string which can be embedded in any element to provide content peeking associated with the element.

Velocity

#set($stringResponse = $core_v2_ui.ContentPeek($contentId, $contentTypeId))

JavaScript

var stringResponse = core_v2_ui.ContentPeek(contentId, contentTypeId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidConent Id of peeked contentRequired
contentTypeIdGuidContent Type Id of peeked contentRequired

ContentPeek Overload 2

Renders an HTML attribute string which can be embedded in any element to provide content peeking associated with the element.

Velocity

#set($stringResponse = $core_v2_ui.ContentPeek($contentId, $contentTypeId, $cssClass))

JavaScript

var stringResponse = core_v2_ui.ContentPeek(contentId, contentTypeId, cssClass);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidConent Id of peeked contentRequired
contentTypeIdGuidContent Type Id of peeked contentRequired
cssClassStringAdditional CSS class(es) to associate with the elementRequired

Returns

String

ConvertContent

ConvertContent Overload 1

Renders a link to initiate a content conversion session

Velocity

#set($stringResponse = $core_v2_ui.ConvertContent($contentId, $contentTypeId))

JavaScript

var stringResponse = core_v2_ui.ConvertContent(contentId, contentTypeId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired

ConvertContent Overload 2

Renders a link to initiate a content conversion session

Velocity

#set($stringResponse = $core_v2_ui.ConvertContent($contentId, $contentTypeId, "%{}"))

JavaScript

var stringResponse = core_v2_ui.ConvertContent(contentId, contentTypeId, {});

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired
optionsOptionsSet of optional parameters including:Required

Returns

String

Feature

Feature Overload 1

Renders the ability to add/remove a feature for this content.

Velocity

#set($stringResponse = $core_v2_ui.Feature($contentId, $contentTypeId))

JavaScript

var stringResponse = core_v2_ui.Feature(contentId, contentTypeId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired

Feature Overload 2

Renders the ability to add/remove a feature for this content. Additional un-specified optional parameters are combined into a single query-string encoded data attribute on the resulting placeholder span.

Velocity

#set($stringResponse = $core_v2_ui.Feature($contentId, $contentTypeId, "%{ CssClass = $cssClassArg, TypeId = $typeIdArg }"))

JavaScript

var stringResponse = core_v2_ui.Feature(contentId, contentTypeId, { CssClass: cssClassArg, TypeId: typeIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired
optionsOptionsSet of optional parameters including:Required
CssClassStringAdditional CSS Class(es) to apply to the placeholderOptional
TypeIdGuidFeature Type IdOptional

Feature Overload 3

Renders the ability to add/remove a feature for this content.

Velocity

#set($stringResponse = $core_v2_ui.Feature($contentUrl, $oauthClientId))

JavaScript

var stringResponse = core_v2_ui.Feature(contentUrl, oauthClientId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired

Feature Overload 4

Renders the ability to add/remove a feature for this content. Additional un-specified optional parameters are combined into a single query-string encoded data attribute on the resulting placeholder span.

Velocity

#set($stringResponse = $core_v2_ui.Feature($contentUrl, $oauthClientId, "%{ CssClass = $cssClassArg, TypeId = $typeIdArg }"))

JavaScript

var stringResponse = core_v2_ui.Feature(contentUrl, oauthClientId, { CssClass: cssClassArg, TypeId: typeIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired
optionsOptionsSet of optional parameters including:Required
CssClassStringAdditional CSS Class(es) to apply to the placeholderOptional
TypeIdGuidFeature Type IdOptional

Returns

String

FormatHtmlAsText

Formats HTML as text

Velocity

#set($stringResponse = $core_v2_ui.FormatHtmlAsText($html))

JavaScript

var stringResponse = core_v2_ui.FormatHtmlAsText(html);

Parameters

NameTypeDescriptionRequiredDefaultOptions
htmlStringHtmlRequired

Returns

String

FormatTextAsHtml

FormatTextAsHtml Overload 1

Formats text as HTML

Velocity

#set($stringResponse = $core_v2_ui.FormatTextAsHtml($text))

JavaScript

var stringResponse = core_v2_ui.FormatTextAsHtml(text);

Parameters

NameTypeDescriptionRequiredDefaultOptions
textStringTextRequired

FormatTextAsHtml Overload 2

Formats text as HTML

Velocity

#set($stringResponse = $core_v2_ui.FormatTextAsHtml($text, "%{ ConvertToParagraphs = $convertToParagraphsArg, DetectMediaUrls = $detectMediaUrlsArg }"))

JavaScript

var stringResponse = core_v2_ui.FormatTextAsHtml(text, { ConvertToParagraphs: convertToParagraphsArg, DetectMediaUrls: detectMediaUrlsArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
textStringTextRequired
optionsOptionsSet of optional parameters including:Required
ConvertToParagraphsBooleanConvert To ParagraphsOptionalTrue
DetectMediaUrlsBooleanDetect Media UrlsOptionalFalse

Returns

String

ForumVotes

ForumVotes Overload 1

Velocity

#set($stringResponse = $core_v2_ui.ForumVotes($type, $id))

JavaScript

var stringResponse = core_v2_ui.ForumVotes(type, id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
typeStringTypeRequired
idInt32IdRequired

ForumVotes Overload 2

Velocity

#set($stringResponse = $core_v2_ui.ForumVotes($type, $id, "%{}"))

JavaScript

var stringResponse = core_v2_ui.ForumVotes(type, id, {});

Parameters

NameTypeDescriptionRequiredDefaultOptions
typeStringTypeRequired
idInt32IdRequired
optionsOptionsSet of optional parameters including:Required

Returns

String

GetCurrentPageIndex

GetCurrentPageIndex Overload 1

Returns the currently-requested paging index

Velocity

#set($int32Response = $core_v2_ui.GetCurrentPageIndex())

JavaScript

var int32Response = core_v2_ui.GetCurrentPageIndex();

GetCurrentPageIndex Overload 2

Returns the currently-requested paging index

Velocity

#set($int32Response = $core_v2_ui.GetCurrentPageIndex("%{ QueryStringProperty = $queryStringPropertyArg }"))

JavaScript

var int32Response = core_v2_ui.GetCurrentPageIndex({ QueryStringProperty: queryStringPropertyArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
QueryStringPropertyStringQuery string page index keyOptionalValue of PageIndexQueryStringKey

Returns

Int32

GetFileTypeImageUrl

GetFileTypeImageUrl Overload 1

Gets a file type image URL for a URL or filename

Velocity

#set($stringResponse = $core_v2_ui.GetFileTypeImageUrl($url, "%{ Height = $heightArg, OutputIsPersisted = $outputIsPersistedArg, Width = $widthArg }"))

JavaScript

var stringResponse = core_v2_ui.GetFileTypeImageUrl(url, { Height: heightArg, OutputIsPersisted: outputIsPersistedArg, Width: widthArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired
optionsOptionsSet of optional parameters including:Required
HeightInt32HeightOptional
OutputIsPersistedBooleanWhen the output is not persisted, direct links to CFS file URLs can be rendered. Otherwise, the generic CFS URL is rendered which results in a redirect.OptionalFalse
WidthInt32WidthOptional

GetFileTypeImageUrl Overload 2

Gets a file type image URL for a URL or filename

Velocity

#set($stringResponse = $core_v2_ui.GetFileTypeImageUrl($url))

JavaScript

var stringResponse = core_v2_ui.GetFileTypeImageUrl(url);

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired

Returns

String

GetLastPageIndex

Gets the last page index

Velocity

#set($int32Response = $core_v2_ui.GetLastPageIndex($pageSize, $totalItems))

JavaScript

var int32Response = core_v2_ui.GetLastPageIndex(pageSize, totalItems);

Parameters

NameTypeDescriptionRequiredDefaultOptions
pageSizeInt32Page SizeRequired
totalItemsInt32Total ItemsRequired

Returns

Int32

GetMediaType

GetMediaType Overload 1

Gets media type of a file

Velocity

#set($stringResponse = $core_v2_ui.GetMediaType($url))

JavaScript

var stringResponse = core_v2_ui.GetMediaType(url);

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired

GetMediaType Overload 2

Gets media type of a file

Velocity

#set($stringResponse = $core_v2_ui.GetMediaType($url, "%{ OutputIsPersisted = $outputIsPersistedArg, ViewType = $viewTypeArg }"))

JavaScript

var stringResponse = core_v2_ui.GetMediaType(url, { OutputIsPersisted: outputIsPersistedArg, ViewType: viewTypeArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired
optionsOptionsSet of optional parameters including:Required
OutputIsPersistedBooleanWhen the output is not persisted, direct links to CFS file URLs can be rendered. Otherwise, the generic CFS URL is rendered which results in a redirect.OptionalFalse
ViewTypeStringView TypeOptionalViewPreview, View

Returns

String

GetMimeType

Returns the Mime Type of a file

Velocity

#set($stringResponse = $core_v2_ui.GetMimeType($url))

JavaScript

var stringResponse = core_v2_ui.GetMimeType(url);

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired

Returns

String

GetPreviewHtml

GetPreviewHtml Overload 1

Renders preview HtML for a file

Velocity

#set($stringResponse = $core_v2_ui.GetPreviewHtml($url))

JavaScript

var stringResponse = core_v2_ui.GetPreviewHtml(url);

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired

GetPreviewHtml Overload 2

Renders preview HtML for a file

Velocity

#set($stringResponse = $core_v2_ui.GetPreviewHtml($url, "%{ AdjustToContainer = $adjustToContainerArg, Height = $heightArg, OutputIsPersisted = $outputIsPersistedArg, Width = $widthArg }"))

JavaScript

var stringResponse = core_v2_ui.GetPreviewHtml(url, { AdjustToContainer: adjustToContainerArg, Height: heightArg, OutputIsPersisted: outputIsPersistedArg, Width: widthArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired
optionsOptionsSet of optional parameters including:Required
AdjustToContainerBooleanWhen true, the HTML is re-rendered on window resize to fit within the max available space in the parent container.OptionalFalse
HeightInt32HeightOptional
OutputIsPersistedBooleanWhen the output is not persisted, direct links to CFS file URLs can be rendered. Otherwise, the generic CFS URL is rendered which results in a redirect.OptionalFalse
WidthInt32WidthOptional

Returns

String

GetPreviewImageUrl

Returns a URL of an image that can be used as a preview of file represented by the provided URL

Velocity

#set($stringResponse = $core_v2_ui.GetPreviewImageUrl($url))

JavaScript

var stringResponse = core_v2_ui.GetPreviewImageUrl(url);

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired

Returns

String

GetResizedImageHtml

Renders an image as HTML configured to be resized to the given maximum width and height. Unrecognized name/value pairs passed into the dictionary parameter are rendered on the ouput IMG tag.

Velocity

#set($stringResponse = $core_v2_ui.GetResizedImageHtml($url, $maxWidth, $maxHeight, "%{ OutputIsPersisted = $outputIsPersistedArg, ResizeMethod = $resizeMethodArg, ScaleFactor = $scaleFactorArg }"))

JavaScript

var stringResponse = core_v2_ui.GetResizedImageHtml(url, maxWidth, maxHeight, { OutputIsPersisted: outputIsPersistedArg, ResizeMethod: resizeMethodArg, ScaleFactor: scaleFactorArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired
maxWidthInt32Max WidthRequired
maxHeightInt32Max HeightRequired
attributesOptionsSet of optional parameters including:Required
OutputIsPersistedBooleanWhen the output is not persisted, direct links to CFS file URLs can be rendered. Otherwise, the generic CFS URL is rendered which results in a redirect.OptionalFalse
ResizeMethodStringResize MethodOptionalScaleDown, ZoomAndCrop
ScaleFactorDoubleScale factor to use for high-DPI outputOptional1

Returns

String

GetResizedImageUrl

Returns the URL of the provided image resized to the given maximum width and height if the file can be physically resized. If not, the original URL is returned.

Velocity

#set($stringResponse = $core_v2_ui.GetResizedImageUrl($url, $maxWidth, $maxHeight, "%{ OutputIsPersisted = $outputIsPersistedArg, ResizeMethod = $resizeMethodArg, ScaleFactor = $scaleFactorArg }"))

JavaScript

var stringResponse = core_v2_ui.GetResizedImageUrl(url, maxWidth, maxHeight, { OutputIsPersisted: outputIsPersistedArg, ResizeMethod: resizeMethodArg, ScaleFactor: scaleFactorArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired
maxWidthInt32Max WidthRequired
maxHeightInt32Max HeightRequired
optionsOptionsSet of optional parameters including:Required
OutputIsPersistedBooleanWhen the output is not persisted, direct links to CFS file URLs can be rendered. Otherwise, the generic CFS URL is rendered which results in a redirect.OptionalFalse
ResizeMethodStringResize MethodOptionalScaleDown, ZoomAndCrop
ScaleFactorDoubleScale factor to use for high-DPI outputOptional1

Returns

String

GetViewHtml

GetViewHtml Overload 1

Renders View HTML for a file

Velocity

#set($stringResponse = $core_v2_ui.GetViewHtml($url))

JavaScript

var stringResponse = core_v2_ui.GetViewHtml(url);

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired

GetViewHtml Overload 2

Renders View HTML for a file

Velocity

#set($stringResponse = $core_v2_ui.GetViewHtml($url, "%{ AdjustToContainer = $adjustToContainerArg, Height = $heightArg, OutputIsPersisted = $outputIsPersistedArg, Width = $widthArg }"))

JavaScript

var stringResponse = core_v2_ui.GetViewHtml(url, { AdjustToContainer: adjustToContainerArg, Height: heightArg, OutputIsPersisted: outputIsPersistedArg, Width: widthArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired
optionsOptionsSet of optional parameters including:Required
AdjustToContainerBooleanWhen true, the HTML is re-rendered on window resize to fit within the max available space in the parent container.OptionalFalse
HeightInt32HeightOptional
OutputIsPersistedBooleanWhen the output is not persisted, direct links to CFS file URLs can be rendered. Otherwise, the generic CFS URL is rendered which results in a redirect.OptionalFalse
WidthInt32WidthOptional

Returns

String

Like

Like Overload 1

Renders a 'Like' count for a given content item

Velocity

#set($stringResponse = $core_v2_ui.Like($contentId, $contentTypeId))

JavaScript

var stringResponse = core_v2_ui.Like(contentId, contentTypeId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired

Like Overload 2

Renders a 'Like' count, toggle, and/or message for a given content item. Additional un-specified optional parameters are combined into a single query-string encoded data attribute on the resulting placeholder span.

Velocity

#set($stringResponse = $core_v2_ui.Like($contentId, $contentTypeId, "%{ CssClass = $cssClassArg, Format = $formatArg, LikeTypeId = $likeTypeIdArg, ReadOnly = $readOnlyArg }"))

JavaScript

var stringResponse = core_v2_ui.Like(contentId, contentTypeId, { CssClass: cssClassArg, Format: formatArg, LikeTypeId: likeTypeIdArg, ReadOnly: readOnlyArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired
optionsOptionsSet of optional parameters including:Required
CssClassStringAdditional CSS Class(es) to apply to the placeholderOptional
FormatStringTemplated string containing tokens identifying if, and where, the Like control should contain a count, toggle link, and 'who likes' messageOptional{count}{count}, {message}, {toggle}
LikeTypeIdGuidLike Type IdOptional
ReadOnlyBooleanRender the like UI as read-onlyOptional

Like Overload 3

Renders a 'Like' count for a given content item

Velocity

#set($stringResponse = $core_v2_ui.Like($contentUrl, $oauthClientId))

JavaScript

var stringResponse = core_v2_ui.Like(contentUrl, oauthClientId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired

Like Overload 4

Renders a 'Like' count, toggle, and/or message for a given content item. Additional un-specified optional parameters are combined into a single query-string encoded data attribute on the resulting placeholder span.

Velocity

#set($stringResponse = $core_v2_ui.Like($contentUrl, $oauthClientId, "%{ CssClass = $cssClassArg, Format = $formatArg, IncludeTip = $includeTipArg, LikeTypeId = $likeTypeIdArg, ReadOnly = $readOnlyArg }"))

JavaScript

var stringResponse = core_v2_ui.Like(contentUrl, oauthClientId, { CssClass: cssClassArg, Format: formatArg, IncludeTip: includeTipArg, LikeTypeId: likeTypeIdArg, ReadOnly: readOnlyArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired
optionsOptionsSet of optional parameters including:Required
CssClassStringAdditional CSS Class(es) to apply to the placeholderOptional
FormatStringTemplated string containing tokens identifying if, and where, the Like control should contain a count, toggle link, and 'who likes' messageOptional{count}{count}, {message}, {toggle}
IncludeTipBooleanInclude the like message as a tipOptionalfalse
LikeTypeIdGuidLike Type IdOptional
ReadOnlyBooleanRender the like UI as read-onlyOptional

Returns

String

MakeCssClassName

Converts a pascal or camel-cased string to hyphen-cased

Velocity

#set($stringResponse = $core_v2_ui.MakeCssClassName($text))

JavaScript

var stringResponse = core_v2_ui.MakeCssClassName(text);

Parameters

NameTypeDescriptionRequiredDefaultOptions
textStringTextRequired

Returns

String

Merge

Produces a diff text

Velocity

#set($stringResponse = $core_v2_ui.Merge($original, $modified))

JavaScript

var stringResponse = core_v2_ui.Merge(original, modified);

Parameters

NameTypeDescriptionRequiredDefaultOptions
originalStringOriginalRequired
modifiedStringModifiedRequired

Returns

String

Moderate

Moderate Overload 1

Render's a 'Moderation' control

Velocity

#set($stringResponse = $core_v2_ui.Moderate($contentId, $contentTypeId))

JavaScript

var stringResponse = core_v2_ui.Moderate(contentId, contentTypeId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired

Moderate Overload 2

Render's a 'Moderation' control

Velocity

#set($stringResponse = $core_v2_ui.Moderate($contentId, $contentTypeId, "%{ AdditionalLinks = $additionalLinksArg, AdditionalLinksUrl = $additionalLinksUrlArg, CssClass = $cssClassArg }"))

JavaScript

var stringResponse = core_v2_ui.Moderate(contentId, contentTypeId, { AdditionalLinks: additionalLinksArg, AdditionalLinksUrl: additionalLinksUrlArg, CssClass: cssClassArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired
optionsOptionsSet of optional parameters including:Required
AdditionalLinksStringPredefined additional Links to render before the moderation link in JSON format: [ { href: '', text: '', className: ''} ] (either AdditionalLinks or AdditionalLinksUrl may be used)Optional
AdditionalLinksUrlStringJSON endpoint URL which returns additional Links to render before the moderation link in JSON format: [ { href: '', text: '', className: ''} ] (either AdditionalLinks or AdditionalLinksUrl may be used)Optional
CssClassStringCss ClassOptional

Returns

String

PagedContent

PagedContent Overload 1

Executes a file with support for it to be updated via ajax paging. Required corresponding use of the 'PagedContentFile' parameter in $core_v2_ui.Pager()

Velocity

#set($stringResponse = $core_v2_ui.PagedContent($contentFileName))

JavaScript

var stringResponse = core_v2_ui.PagedContent(contentFileName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentFileNameStringName of attached widget script file to execute which generates a page of contentRequired

PagedContent Overload 2

Executes a file with support for it to be updated via ajax paging. Required corresponding use of the 'PagedContentFile' parameter in $core_v2_ui.Pager()

Velocity

#set($stringResponse = $core_v2_ui.PagedContent($contentFileName, "%{ CssClass = $cssClassArg, ElementType = $elementTypeArg, QueryStringProperty = $queryStringPropertyArg }"))

JavaScript

var stringResponse = core_v2_ui.PagedContent(contentFileName, { CssClass: cssClassArg, ElementType: elementTypeArg, QueryStringProperty: queryStringPropertyArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentFileNameStringName of attached widget script file to execute which generates a page of contentRequired
optionsOptionsSet of optional parameters including:Required
CssClassStringCSS Class(es) to apply to the paged content's wrapper elementOptional
ElementTypeStringType of DOM element to use for the paged content's wrapperOptionaldiv
QueryStringPropertyStringQuery String Property to use instead of the default PageIndexQueryStringKey to disambiguate when multiple pagers are used within a single widgetOptional

Returns

String

PagedContentPagedEvent

PagedContentPagedEvent Overload 1

Name of client-side message published after a widget's content has been paged via ajax

Velocity

#set($stringResponse = $core_v2_ui.PagedContentPagedEvent())

JavaScript

var stringResponse = core_v2_ui.PagedContentPagedEvent();

PagedContentPagedEvent Overload 2

Name of client-side message published after a widget's content has been paged via ajax

Velocity

#set($stringResponse = $core_v2_ui.PagedContentPagedEvent("%{ QueryStringProperty = $queryStringPropertyArg }"))

JavaScript

var stringResponse = core_v2_ui.PagedContentPagedEvent({ QueryStringProperty: queryStringPropertyArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
QueryStringPropertyStringQuery String Property to use instead of the default PageIndexQueryStringKey to disambiguate when multiple pagers are used within a single widgetOptional

Returns

String

PagedContentPagingEvent

PagedContentPagingEvent Overload 1

Name of client-side message published upon the initiation of a widget's ajax paging

Velocity

#set($stringResponse = $core_v2_ui.PagedContentPagingEvent())

JavaScript

var stringResponse = core_v2_ui.PagedContentPagingEvent();

PagedContentPagingEvent Overload 2

Name of client-side message published upon the initiation of a widget's ajax paging

Velocity

#set($stringResponse = $core_v2_ui.PagedContentPagingEvent("%{ QueryStringProperty = $queryStringPropertyArg }"))

JavaScript

var stringResponse = core_v2_ui.PagedContentPagingEvent({ QueryStringProperty: queryStringPropertyArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
QueryStringPropertyStringQuery String Property to use instead of the default PageIndexQueryStringKey to disambiguate when multiple pagers are used within a single widgetOptional

Returns

String

PagedContentWrapperElementId

PagedContentWrapperElementId Overload 1

Container ID for a widget's Paged Content

Velocity

#set($stringResponse = $core_v2_ui.PagedContentWrapperElementId())

JavaScript

var stringResponse = core_v2_ui.PagedContentWrapperElementId();

PagedContentWrapperElementId Overload 2

Container ID for a widget's Paged Content

Velocity

#set($stringResponse = $core_v2_ui.PagedContentWrapperElementId("%{ QueryStringProperty = $queryStringPropertyArg }"))

JavaScript

var stringResponse = core_v2_ui.PagedContentWrapperElementId({ QueryStringProperty: queryStringPropertyArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
QueryStringPropertyStringQuery String Property to use instead of the default PageIndexQueryStringKey to disambiguate when multiple pagers are used within a single widgetOptional

Returns

String

Pager

Pager Overload 1

Renders a 'Pager' control

Velocity

#set($stringResponse = $core_v2_ui.Pager($currentPage, $pageSize, $totalItems))

JavaScript

var stringResponse = core_v2_ui.Pager(currentPage, pageSize, totalItems);

Parameters

NameTypeDescriptionRequiredDefaultOptions
currentPageInt32Current PageRequired
pageSizeInt32Page SizeRequired
totalItemsInt32Total ItemsRequired

Pager Overload 2

Renders a 'Pager' control

Velocity

#set($stringResponse = $core_v2_ui.Pager($currentPage, $pageSize, $totalItems, "%{ BaseUrl = $baseUrlArg, CssClass = $cssClassArg, LoadingIndicator = $loadingIndicatorArg, LoadOnAnyHashChange = $loadOnAnyHashChangeArg, NumberOfPagesToDisplay = $numberOfPagesToDisplayArg, PagedContentFile = $pagedContentFileArg, PagedContentUrl = $pagedContentUrlArg, QueryStringProperty = $queryStringPropertyArg, ShowFirst = $showFirstArg, ShowIndividualPages = $showIndividualPagesArg, ShowLast = $showLastArg, ShowNext = $showNextArg, ShowPrevious = $showPreviousArg, Target = $targetArg, Template = $templateArg, Transition = $transitionArg, TransitionDuration = $transitionDurationArg }"))

JavaScript

var stringResponse = core_v2_ui.Pager(currentPage, pageSize, totalItems, { BaseUrl: baseUrlArg, CssClass: cssClassArg, LoadingIndicator: loadingIndicatorArg, LoadOnAnyHashChange: loadOnAnyHashChangeArg, NumberOfPagesToDisplay: numberOfPagesToDisplayArg, PagedContentFile: pagedContentFileArg, PagedContentUrl: pagedContentUrlArg, QueryStringProperty: queryStringPropertyArg, ShowFirst: showFirstArg, ShowIndividualPages: showIndividualPagesArg, ShowLast: showLastArg, ShowNext: showNextArg, ShowPrevious: showPreviousArg, Target: targetArg, Template: templateArg, Transition: transitionArg, TransitionDuration: transitionDurationArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
currentPageInt32Current PageRequired
pageSizeInt32Page SizeRequired
totalItemsInt32Total ItemsRequired
optionsOptionsSet of optional parameters including:Required
BaseUrlStringURL to apply pagingOptionalCurrent Page
CssClassStringAdditional CSS Class(es) to apply to the placeholderOptional
LoadingIndicatorBooleanWhen true, displays a loading indicatorOptionalfalse
LoadOnAnyHashChangeBooleanWhen true, loads a new page on any change of the hash, not just the page keyOptionalfalse
NumberOfPagesToDisplayInt32Number of pages to display when showing individual pagesOptional5
PagedContentFileStringWhen provided enables Ajax paging against the content file. Requires corresponding use of $core_v2_ui.PagedContent(). Either this or PagedContentUrl can be used.Optional
PagedContentUrlStringWhen provided enables Ajax paging against the content file. Either this or PagedContentFile with $core_v2_ui.PagedContent() can be used.Optional
QueryStringPropertyStringName of the key to use for this widget's page index. Typically unnecessary to overrideOptionalAuto-generated
ShowFirstBooleanWhen true, shows a link to the first pageOptionalTrue
ShowIndividualPagesBooleanWhen true, shows individual links to pagesOptionalTrue
ShowLastBooleanWhen true, shows a link to the last pageOptionalTrue
ShowNextBooleanWhen true, shows a link to the next pageOptionalFalse
ShowPreviousBooleanWhen true, shows a link to the previous pageOptionalFalse
TargetStringExplicit hash target for page linksOptional
TemplateStringTemplate source code or id of template to use when rendering pager linksOptionalPlatform-defined. Theme (and widget) overridable
TransitionStringTransition to use when merging ajax-paged resultsOptionalslidefade, none, slide
TransitionDurationInt32Duration of transition to use when merging ajax-paged resultsOptional200

Returns

String

Poll

Poll Overload 1

Renders a poll.

Velocity

#set($stringResponse = $core_v2_ui.Poll($pollId))

JavaScript

var stringResponse = core_v2_ui.Poll(pollId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
pollIdGuidPoll IdRequired

Poll Overload 2

Renders a poll. Additional un-specified optional parameters are combined into a single query-string encoded data attribute on the resulting placeholder div.

Velocity

#set($stringResponse = $core_v2_ui.Poll($pollId, "%{}"))

JavaScript

var stringResponse = core_v2_ui.Poll(pollId, {});

Parameters

NameTypeDescriptionRequiredDefaultOptions
pollIdGuidPoll IdRequired
optionsOptionsSet of optional parameters including:Required

Returns

String

Rate

Rate Overload 1

Renders a 'Rating' control

Velocity

#set($stringResponse = $core_v2_ui.Rate($contentId, $contentTypeId))

JavaScript

var stringResponse = core_v2_ui.Rate(contentId, contentTypeId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired

Rate Overload 2

Renders a 'Rating' control

Velocity

#set($stringResponse = $core_v2_ui.Rate($contentId, $contentTypeId, "%{ CssClass = $cssClassArg, RatingTypeId = $ratingTypeIdArg, ReadOnly = $readOnlyArg }"))

JavaScript

var stringResponse = core_v2_ui.Rate(contentId, contentTypeId, { CssClass: cssClassArg, RatingTypeId: ratingTypeIdArg, ReadOnly: readOnlyArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired
optionsOptionsSet of optional parameters including:Required
CssClassStringAdditional CSS Class(es) to apply to the placeholderOptional
RatingTypeIdGuidRating TypeIdOptional
ReadOnlyBooleanRender the rating UI as read-onlyOptional

Rate Overload 3

Renders a 'Rating' control

Velocity

#set($stringResponse = $core_v2_ui.Rate($contentUrl, $oauthClientId))

JavaScript

var stringResponse = core_v2_ui.Rate(contentUrl, oauthClientId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired

Rate Overload 4

Renders a 'Rating' control

Velocity

#set($stringResponse = $core_v2_ui.Rate($contentUrl, $oauthClientId, "%{ CssClass = $cssClassArg, RatingTypeId = $ratingTypeIdArg, ReadOnly = $readOnlyArg }"))

JavaScript

var stringResponse = core_v2_ui.Rate(contentUrl, oauthClientId, { CssClass: cssClassArg, RatingTypeId: ratingTypeIdArg, ReadOnly: readOnlyArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired
optionsOptionsSet of optional parameters including:Required
CssClassStringAdditional CSS Class(es) to apply to the placeholderOptional
RatingTypeIdGuidRating TypeIdOptional
ReadOnlyBooleanRender the rating UI as read-onlyOptional

Returns

String

Render

Render Overload 1

Processes generic HTML rendering events to allow plugins to adjust the content

Velocity

#set($stringResponse = $core_v2_ui.Render($html))

JavaScript

var stringResponse = core_v2_ui.Render(html);

Parameters

NameTypeDescriptionRequiredDefaultOptions
htmlStringHtmlRequired

Render Overload 2

Processes generic HTML rendering events to allow plugins to adjust the content

Velocity

#set($stringResponse = $core_v2_ui.Render($html, $target))

JavaScript

var stringResponse = core_v2_ui.Render(html, target);

Parameters

NameTypeDescriptionRequiredDefaultOptions
htmlStringHtmlRequired
targetStringTargetRequiredWebEmail, MailGateway, Nntp, Offline, Other, Print, Syndication, Web, WebQuote, WebServices

Returns

String

ScheduledFile

ScheduledFile Overload 1

Renders a live-updating progress indicator for a script executed with core_v2_widget.ScheduleFile() and a 'ProgressKey' identifier. Progress is reported by the script with the 'context_v2_scheduledFile' API.

Velocity

#set($stringResponse = $core_v2_ui.ScheduledFile($progressKey))

JavaScript

var stringResponse = core_v2_ui.ScheduledFile(progressKey);

Parameters

NameTypeDescriptionRequiredDefaultOptions
progressKeyStringIdentifier matching the 'ProgressKey' passed to core_v2_widget.ScheduleFile()Required

ScheduledFile Overload 2

Renders a live-updating progress indicator for a script executed with core_v2_widget.ScheduleFile() and a 'ProgressKey' identifier. Progress is reported by the script with the 'context_v2_scheduledFile' API.

Velocity

#set($stringResponse = $core_v2_ui.ScheduledFile($progressKey, "%{ IncludeAllMessages = $includeAllMessagesArg, IncludeLatestMessage = $includeLatestMessageArg, IncludeProgress = $includeProgressArg, RunAsServiceUser = $runAsServiceUserArg, RunAsUserName = $runAsUserNameArg }"))

JavaScript

var stringResponse = core_v2_ui.ScheduledFile(progressKey, { IncludeAllMessages: includeAllMessagesArg, IncludeLatestMessage: includeLatestMessageArg, IncludeProgress: includeProgressArg, RunAsServiceUser: runAsServiceUserArg, RunAsUserName: runAsUserNameArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
progressKeyStringIdentifier matching the 'ProgressKey' passed to core_v2_widget.ScheduleFile()Required
optionsOptionsSet of optional parameters including:Required
IncludeAllMessagesBooleanIncludes a log of all messages reported by the script with context_v2_scheduledFile.Report()OptionalFalse
IncludeLatestMessageBooleanIncludes only the latest message reported by the script with context_v2_scheduledFile.Report()OptionalTrue
IncludeProgressBooleanIncludes a progress bar displaying completion percentage reported by the script with context_v2_scheduledFile.Report()OptionalTrue
RunAsServiceUserBooleanRetrieves the status of the script scheduled for execution by the service userOptionalFalse
RunAsUserNameStringRetrieves the status of the script scheduled for execution by a specific userOptional

Returns

String

Tag

Tag Overload 1

Render's a 'Tag' control

Velocity

#set($stringResponse = $core_v2_ui.Tag($contentId, $contentTypeId))

JavaScript

var stringResponse = core_v2_ui.Tag(contentId, contentTypeId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired

Tag Overload 2

Render's a 'Tag' control

Velocity

#set($stringResponse = $core_v2_ui.Tag($contentId, $contentTypeId, "%{ CssClass = $cssClassArg, ReadOnly = $readOnlyArg, TagTypeId = $tagTypeIdArg, UrlFormat = $urlFormatArg }"))

JavaScript

var stringResponse = core_v2_ui.Tag(contentId, contentTypeId, { CssClass: cssClassArg, ReadOnly: readOnlyArg, TagTypeId: tagTypeIdArg, UrlFormat: urlFormatArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired
optionsOptionsSet of optional parameters including:Required
CssClassStringAdditional CSS Class(es) to apply to the placeholderOptional
ReadOnlyBooleanRender the tag UI as read-onlyOptional
TagTypeIdGuidTag TypeIdOptional
UrlFormatStringURL used to link tags. {tag} will be replaced with the current tagOptional

Tag Overload 3

Render's a 'Tag' control

Velocity

#set($stringResponse = $core_v2_ui.Tag($contentUrl, $oauthClientId))

JavaScript

var stringResponse = core_v2_ui.Tag(contentUrl, oauthClientId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired

Tag Overload 4

Render's a 'Tag' control

Velocity

#set($stringResponse = $core_v2_ui.Tag($contentUrl, $oauthClientId, "%{ CssClass = $cssClassArg, ReadOnly = $readOnlyArg, TagTypeId = $tagTypeIdArg, UrlFormat = $urlFormatArg }"))

JavaScript

var stringResponse = core_v2_ui.Tag(contentUrl, oauthClientId, { CssClass: cssClassArg, ReadOnly: readOnlyArg, TagTypeId: tagTypeIdArg, UrlFormat: urlFormatArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired
optionsOptionsSet of optional parameters including:Required
CssClassStringAdditional CSS Class(es) to apply to the placeholderOptional
ReadOnlyBooleanRender the tag UI as read-onlyOptional
TagTypeIdGuidTag TypeIdOptional
UrlFormatStringURL used to link tags. {tag} will be replaced with the current tagOptional

Returns

String

UserPresence

Velocity

#set($stringResponse = $core_v2_ui.UserPresence($userId))

JavaScript

var stringResponse = core_v2_ui.UserPresence(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

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