Verint | Telligent Community
Verint | Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Verint Community 11.x
  • Verint Community
Verint Community 11.x
API Documentation UI In-Process API Service
  • User Documentation
  • Ask the Community
  • API Documentation
  • Manager Training
  • Developer Training
  • Tags
  • More
  • Cancel
  • New
  • API Documentation
  • -In-Process API Documentation
    • +In-Process API Associated Types
    • +In-Process API Event Arguments
    • -In-Process API Services
      • Abuse In-Process API Service
      • AbuseAppeals In-Process API Service
      • AbuseReports In-Process API Service
      • AbusiveContent In-Process API Service
      • Achievements In-Process API Service
      • AchievementSummary In-Process API Service
      • ActivityStories In-Process API Service
      • AdministrationUrls In-Process API Service
      • Apis In-Process API Service
      • ApplicationMerge In-Process API Service
      • Applications In-Process API Service
      • ApplicationSubscriptions In-Process API Service
      • ApplicationTypes In-Process API Service
      • Automations In-Process API Service
      • BlogConfiguration In-Process API Service
      • BlogPermissions In-Process API Service
      • BlogPosts In-Process API Service
      • BlogPostSummaries In-Process API Service
      • Blogs In-Process API Service
      • BlogUrls In-Process API Service
      • Bookmarks In-Process API Service
      • CacheService In-Process API Service
      • CalculatedMetrics In-Process API Service
      • CalculatedScores In-Process API Service
      • CalendarPermissions In-Process API Service
      • Calendars In-Process API Service
      • CalendarSubscriptions In-Process API Service
      • CalendarUrls In-Process API Service
      • Categories In-Process API Service
      • CentralizedFileStorage In-Process API Service
      • Cfs In-Process API Service
      • Challenges In-Process API Service
      • Comments In-Process API Service
      • CommentSummaries In-Process API Service
      • CommentVotes In-Process API Service
      • Containers In-Process API Service
      • ContainerTypes In-Process API Service
      • ContentConversion In-Process API Service
      • ContentFragments In-Process API Service
      • ContentFragmentWrappingFormats In-Process API Service
      • ContentPresence In-Process API Service
      • ContentRecommendations In-Process API Service
      • Contents In-Process API Service
      • ContentSubscriptions In-Process API Service
      • ContentTypes In-Process API Service
      • ContentViews In-Process API Service
      • ConversationMessages In-Process API Service
      • Conversations In-Process API Service
      • CoreUrls In-Process API Service
      • DatabaseConnections In-Process API Service
      • Date In-Process API Service
      • Documents In-Process API Service
      • EffectiveGroupMembers In-Process API Service
      • EmailDigestSubscriptions In-Process API Service
      • EmbeddableContentFragments In-Process API Service
      • Emoticons In-Process API Service
      • EventLog In-Process API Service
      • EventRegistrations In-Process API Service
      • Events In-Process API Service
      • EventSubscriptions In-Process API Service
      • Exceptions In-Process API Service
      • FactoryDefaultScriptedContentFragmentProviderFiles In-Process API Service
      • Features (v2) In-Process API Service
      • Followers In-Process API Service
      • Follows In-Process API Service
      • ForumConfiguration In-Process API Service
      • ForumPermissions In-Process API Service
      • ForumReplies In-Process API Service
      • ForumReplyVotes In-Process API Service
      • Forums In-Process API Service
      • ForumThreads In-Process API Service
      • ForumThreadVotes In-Process API Service
      • ForumUrls In-Process API Service
      • Friendships In-Process API Service
      • Galleries In-Process API Service
      • GroupAuthorQualityScore In-Process API Service
      • GroupAvatars In-Process API Service
      • GroupContactRequests In-Process API Service
      • GroupPermissions In-Process API Service
      • GroupRoleMembers In-Process API Service
      • Groups In-Process API Service
      • GroupUrls In-Process API Service
      • GroupUserMembers In-Process API Service
      • HashTags In-Process API Service
      • Html In-Process API Service
      • Http In-Process API Service
      • IdeaCategories In-Process API Service
      • IdeaPermissions In-Process API Service
      • Ideas In-Process API Service
      • IdeaStatuses In-Process API Service
      • IdeaUrls In-Process API Service
      • InfoResults In-Process API Service
      • Javascript In-Process API Service
      • JobService In-Process API Service
      • KnowledgeCollections In-Process API Service
      • KnowledgeManagementPermissions In-Process API Service
      • Language In-Process API Service
      • LayoutRegions In-Process API Service
      • LdapGroups In-Process API Service
      • LdapUsers In-Process API Service
      • Leaderboards In-Process API Service
      • LeaderboardUrls In-Process API Service
      • Leaders In-Process API Service
      • LikedItems In-Process API Service
      • Likes In-Process API Service
      • MailingLists In-Process API Service
      • Media In-Process API Service
      • MediaConfiguration In-Process API Service
      • MediaPermissions In-Process API Service
      • MediaUrls In-Process API Service
      • Mentionables In-Process API Service
      • Mentions In-Process API Service
      • Metrics In-Process API Service
      • NodePermissions In-Process API Service
      • NotificationCategories In-Process API Service
      • Notifications In-Process API Service
      • OAuthClients In-Process API Service
      • Permissions (v2) In-Process API Service
      • Permissions In-Process API Service
      • PluginManager In-Process API Service
      • PointTransactions In-Process API Service
      • Polls In-Process API Service
      • Process In-Process API Service
      • Ranks In-Process API Service
      • RatedItems In-Process API Service
      • Ratings In-Process API Service
      • Remoting In-Process API Service
      • ReviewableContent In-Process API Service
      • Roles In-Process API Service
      • RoleUsers In-Process API Service
      • RssFeedItems In-Process API Service
      • Rules In-Process API Service
      • Scores In-Process API Service
      • SearchCategories In-Process API Service
      • SearchFlags In-Process API Service
      • SearchIndexing In-Process API Service
      • SearchResults In-Process API Service
      • SendEmail In-Process API Service
      • ServicePresence In-Process API Service
      • Site In-Process API Service
      • SitePermissions In-Process API Service
      • Solr In-Process API Service
      • Statuses In-Process API Service
      • StatusMessages In-Process API Service
      • Svg In-Process API Service
      • SystemNotifications In-Process API Service
      • TaggedContents In-Process API Service
      • Tags (Knowledge Management) In-Process API Service
      • Tags In-Process API Service
      • ThemeableApplicationIds In-Process API Service
      • ThemeFiles In-Process API Service
      • ThemeFooterContentFragments In-Process API Service
      • ThemeFooters In-Process API Service
      • ThemeHeaderContentFragments In-Process API Service
      • ThemeHeaders In-Process API Service
      • ThemePageContentFragments In-Process API Service
      • ThemePages In-Process API Service
      • ThemeProperties In-Process API Service
      • Themes In-Process API Service
      • ThemeTypes In-Process API Service
      • TourTips In-Process API Service
      • UI In-Process API Service
      • UploadedFiles In-Process API Service
      • Url In-Process API Service
      • UrlRedirects In-Process API Service
      • Urls In-Process API Service
      • UserAchievements In-Process API Service
      • UserAvatars In-Process API Service
      • UserCoverPhotos In-Process API Service
      • UserFiles In-Process API Service
      • UserFolders In-Process API Service
      • UserInvitations In-Process API Service
      • UserProfileFieldGroups In-Process API Service
      • UserProfileFields In-Process API Service
      • UserRecommendations In-Process API Service
      • Users In-Process API Service
      • UserValidations In-Process API Service
      • UserVoteSummaries In-Process API Service
      • Votes In-Process API Service
      • WebhookEvents In-Process API Service
      • Webhooks In-Process API Service
      • WebPreviews In-Process API Service
      • WeightedMetrics In-Process API Service
      • WikiConfiguration In-Process API Service
      • WikiFiles In-Process API Service
      • WikiPageRevisions In-Process API Service
      • WikiPages In-Process API Service
      • WikiPermissions In-Process API Service
      • Wikis In-Process API Service
      • WikiTocs In-Process API Service
      • WikiUrls In-Process API Service
  • +Plugin API Documentation
  • +REST API Documentation
  • +Widget, Theme, and Automation APIs

UI In-Process API Service


UI helpers

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IUI>() and is defined in Telligent.Evolution.Platform.dll

Methods

string AgoDate(DateTime date, UiAgoDateOptions options = null);

Renders an automatically updating ago date

Parameters

NameTypeDescriptionRequiredDefaultOptions
dateDateTimeDateRequired
optionsUiAgoDateOptionsOptionsOptional

Return Type

string

string Bookmark(string contentUrl, Guid oauthClientId, UiBookmarkOptions options = null);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlstringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired
optionsUiBookmarkOptionsBookmark optionsOptional

Return Type

string

string Bookmark(Guid contentId, Guid contentTypeId, UiBookmarkOptions options = null);

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent type IdRequired
optionsUiBookmarkOptionsBookmark optionsOptional

Return Type

string

bool CanBeViewed(string url);

Determines whether a file can be viewed

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringTarget UrlRequired

Return Type

bool

bool CanFormatHtmlAsText(string html);

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
htmlstringHTMLRequired

Return Type

bool

string ConvertContent(Guid contentId, Guid contentTypeId, UiConvertContentOptions options = null);

Renders a link to initiate content conversion

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired
optionsUiConvertContentOptionsOptionsOptional

Return Type

string

string FormatHtmlAsText(string html);

Formats HTML as text

Parameters

NameTypeDescriptionRequiredDefaultOptions
htmlstringHTMLRequired

Return Type

string

string FormatTextAsHtml(string text, UiFormatTextAsHtmlOptions options = null);

Formats text as HTML

Parameters

NameTypeDescriptionRequiredDefaultOptions
textstringFormatted textRequired
optionsUiFormatTextAsHtmlOptionsFormat optionsOptional

Return Type

string

string ForumVotes(string type, int id, UiForumVotesOptions options = null);

Renders a vote count for a thread or reply with a link to pop up a list of voters

Parameters

NameTypeDescriptionRequiredDefaultOptions
typestringVote type: thread, reply, threadqualityRequired
idintIdRequired
optionsUiForumVotesOptionsOptionsOptional

Return Type

string

int GetCurrentPageIndex(UiCurrentPageIndexOptions options = null);

Returns the currently-requested paging index

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsUiCurrentPageIndexOptionsValue of PageIndexQueryStringKeyOptional

Return Type

int

string GetFileTypeImageUrl(string url, UiGetFileTypeImageOptions options = null);

Gets a file type image URL for a URL or filename

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringTarget UrlRequired
optionsUiGetFileTypeImageOptionsFile type image optionsOptional

Return Type

string

int GetLastPageIndex(int pageSize, int totalItems);

Gets the last page index

Parameters

NameTypeDescriptionRequiredDefaultOptions
pageSizeintPage sizeRequired
totalItemsintTotal items countRequired

Return Type

int

string GetMediaType(string url, UiGetMediaTypeOptions options = null);

Gets media type of a file

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringTarget UrlRequired
optionsUiGetMediaTypeOptionsGet media type optionsOptional

Return Type

string

string GetMimeType(string url);

Returns the Mime Type of a file

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringTarget UrlRequired

Return Type

string

string GetPagedContentPagedEvent(UiPagedContentPagedEventOptions options = null);

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsUiPagedContentPagedEventOptionsPaged content paged event optionsOptional

Return Type

string

string GetPagedContentPagingEvent(UiPagedContentPagingEventOptions options = null);

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsUiPagedContentPagingEventOptionsPaged content paging event optionsOptional

Return Type

string

string GetPagedContentWrapperElementId(UiPagedContentWrapperElementIdOptions options = null);

Container ID for a widget's Paged Content

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsUiPagedContentWrapperElementIdOptionsPaged content wrapper element Id optionsOptional

Return Type

string

string GetPageIndexQueryStringKey();

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

Return Type

string

string GetPreviewHtml(string url, UiGetPreviewHtmlOptions options = null);

Renders preview HtML for a file

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringTarget UrlRequired
optionsUiGetPreviewHtmlOptionsPreview Html optionsOptional

Return Type

string

string GetPreviewImageUrl(string url);

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringTarget UrlRequired

Return Type

string

string GetResizedImageHtml(string url, int maxWidth, int maxHeight, UiGetResizedImageHtmlOptions options = null);

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.

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringTarget UrlRequired
maxWidthintMax widthRequired
maxHeightintMax heightRequired
optionsUiGetResizedImageHtmlOptionsResized image optionsOptional

Return Type

string

string GetResizedImageUrl(string url, int maxWidth, int maxHeight, UiGetResizedImageUrlOptions options = null);

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.

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringTarget UrlRequired
maxWidthintMax widthRequired
maxHeightintMax heightRequired
optionsUiGetResizedImageUrlOptionsResized image optionsOptional

Return Type

string

string GetViewHtml(string url, UiGetViewHtmlOptions options = null);

Renders View HTML for a file

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlstringTarget UrlRequired
optionsUiGetViewHtmlOptionsView Html optionsOptional

Return Type

string

string Like(string contentUrl, Guid oauthClientId, UiLikeOptions options = null);

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.

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlstringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired
optionsUiLikeOptionsLike OptionsOptional

Return Type

string

string Like(Guid contentId, Guid contentTypeId, UiLikeOptions options = null);

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.

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent type IdRequired
optionsUiLikeOptionsLike optionsOptional

Return Type

string

string MakeCssClassName(string text);

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
textstringConverted textRequired

Return Type

string

string Merge(string original, string modified);

Produces a diff text

Parameters

NameTypeDescriptionRequiredDefaultOptions
originalstringOriginal textRequired
modifiedstringModified textRequired

Return Type

string

string Moderate(Guid contentId, Guid contentTypeId, UiModerateOptions options = null);

Render's a 'Moderation' control

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent type IdRequired
optionsUiModerateOptionsModerate optionsOptional

Return Type

string

string Page(int currentPage, int pageSize, int totalItems, UiPagerOptions options = null);

Renders a 'Pager' control

Parameters

NameTypeDescriptionRequiredDefaultOptions
currentPageintCurrent pageRequired
pageSizeintPage sizeRequired
totalItemsintTotal items countRequired
optionsUiPagerOptionsPager optionsOptional

Return Type

string

string Poll(Guid pollId, UiPollOptions options = null);

Parameters

NameTypeDescriptionRequiredDefaultOptions
pollIdGuidPoll IdRequired
optionsUiPollOptionsPoll optionsOptional

Return Type

string

string Rate(string contentUrl, Guid oauthClientId, UiRateOptions options = null);

Renders a 'Rating' control

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlstringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired
optionsUiRateOptionsRate optionsOptional

Return Type

string

string Rate(Guid contentId, Guid contentTypeId, UiRateOptions options = null);

Renders a 'Rating' control

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent type IdRequired
optionsUiRateOptionsOptionsOptional

Return Type

string

string Render(string html, UiRenderOptions options = null);

Sanitizes untrusted HTML content

Parameters

NameTypeDescriptionRequiredDefaultOptions
htmlstringSanitized HTMLRequired
optionsUiRenderOptionsType of rendered target typeOptional

Return Type

string

string ScheduledFile(string progressKey, UiScheduleFileOptions options = null);

Parameters

NameTypeDescriptionRequiredDefaultOptions
progressKeystringProgress KeyRequired
optionsUiScheduleFileOptionsOptionsOptional

Return Type

string

string Tag(string contentUrl, Guid oauthClientId, UiTagOptions options = null);

Render's a 'Tag' control

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlstringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired
optionsUiTagOptionsTag optionsOptional

Return Type

string

string Tag(Guid contentId, Guid contentTypeId, UiTagOptions options = null);

Render's a 'Tag' control

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent type IdRequired
optionsUiTagOptionsOptionsOptional

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